Changeset 56970

Timestamp:

10/18/2023 07:30:40 PM (14 months ago)

Author:

Bernhard Reiter

Message:

Blocks: During traversal, allow post callback to modify block.

Both the $pre_callback and $post_callback functions that are given as arguments to traverse_and_serialize_block(s) receive a reference to the current block as their first argument. However, while any changes that the "pre" callback makes to the block are reflected by the serialized markup, the same wasn't true for the "post" callback: Any changes that it made were only applied after the block had already been serialized.

This commit changes the behavior such that $post_callback's changes to the current block are also reflected in the serialized markup.

See #59646.
Props gziolo.
Fixes #59669.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (4 diffs)
• tests/phpunit/tests/blocks/serialize.php (modified) (1 diff)

trunk/src/wp-includes/blocks.php

@@ -1063 +1063 @@
             }
 
-            $block_content .= traverse_and_serialize_block( $inner_block, $pre_callback, $post_callback );
-
             if ( is_callable( $post_callback ) ) {
                 $next = count( $block['innerBlocks'] ) - 1 === $block_index
@@ -1070 +1068 @@
                     : $block['innerBlocks'][ $block_index + 1 ];
 
-                $block_content .= call_user_func_array(
+                $post_markup = call_user_func_array(
                     $post_callback,
                     array( &$inner_block, $block, $next )
                 );
             }
+
+            $block_content .= traverse_and_serialize_block( $inner_block, $pre_callback, $post_callback );
+            $block_content .= isset( $post_markup ) ? $post_markup : '';
+
             ++$block_index;
         }
@@ -1136 +1138 @@
         }
 
-        $result .= traverse_and_serialize_block( $block, $pre_callback, $post_callback );
-
         if ( is_callable( $post_callback ) ) {
             $next = count( $blocks ) - 1 === $index
@@ -1143 +1143 @@
                 : $blocks[ $index + 1 ];
 
-            $result .= call_user_func_array(
+            $post_markup = call_user_func_array(
                 $post_callback,
                 array( &$block, null, $next ) // At the top level, there is no parent block to pass to the callback.
             );
         }
+
+        $result .= traverse_and_serialize_block( $block, $pre_callback, $post_callback );
+        $result .= isset( $post_markup ) ? $post_markup : '';
     }
 

trunk/tests/phpunit/tests/blocks/serialize.php

@@ -75 +75 @@
     }
 
+    /**
+     * @ticket 59669
+     *
+     * @covers ::traverse_and_serialize_blocks
+     */
+    public function test_traverse_and_serialize_blocks_post_callback_modifies_current_block() {
+        $markup = "<!-- wp:outer --><!-- wp:inner {\"key\":\"value\"} -->Example.<!-- /wp:inner -->\n\nExample.\n\n<!-- wp:void /--><!-- /wp:outer -->";
+        $blocks = parse_blocks( $markup );
+
+        $actual = traverse_and_serialize_blocks( $blocks, null, array( __CLASS__, 'add_attribute_to_inner_block' ) );
+
+        $this->assertSame(
+            "<!-- wp:outer --><!-- wp:inner {\"key\":\"value\",\"myattr\":\"myvalue\"} -->Example.<!-- /wp:inner -->\n\nExample.\n\n<!-- wp:void /--><!-- /wp:outer -->",
+            $actual
+        );
+    }
+
     public static function add_attribute_to_inner_block( &$block ) {
         if ( 'core/inner' === $block['blockName'] ) {