Changeset 57157

Timestamp:

12/04/2023 08:24:33 PM (12 months ago)

Author:

Bernhard Reiter

Message:

Block Hooks: Store ignored hooked blocks metadata in anchor block.

The biggest tradeoff that was made in the implementation of Block Hooks was that they were limited to layouts (i.e. templates, template parts, and patterns) that didn't have any user modifications (see #59313 for the reason). This changeset is a preparatory step to remove this limitation, so they’ll eventually also work with user-modified layouts.

The crucial problem to solve is how to acknowledge that a user has opted to remove or persist a hooked block, so that the auto-insertion mechanism won't run again and inject an extraneous hooked block on the frontend when none is solicited.

This is achieved by storing all known blocks hooked to a given anchor block in the metadata attribute on that anchor block; specifically in a field called ignoredHookedBlocks inside of the metadata. Hooked blocks are only rendered on the frontend if they're absent from that field; OTOH, they're injected into that field (via the REST API) when first loaded in the editor.

This simple logic guarantees that once a user modifies a given layout, those changes are respected on the frontend; yet if a plugin that includes a hooked block is activated after those modifications have taken place, the hooked block will be rendered on the frontend. This new technique supplants the one previously used (i.e. rendering hooked blocks on the frontend only if a layout doesn't have any modifications) in a rather direct way.

Note that this changeset only introduces the new metadata field and relevant logic; it does not yet enable hooked block insertion into modified layouts. That will be done in a subsequent step (see #59646).

Props gziolo.
Closes #60008.

Location:

trunk

Files:

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

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.
+ * 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.
+ *
+ * @since 6.5.0
+ * @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 ) {
+    if ( ! isset( $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] ) ) {
+        $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] = array();
+    }
+
+    if ( in_array( $hooked_block_type, $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] ) ) {
+        return '';
+    }
+
+    // The following is only needed for the REST API endpoint.
+    // However, its presence does not affect the frontend.
+    $anchor_block['attrs']['metadata']['ignoredHookedBlocks'][] = $hooked_block_type;
+
+    return get_comment_delimited_block_content( $hooked_block_type, array(), '' );
+}
+
+/**
  * Returns a function that injects the theme attribute into, and hooked blocks before, a given block.
  *
@@ -814 +846 @@
             $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_comment_delimited_block_content( $hooked_block_type, array(), '' );
+                $markup .= get_hooked_block_markup( $parent_block, $hooked_block_type );
             }
         }
@@ -827 +859 @@
         $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_comment_delimited_block_content( $hooked_block_type, array(), '' );
+            $markup .= get_hooked_block_markup( $block, $hooked_block_type );
         }
 
@@ -875 +907 @@
         $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_comment_delimited_block_content( $hooked_block_type, array(), '' );
+            $markup .= get_hooked_block_markup( $block, $hooked_block_type );
         }
 
@@ -889 +921 @@
             $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_comment_delimited_block_content( $hooked_block_type, array(), '' );
+                $markup .= get_hooked_block_markup( $parent_block, $hooked_block_type );
             }
         }

trunk/tests/phpunit/tests/blocks/getHookedBlocks.php

@@ -150 +150 @@
         );
         $this->assertStringContainsString(
-            '<!-- wp:post-content {"layout":{"type":"constrained"}} /-->'
+            '<!-- wp:post-content {"layout":{"type":"constrained"},"metadata":{"ignoredHookedBlocks":["tests/hooked-after"]}} /-->'
             . '<!-- wp:tests/hooked-after /-->',
             $template->content
@@ -177 +177 @@
         $this->assertStringContainsString(
             '<!-- wp:tests/hooked-before /-->'
-            . '<!-- wp:navigation {"layout":{"type":"flex","setCascadingProperties":true,"justifyContent":"right"}} /-->',
+            . '<!-- wp:navigation {"layout":{"type":"flex","setCascadingProperties":true,"justifyContent":"right"},"metadata":{"ignoredHookedBlocks":["tests/hooked-before"]}} /-->',
             $template->content
         );
@@ -216 +216 @@
         );
         $this->assertStringContainsString(
-            '<!-- wp:comments -->'
+            '<!-- wp:comments {"metadata":{"ignoredHookedBlocks":["tests/hooked-first-child"]}} -->'
             . '<div class="wp-block-comments">'
             . '<!-- wp:tests/hooked-first-child /-->',

trunk/tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php

@@ -382 +382 @@
         $pattern_three['content'] .= '<!-- wp:tests/my-block /-->';
 
-        $expected = array(
-            $pattern_one,
-            $pattern_two,
-            $pattern_three,
-        );
-
         $registered = $this->registry->get_all_registered();
-        $this->assertSame( $expected, $registered );
+        $this->assertCount( 3, $registered );
+        $this->assertStringEndsWith( '<!-- wp:tests/my-block /-->', $registered[1]['content'] );
+        $this->assertStringContainsString( '"metadata":{"ignoredHookedBlocks":["tests/my-block"]}', $registered[1]['content'] );
+        $this->assertStringEndsWith( '<!-- wp:tests/my-block /-->', $registered[2]['content'] );
+        $this->assertStringContainsString( '"metadata":{"ignoredHookedBlocks":["tests/my-block"]}', $registered[2]['content'] );
     }
 
@@ -445 +443 @@
         $this->registry->register( 'test/two', $pattern_two );
 
-        $pattern_one['name']    = 'test/one';
-        $pattern_one['content'] = '<!-- wp:tests/my-block /-->' . $pattern_one['content'];
-
         $pattern = $this->registry->get_registered( 'test/one' );
-        $this->assertSame( $pattern_one, $pattern );
+        $this->assertStringStartsWith( '<!-- wp:tests/my-block /-->', $pattern['content'] );
+        $this->assertStringContainsString( '"metadata":{"ignoredHookedBlocks":["tests/my-block"]}', $pattern['content'] );
     }