Changeset 57354

Timestamp:

01/25/2024 01:46:49 PM (6 months ago)

Author:

Bernhard Reiter

Message:

Block Hooks: Introduce a new hooked_block_{$block_type} filter.

Add a new hooked_block_{$block_type} filter that allows modifying a hooked block (in parsed block format) prior to insertion, while providing read access to its anchor block (in the same format).

This allows block authors to e.g. set a hooked block's attributes, or its inner blocks; the filter can peruse information about the anchor block when doing so. As such, this filter provides a solution to both #59572 and #60126.

The new filter is designed to strike a good balance and separation of concerns with regard to the existing ​`hooked_block_types` filter, which allows addition or removal of a block to the list of hooked blocks for a given anchor block -- all of which are identified only by their block types. This new filter, on the other hand, only applies to one hooked block at a time, and allows modifying the entire (parsed) hooked block; it also gives (read) access to the parsed anchor block.

Props gziolo, tomjcafferkey, andrewserong, isabel_brison, timbroddin, yansern.
Fixes #59572, #60126.

Location:

trunk

Files:

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

trunk/src/wp-includes/blocks.php

@@ -759 +759 @@
 
 /**
- * Conditionally returns the markup for a given hooked block type.
- *
- * Accepts two arguments: A reference to an anchor block, and the name of a hooked block type.
+ * Conditionally returns the markup for a given hooked block.
+ *
+ * Accepts t.
  * If the anchor block has already been processed, and the given hooked block type is in the list
  * of ignored hooked blocks, an empty string is returned.
  *
+
+
+
  * This function is meant for internal use only.
  *
@@ -770 +773 @@
  * @access private
  *
- * @param array   $anchor_block      The anchor block. Passed by reference.
- * @param string  $hooked_block_type The name of the hooked block type.
- * @return string The markup for the given hooked block type, or an empty string if the block is ignored.
- */
-function get_hooked_block_markup( &$anchor_block, $hooked_block_type ) {
+ * @param array  $hooked_block      The hooked block, represented as a parsed block array.
+ * @param string $hooked_block_type The type of the hooked block. This could be different from
+ *                                  $hooked_block['blockName'], as a filter might've modified the latter.
+ * @param array  $anchor_block      The anchor block, represented as a parsed block array.
+ *                                  Passed by reference.
+ * @return string The markup for the given hooked block, or an empty string if the block is ignored.
+ */
+function get_hooked_block_markup( $hooked_block, $hooked_block_type, &$anchor_block ) {
     if ( ! isset( $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] ) ) {
         $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] = array();
@@ -787 +793 @@
     $anchor_block['attrs']['metadata']['ignoredHookedBlocks'][] = $hooked_block_type;
 
-    return get_comment_delimited_block_content( $hooked_block_type, array(), '' );
+    return serialize_block( $hooked_block );
+}
+
+/**
+ * Returns the markup for blocks hooked to the given anchor block in a specific relative position.
+ *
+ * @since 6.5.0
+ * @access private
+ *
+ * @param array                   $parsed_anchor_block The anchor block, in parsed block array format.
+ * @param string                  $relative_position   The relative position of the hooked blocks.
+ *                                                     Can be one of 'before', 'after', 'first_child', or 'last_child'.
+ * @param array                   $hooked_blocks       An array of hooked block types, grouped by anchor block and relative position.
+ * @param WP_Block_Template|array $context             The block template, template part, or pattern that the anchor block belongs to.
+ * @return string
+ */
+function insert_hooked_blocks( &$parsed_anchor_block, $relative_position, $hooked_blocks, $context ) {
+    $anchor_block_type  = $parsed_anchor_block['blockName'];
+    $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] )
+        ? $hooked_blocks[ $anchor_block_type ][ $relative_position ]
+        : array();
+
+    /**
+     * Filters the list of hooked block types for a given anchor block type and relative position.
+     *
+     * @since 6.4.0
+     *
+     * @param string[]                $hooked_block_types The list of hooked block types.
+     * @param string                  $relative_position  The relative position of the hooked blocks.
+     *                                                    Can be one of 'before', 'after', 'first_child', or 'last_child'.
+     * @param string                  $anchor_block_type  The anchor block type.
+     * @param WP_Block_Template|array $context            The block template, template part, or pattern that the anchor block belongs to.
+     */
+    $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context );
+
+    $markup = '';
+    foreach ( $hooked_block_types as $hooked_block_type ) {
+        $parsed_hooked_block = array(
+            'blockName'    => $hooked_block_type,
+            'attrs'        => array(),
+            'innerBlocks'  => array(),
+            'innerContent' => array(),
+        );
+
+        /**
+         * 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                  $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|array $context             The block template, template part, 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 need to pass the original $hooked_block_type as well.
+        $markup .= get_hooked_block_markup( $parsed_hooked_block, $hooked_block_type, $parsed_anchor_block );
+    }
+
+    return $markup;
 }
 
@@ -827 +894 @@
         if ( $parent_block && ! $prev ) {
             // Candidate for first-child insertion.
-            $relative_position  = 'first_child';
-            $anchor_block_type  = $parent_block['blockName'];
-            $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] )
-                ? $hooked_blocks[ $anchor_block_type ][ $relative_position ]
-                : array();
-
-            /**
-             * Filters the list of hooked block types for a given anchor block type and relative position.
-             *
-             * @since 6.4.0
-             *
-             * @param string[]                $hooked_block_types  The list of hooked block types.
-             * @param string                  $relative_position   The relative position of the hooked blocks.
-             *                                                     Can be one of 'before', 'after', 'first_child', or 'last_child'.
-             * @param string                  $anchor_block_type   The anchor block type.
-             * @param WP_Block_Template|array $context             The block template, template part, or pattern that the anchor block belongs to.
-             */
-            $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context );
-            foreach ( $hooked_block_types as $hooked_block_type ) {
-                $markup .= get_hooked_block_markup( $parent_block, $hooked_block_type );
-            }
-        }
-
-        $relative_position  = 'before';
-        $anchor_block_type  = $block['blockName'];
-        $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] )
-            ? $hooked_blocks[ $anchor_block_type ][ $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 );
-        foreach ( $hooked_block_types as $hooked_block_type ) {
-            $markup .= get_hooked_block_markup( $block, $hooked_block_type );
-        }
+            $markup .= insert_hooked_blocks( $parent_block, 'first_child', $hooked_blocks, $context );
+        }
+
+        $markup .= insert_hooked_blocks( $block, 'before', $hooked_blocks, $context );
 
         return $markup;
