Changeset 58186

Timestamp:

05/23/2024 06:33:11 PM (2 months ago)

Author:

Bernhard Reiter

Message:

Block Hooks API: Insert metadata at the same time as hooked blocks.

The Block Hooks UI relies on the ignoredHookedBlocks metadata when determining whether to show the toggle in the Site Editor. The problem is that for uncustomized templates we don't add this metadata.

Currently the visitor functions have a default callback of insert_hooked_blocks and we only add the metadata when we're writing to the database via an available filter in the template controller.

This changeset creates a new callback which both inserts the hooked blocks and adds the ignoredHookedBlocks metadata to the anchor block, and uses this new callback explicitly in the visitor functions that are run upon reading from the database.

We continue to set the ignoredHookedBlocks metadata when writing to the database, i.e. this operation happens twice. Although not ideal, this is necessary to cover the following scenarios:

• When the user adds an anchor block within the editor, we still need to add the ignoredHookedBlocks meta to it to prevent hooked blocks hooking on to it unexpectedly on the frontend. This is required to keep parity between the frontend and editor.
• When a user writes template data to the database directly through the API (instead of the editor), we need to again ensure we're not inserting hooked blocks unexpectedly.

It is worth noting that with this change, the first hooked block to insert relative to its anchor block will be accepted. Any additional blocks of the same type (e.g. a second core/loginout block) trying to hook onto the same anchor block will be ignored, irrespective of the position.

Props tomjcafferkey, bernhard-reiter, gziolo.
Fixes #59574.

Location:

trunk

Files:

• src/wp-includes/block-template-utils.php (modified) (2 diffs)
• src/wp-includes/blocks.php (modified) (3 diffs)
• src/wp-includes/class-wp-block-patterns-registry.php (modified) (1 diff)
• tests/phpunit/tests/blocks/getHookedBlocks.php (modified) (3 diffs)
• tests/phpunit/tests/blocks/insertHookedBlocksAndSetIgnoredHookedBlocksMetadata.php (added)

trunk/src/wp-includes/block-template-utils.php

@@ -599 +599 @@
     $hooked_blocks        = get_hooked_blocks();
     if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {
-        $before_block_visitor = make_before_block_visitor( $hooked_blocks, $template );
-        $after_block_visitor  = make_after_block_visitor( $hooked_blocks, $template );
+        $before_block_visitor = make_before_block_visitor( $hooked_blocks, $template );
+        $after_block_visitor  = make_after_block_visitor( $hooked_blocks, $template );
     }
     $blocks            = parse_blocks( $template->content );
@@ -985 +985 @@
     $hooked_blocks = get_hooked_blocks();
     if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {
-        $before_block_visitor = make_before_block_visitor( $hooked_blocks, $template );
-        $after_block_visitor  = make_after_block_visitor( $hooked_blocks, $template );
+        $before_block_visitor = make_before_block_visitor( $hooked_blocks, $template );
+        $after_block_visitor  = make_after_block_visitor( $hooked_blocks, $template );
         $blocks               = parse_blocks( $template->content );
         $template->content    = traverse_and_serialize_blocks( $blocks, $before_block_visitor, $after_block_visitor );

trunk/src/wp-includes/blocks.php

@@ -859 +859 @@
  * @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.
+ * @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
  */
@@ -950 +950 @@
  * @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 An empty string.
+ * @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 mpty string.
  */
 function set_ignored_hooked_blocks_metadata( &$parsed_anchor_block, $relative_position, $hooked_blocks, $context ) {
@@ -1001 +1001 @@
     // Markup for the hooked blocks has already been created (in `insert_hooked_blocks`).
     return '';
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }
 

trunk/src/wp-includes/class-wp-block-patterns-registry.php

@@ -175 +175 @@
         $after_block_visitor  = null;
         if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {
-            $before_block_visitor = make_before_block_visitor( $hooked_blocks, $pattern );
-            $after_block_visitor  = make_after_block_visitor( $hooked_blocks, $pattern );
+            $before_block_visitor = make_before_block_visitor( $hooked_blocks, $pattern );
+            $after_block_visitor  = make_after_block_visitor( $hooked_blocks, $pattern );
         }
         $blocks  = parse_blocks( $content );

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

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