Changeset 56704

Timestamp:

09/26/2023 11:47:18 AM (18 months ago)

Author:

Bernhard Reiter

Message:

Blocks: Have get_hooked_blocks() return blocks grouped by position.

All existing calls of get_hooked_blocks() in non-test code are currently wrapped in an extra array_keys() call. This changeset absorbs that logic into the function and changes the structure of the return value accordingly.

Furthermore, this allows us to remove the extra $relative_position argument (introduced in [56673]) from the function again, as the same data can now be simply fetched via array access.

Props gziolo, spacedmonkey, mukesh27.
See #59383.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (6 diffs)
• tests/phpunit/tests/blocks/blockHooks.php (modified) (5 diffs)

trunk/src/wp-includes/blocks.php

@@ -724 +724 @@
 
 /**
- * Retrieves block types (and positions) hooked into the given block.
+ * Retrieves block types hooked into the given block, grouped by their relative position.
  *
  * @since 6.4.0
  *
- * @param string $name              Block type name including namespace.
- * @param string $relative_position Optional. Relative position of the hooked block. Default empty string.
- * @return array Associative array of `$block_type_name => $position` pairs.
- */
-function get_hooked_blocks( $name, $relative_position = '' ) {
+ * @param string $name Block type name including namespace.
+ * @return array[] Array of block types grouped by their relative position.
+ */
+function get_hooked_blocks( $name ) {
     $block_types   = WP_Block_Type_Registry::get_instance()->get_all_registered();
     $hooked_blocks = array();
@@ -739 +738 @@
             continue;
         }
-        foreach ( $block_type->block_hooks as $anchor_block_type => $position ) {
+        foreach ( $block_type->block_hooks as $anchor_block_type => $relative_position ) {
             if ( $anchor_block_type !== $name ) {
                 continue;
             }
-            if ( $relative_position && $relative_position !== $position ) {
-                continue;
-            }
-            $hooked_blocks[ $block_type->name ] = $position;
+            if ( ! isset( $hooked_blocks[ $relative_position ] ) ) {
+                $hooked_blocks[ $relative_position ] = array();
+            }
+            $hooked_blocks[ $relative_position ][] = $block_type->name;
         }
     }
@@ -788 +787 @@
             $relative_position  = 'first_child';
             $anchor_block_type  = $parent_block['blockName'];
-            $hooked_block_types = array_keys( get_hooked_blocks( $anchor_block_type, $relative_position ) );
+            $hooked_block_types = get_hooked_blocks( $anchor_block_type );
+            $hooked_block_types = isset( $hooked_block_types[ $relative_position ] )
+                ? $hooked_block_types[ $relative_position ]
+                : array();
+
             /**
              * Filters the list of hooked block types for a given anchor block type and relative position.
@@ -808 +811 @@
         $relative_position  = 'before';
         $anchor_block_type  = $block['blockName'];
-        $hooked_block_types = array_keys( get_hooked_blocks( $anchor_block_type, $relative_position ) );
+        $hooked_block_types = get_hooked_blocks( $anchor_block_type );
+        $hooked_block_types = isset( $hooked_block_types[ $relative_position ] )
+            ? $hooked_block_types[ $relative_position ]
+            : array();
+
         /** This filter is documented in wp-includes/blocks.php */
         $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context );
@@ -850 +857 @@
         $relative_position  = 'after';
         $anchor_block_type  = $block['blockName'];
-        $hooked_block_types = array_keys( get_hooked_blocks( $anchor_block_type, $relative_position ) );
+        $hooked_block_types = get_hooked_blocks( $anchor_block_type );
+        $hooked_block_types = isset( $hooked_block_types[ $relative_position ] )
+            ? $hooked_block_types[ $relative_position ]
+            : array();
+
         /** This filter is documented in wp-includes/blocks.php */
         $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context );
@@ -861 +872 @@
             $relative_position  = 'last_child';
             $anchor_block_type  = $parent_block['blockName'];
-            $hooked_block_types = array_keys( get_hooked_blocks( $anchor_block_type, $relative_position ) );
+            $hooked_block_types = get_hooked_blocks( $anchor_block_type );
+            $hooked_block_types = isset( $hooked_block_types[ $relative_position ] )
+                ? $hooked_block_types[ $relative_position ]
+                : array();
+
             /** This filter is documented in wp-includes/blocks.php */
             $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context );

trunk/tests/phpunit/tests/blocks/blockHooks.php

@@ -71 +71 @@
         $this->assertSame(
             array(
-                'tests/injected-one' => 'before',
-                'tests/injected-two' => 'before',
+                'before' => array(
+                    'tests/injected-one',
+                    'tests/injected-two',
+                ),
             ),
             get_hooked_blocks( 'tests/hooked-at-before' ),
@@ -79 +81 @@
         $this->assertSame(
             array(
-                'tests/injected-one' => 'after',
-                'tests/injected-two' => 'after',
+                'after' => array(
+                    'tests/injected-one',
+                    'tests/injected-two',
+                ),
             ),
             get_hooked_blocks( 'tests/hooked-at-after' ),
@@ -87 +91 @@
         $this->assertSame(
             array(
-                'tests/injected-two' => 'first_child',
+                'first_child' => array(
+                    'tests/injected-two',
+                ),
             ),
             get_hooked_blocks( 'tests/hooked-at-first-child' ),
@@ -94 +100 @@
         $this->assertSame(
             array(
-                'tests/injected-two' => 'last_child',
+                'last_child' => array(
+                    'tests/injected-two',
+                ),
             ),
             get_hooked_blocks( 'tests/hooked-at-last-child' ),
@@ -101 +109 @@
         $this->assertSame(
             array(
-                'tests/injected-one' => 'before',
-                'tests/injected-two' => 'after',
+                'before' => array(
+                    'tests/injected-one',
+                ),
+                'after'  => array(
+                    'tests/injected-two',
+                ),
             ),
             get_hooked_blocks( 'tests/hooked-at-before-and-after' ),
             'block hooked before one block and after another'
         );
-        $this->assertSame(
-            array(
-                'tests/injected-one' => 'before',
-            ),
-            get_hooked_blocks( 'tests/hooked-at-before-and-after', 'before' ),
-            'block hooked before one block and after another, filtered for before'
-        );
     }
 }