Changeset 12998

Timestamp:

07/14/2021 08:52:00 AM (4 years ago)

Author:

imath

Message:

Introduce a new BP_Component property for block globals

This new property will help us to manage Widget Block occurrences globals and use a single filter on 'widget_block_dynamic_classname' to make sure Widget Blocks will include Legacy Widget classnames and inherit their styles.

This commit also makes sure WordPress is >= 5.0 before using the has_block function.

See #8515
Fixes #8516

Location:

trunk

Files:

• src/bp-core/bp-core-blocks.php (modified) (1 diff)
• src/bp-core/bp-core-template.php (modified) (1 diff)
• src/bp-core/classes/class-bp-component.php (modified) (5 diffs)
• tests/phpunit/assets/class-bptest-component.php (added)
• tests/phpunit/testcases/core/class-bp-component.php (modified) (2 diffs)

trunk/src/bp-core/bp-core-blocks.php

@@ -163 +163 @@
     return new BP_Block( $args );
 }
+
+/**
+ * Gets a Widget Block list of classnames.
+ *
+ * @since 9.0.0
+ *
+ * @param string $block_name The Block name.
+ * @return array The list of widget classnames for the Block.
+ */
+function bp_blocks_get_widget_block_classnames( $block_name = '' ) {
+    $components         = bp_core_get_active_components( array(), 'objects' );
+    $components['core'] = buddypress()->core;
+    $classnames         = array();
+
+    foreach ( $components as $component ) {
+        if ( isset( $component->block_globals[ $block_name ] ) ) {
+            $block_props = $component->block_globals[ $block_name ]->props;
+
+            if ( isset( $block_props['widget_classnames'] ) && $block_props['widget_classnames'] ) {
+                $classnames = (array) $block_props['widget_classnames'];
+                break;
+            }
+        }
+    }
+
+    return $classnames;
+}
+
+/**
+ * Make sure the BP Widget Block classnames are included into Widget Blocks.
+ *
+ * @since 9.0.0
+ *
+ * @param string $classname The classname to be used in the block widget's container HTML.
+ * @param string $block_name The name of the block.
+ * @return string The classname to be used in the block widget's container HTML.
+ */
+function bp_widget_block_dynamic_classname( $classname, $block_name ) {
+    $bp_classnames = bp_blocks_get_widget_block_classnames( $block_name );
+
+    if ( $bp_classnames ) {
+        $bp_classnames = array_map( 'sanitize_html_class', $bp_classnames );
+        $classname    .= ' ' . implode( ' ', $bp_classnames );
+    }
+
+    return $classname;
+}
+add_filter( 'widget_block_dynamic_classname', 'bp_widget_block_dynamic_classname', 10, 2 );

trunk/src/bp-core/bp-core-template.php

@@ -3873 +3873 @@
     );
 
-    if ( $block_name ) {
+    if ( $block_name && bp_is_running_wp( '5.0.0', '>=' ) ) {
         $widget_blocks = get_option( 'widget_block', array() );
         $sidebars      = wp_get_sidebars_widgets();

trunk/src/bp-core/classes/class-bp-component.php

@@ -140 +140 @@
      */
     public $search_query_arg = 's';
+
+    /**
+     * An array of globalized data for BP Blocks.
+     *
+     * @since 9.0.0
+     *
+     * @var array
+     */
+    public $block_globals = array();
 
     /** Methods ***************************************************************/
@@ -206 +215 @@
      *
      * @since 1.5.0
-     *
+     * @since 9.0.0 Adds the `$block_globals` argument to the `$args` parameter.
      *
      * @param array $args {
@@ -222 +231 @@
      *     @type array    $global_tables         Optional. An array of database table names.
      *     @type array    $meta_tables           Optional. An array of metadata table names.
+     *     @type array    $block_globals         Optional. An array of globalized data for BP Blocks.
      * }
      */
@@ -242 +252 @@
             'global_tables'         => '',
             'meta_tables'           => '',
+            'block_globals'         => array(),
         ) );
 
@@ -306 +317 @@
         if ( ! empty( $r['meta_tables'] ) ) {
             $this->register_meta_tables( $r['meta_tables'] );
+        }
+
+        /**
+         * Filters the $blocks global value.
+         *
+         * @since 9.0.0
+         *
+         * @param array $blocks a list of global properties for blocks keyed
+         *                      by their corresponding block name.
+         */
+        $block_globals = apply_filters( 'bp_' . $this->id . '_block_globals', $r['block_globals'] );
+        if ( is_array( $block_globals ) && array_filter( $block_globals ) ) {
+            foreach ( $block_globals as $block_name => $block_props ) {
+                $this->block_globals[ $block_name ] = new stdClass();
+
+                // Initialize an `items` property for Widget Block occurrences.
+                $this->block_globals[ $block_name ]->items = array();
+
+                // Set the global properties for the Block.
+                $this->block_globals[ $block_name ]->props = (array) $block_props;
+            }
         }
 

trunk/tests/phpunit/testcases/core/class-bp-component.php

@@ -2 +2 @@
 
 include_once BP_TESTS_DIR . '/assets/bp-rest-api-controllers.php';
+include_once BP_TESTS_DIR . '/assets/class-bptest-component.php';
 
 /**
@@ -69 +70 @@
         ) );
     }
+
+    /**
+     * @group bp_blocks
+     */
+    public function test_component_block_globals() {
+        $expected = array(
+            'dynamic_widget_classname' => 'widget_example_classname',
+        );
+
+        $example = new BPTest_Component(
+            array(
+                'globals' => array(
+                    'block_globals' => array(
+                        'bp/example-block' => $expected,
+                    )
+                ),
+            )
+        );
+
+        do_action( 'bp_setup_globals' );
+
+        $this->assertEquals( $expected, $example->block_globals['bp/example-block']->props );
+    }
 }