@@ -896 +933 @@
      */
     return function ( &$block, &$parent_block = null, $next = null ) use ( $hooked_blocks, $context ) {
-        $markup = '';
-
-        $relative_position  = 'after';
-        $anchor_block_type  = $block['blockName'];
-        $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] )
-                ? $hooked_blocks[ $anchor_block_type ][ $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 );
-        foreach ( $hooked_block_types as $hooked_block_type ) {
-            $markup .= get_hooked_block_markup( $block, $hooked_block_type );
-        }
+        $markup = insert_hooked_blocks( $block, 'after', $hooked_blocks, $context );
 
         if ( $parent_block && ! $next ) {
             // Candidate for last-child insertion.
-            $relative_position  = 'last_child';
-            $anchor_block_type  = $parent_block['blockName'];
-            $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] )
-                ? $hooked_blocks[ $anchor_block_type ][ $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 );
-            foreach ( $hooked_block_types as $hooked_block_type ) {
-                $markup .= get_hooked_block_markup( $parent_block, $hooked_block_type );
-            }
+            $markup .= insert_hooked_blocks( $parent_block, 'last_child', $hooked_blocks, $context );
         }
 

trunk/tests/phpunit/tests/blocks/getHookedBlockMarkup.php

@@ -12 +12 @@
  */
 class Tests_Blocks_GetHookedBlockMarkup extends WP_UnitTestCase {
+
+
+
+
+
+
+
     /**
+
      * @ticket 60008
+
      *
      * @covers ::get_hooked_block_markup
@@ -22 +31 @@
         );
 
-        $actual = get_hooked_block_markup( $anchor_block, 'tests/hooked-block' );
-        $this->assertSame( array( 'tests/hooked-block' ), $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] );
-        $this->assertSame( '<!-- wp:tests/hooked-block /-->', $actual );
+        $actual = get_hooked_block_markup( self::HOOKED_BLOCK, self::HOOKED_BLOCK_TYPE, $anchor_block );
+        $this->assertSame(
+            array( self::HOOKED_BLOCK_TYPE ),
+            $anchor_block['attrs']['metadata']['ignoredHookedBlocks'],
+            "Hooked block type wasn't added to ignoredHookedBlocks metadata."
+        );
+        $this->assertSame(
+            '<!-- wp:' . self::HOOKED_BLOCK['blockName'] . ' /-->',
+            $actual,
+            "Markup for hooked block wasn't generated correctly."
+        );
     }
 
     /**
+
      * @ticket 60008
+
      *
      * @covers ::get_hooked_block_markup
@@ -37 +56 @@
             'attrs'     => array(
                 'metadata' => array(
-                    'ignoredHookedBlocks' => array( 'tests/hooked-block' ),
+                    'ignoredHookedBlocks' => array(  ),
                 ),
             ),
         );
 
-        $actual = get_hooked_block_markup( $anchor_block, 'tests/hooked-block' );
-        $this->assertSame( array( 'tests/hooked-block' ), $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] );
-        $this->assertSame( '', $actual );
+        $actual = get_hooked_block_markup( self::HOOKED_BLOCK, self::HOOKED_BLOCK_TYPE, $anchor_block );
+        $this->assertSame(
+            array( self::HOOKED_BLOCK_TYPE ),
+            $anchor_block['attrs']['metadata']['ignoredHookedBlocks'],
+            "ignoredHookedBlocks metadata shouldn't have been modified."
+        );
+        $this->assertSame(
+            '',
+            $actual,
+            "No markup should've been generated for ignored hooked block."
+        );
     }
 
     /**
+
      * @ticket 60008
+
      *
      * @covers ::get_hooked_block_markup
      */
     public function test_get_hooked_block_markup_adds_to_ignored_hooked_blocks() {
+
+
+
+
+
+
+
         $anchor_block = array(
             'blockName' => 'tests/anchor-block',
             'attrs'     => array(
                 'metadata' => array(
-                    'ignoredHookedBlocks' => array( 'tests/hooked-block' ),
+                    'ignoredHookedBlocks' => array(  ),
                 ),
             ),
         );
 
-        $actual = get_hooked_block_markup( $anchor_block, 'tests/other-hooked-block' );
-        $this->assertSame( array( 'tests/hooked-block', 'tests/other-hooked-block' ), $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] );
-        $this->assertSame( '<!-- wp:tests/other-hooked-block /-->', $actual );
+        $actual = get_hooked_block_markup( $other_hooked_block, $other_hooked_block_type, $anchor_block );
+        $this->assertSame(
+            array( self::HOOKED_BLOCK_TYPE, $other_hooked_block_type ),
+            $anchor_block['attrs']['metadata']['ignoredHookedBlocks'],
+            "Newly hooked block should've been added to ignoredHookedBlocks metadata while retaining previously ignored one."
+        );
+        $this->assertSame(
+            '<!-- wp:' . $other_hooked_block_type . ' /-->',
+            $actual,
+            "Markup for newly hooked block should've been generated."
+        );
     }
 }