Changeset 57660

Timestamp:

02/20/2024 09:25:09 AM (8 months ago)

Author:

swissspidy

Message:

Block Hooks: Introduce a new hooked_block filter.

This is a counterpart to the dynamic hooked_block_{$block_type} filter introduced in [57354],
which makes it easier to modify all hooked blocks prior to insertion.

Also adds the hooked block type as an additional argument to both filters for consistency.

Props bernhard-reiter, swissspidy.
Fixes #60574.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (3 diffs)
• tests/phpunit/tests/blocks/insertHookedBlocks.php (modified) (3 diffs)

trunk/src/wp-includes/blocks.php

@@ -896 +896 @@
          * Filters the parsed block array for a given hooked block.
          *
+         * @since 6.5.0
+         *
+         * @param array                           $parsed_hooked_block The parsed block array for the given hooked block type.
+         * @param string                          $hooked_block_type   The hooked block type name.
+         * @param string                          $relative_position   The relative position of the hooked block.
+         * @param array                           $parsed_anchor_block The anchor block, in parsed block array format.
+         * @param WP_Block_Template|WP_Post|array $context             The block template, template part, `wp_navigation` post type,
+         *                                                             or pattern that the anchor block belongs to.
+         */
+        $parsed_hooked_block = apply_filters( 'hooked_block', $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block, $context );
+
+        /**
+         * Filters the parsed block array for a given hooked block.
+         *
          * The dynamic portion of the hook name, `$hooked_block_type`, refers to the block type name of the specific hooked block.
          *
@@ -901 +915 @@
          *
          * @param array                           $parsed_hooked_block The parsed block array for the given hooked block type.
+         * @param string                          $hooked_block_type   The hooked block type name.
          * @param string                          $relative_position   The relative position of the hooked block.
          * @param array                           $parsed_anchor_block The anchor block, in parsed block array format.
@@ -906 +921 @@
          *                                                             or pattern that the anchor block belongs to.
          */
-        $parsed_hooked_block = apply_filters( "hooked_block_{$hooked_block_type}", $parsed_hooked_block, $relative_position, $parsed_anchor_block, $context );
-
-        // It's possible that the `hooked_block_{$hooked_block_type}` filter returned a block of a different type,
-        // so we explicitly look for the original `$hooked_block_type` in the `ignoredHookedBlocks` metadata.
+        $parsed_hooked_block = apply_filters( "hooked_block_{$hooked_block_type}", $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block, $context );
+
+        // It's possible that the filter returned a block of a different type, so we explicitly
+        // look for the original `$hooked_block_type` in the `ignoredHookedBlocks` metadata.
         if (
             ! isset( $parsed_anchor_block['attrs']['metadata']['ignoredHookedBlocks'] ) ||

trunk/tests/phpunit/tests/blocks/insertHookedBlocks.php

@@ -111 +111 @@
         );
 
-        $filter = function ( $parsed_hooked_block, $relative_position, $parsed_anchor_block ) {
+        $filter = function ( $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block ) {
             // Is the hooked block adjacent to the anchor block?
             if ( 'before' !== $relative_position && 'after' !== $relative_position ) {
@@ -125 +125 @@
             return $parsed_hooked_block;
         };
-        add_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter, 10, 3 );
+        add_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter, 10, 4 );
         $actual = insert_hooked_blocks( $anchor_block, 'after', self::HOOKED_BLOCKS, array() );
-        remove_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter, 10, 3 );
+        remove_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter );
 
         $this->assertSame(
@@ -173 +173 @@
         add_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter, 10, 3 );
         $actual = insert_hooked_blocks( $anchor_block, 'after', self::HOOKED_BLOCKS, array() );
-        remove_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter, 10, 3 );
+        remove_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter );
 
         $this->assertSame(