Changeset 59124

Timestamp:

09/30/2024 12:21:31 PM (16 months ago)

Author:

Bernhard Reiter

Message:

Block Hooks: Respect "multiple": false in hooked blocks.

If a prospective hooked block has its multiple block-supports field set to false (thus allowing only one instance of the block to be present), ensure that:

1. Only one instance of the block will be inserted if it's not yet present in the current context.
2. The block will not be inserted at all if an instance of it is already present in the current context.

As always in Block Hooks parlance, "context" denotes the containing template, template part, pattern, or navigation post that a hooked block is supposed to be inserted into.

The markup of a webpage that uses a Block Theme typically comprises a number of such contexts -- one template and any number of template parts, patterns, and navigation posts. Note that the limitation imposed by this changeset only applies on a per-context basis, so it's still possible that the resulting page contains more than one instance of a hooked block with "multiple": false set, as each context could contribute up to one such instance.

Props bernhard-reiter, jonsurrell, gziolo.
Fixes #61902.

Location:

trunk

Files:

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

trunk/src/wp-includes/blocks.php

@@ -1057 +1057 @@
     }
 
-    $blocks = parse_blocks( $content );
-
-    return traverse_and_serialize_blocks( $blocks, $before_block_visitor, $after_block_visitor );
+    $block_allows_multiple_instances = array();
+    /*
+     * Remove hooked blocks from `$hooked_block_types` if they have `multiple` set to false and
+     * are already present in `$content`.
+     */
+    foreach ( $hooked_blocks as $anchor_block_type => $relative_positions ) {
+        foreach ( $relative_positions as $relative_position => $hooked_block_types ) {
+            foreach ( $hooked_block_types as $index => $hooked_block_type ) {
+                $hooked_block_type_definition =
+                    WP_Block_Type_Registry::get_instance()->get_registered( $hooked_block_type );
+
+                $block_allows_multiple_instances[ $hooked_block_type ] =
+                    block_has_support( $hooked_block_type_definition, 'multiple', true );
+
+                if (
+                    ! $block_allows_multiple_instances[ $hooked_block_type ] &&
+                    has_block( $hooked_block_type, $content )
+                ) {
+                    unset( $hooked_blocks[ $anchor_block_type ][ $relative_position ][ $index ] );
+                }
+            }
+            if ( empty( $hooked_blocks[ $anchor_block_type ][ $relative_position ] ) ) {
+                unset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] );
+            }
+        }
+        if ( empty( $hooked_blocks[ $anchor_block_type ] ) ) {
+            unset( $hooked_blocks[ $anchor_block_type ] );
+        }
+    }
+
+    /*
+     * We also need to cover the case where the hooked block is not present in
+     * `$content` at first and we're allowed to insert it once -- but not again.
+     */
+    $suppress_single_instance_blocks = static function ( $hooked_block_types ) use ( &$block_allows_multiple_instances, $content ) {
+        static $single_instance_blocks_present_in_content = array();
+        foreach ( $hooked_block_types as $index => $hooked_block_type ) {
+            if ( ! isset( $block_allows_multiple_instances[ $hooked_block_type ] ) ) {
+                $hooked_block_type_definition =
+                    WP_Block_Type_Registry::get_instance()->get_registered( $hooked_block_type );
+
+                $block_allows_multiple_instances[ $hooked_block_type ] =
+                    block_has_support( $hooked_block_type_definition, 'multiple', true );
+            }
+
+            if ( $block_allows_multiple_instances[ $hooked_block_type ] ) {
+                continue;
+            }
+
+            // The block doesn't allow multiple instances, so we need to check if it's already present.
+            if (
+                in_array( $hooked_block_type, $single_instance_blocks_present_in_content, true ) ||
+                has_block( $hooked_block_type, $content )
+            ) {
+                unset( $hooked_block_types[ $index ] );
+            } else {
+                // We can insert the block once, but need to remember not to insert it again.
+                $single_instance_blocks_present_in_content[] = $hooked_block_type;
+            }
+        }
+        return $hooked_block_types;
+    };
+    add_filter( 'hooked_block_types', $suppress_single_instance_blocks, PHP_INT_MAX );
+    $content = traverse_and_serialize_blocks(
+        parse_blocks( $content ),
+        $before_block_visitor,
+        $after_block_visitor
+    );
+    remove_filter( 'hooked_block_types', $suppress_single_instance_blocks, PHP_INT_MAX );
+
+    return $content;
 }
 

trunk/tests/phpunit/tests/blocks/applyBlockHooksToContent.php

@@ -28 +28 @@
             )
         );
+
+        register_block_type(
+            'tests/hooked-block-with-multiple-false',
+            array(
+                'block_hooks' => array(
+                    'tests/other-anchor-block' => 'after',
+                ),
+                'supports'    => array(
+                    'multiple' => false,
+                ),
+            )
+        );
+
+        register_block_type(
+            'tests/dynamically-hooked-block-with-multiple-false',
+            array(
+                'supports' => array(
+                    'multiple' => false,
+                ),
+            )
+        );
     }
 
@@ -39 +60 @@
 
         $registry->unregister( 'tests/hooked-block' );
+        $registry->unregister( 'tests/hooked-block-with-multiple-false' );
+        $registry->unregister( 'tests/dynamically-hooked-block-with-multiple-false' );
     }
 
@@ -68 +91 @@
         );
     }
+
+    /**
+     * @ticket 61902
+     */
+    public function test_apply_block_hooks_to_content_respect_multiple_false() {
+        $context          = new WP_Block_Template();
+        $context->content = '<!-- wp:tests/hooked-block-with-multiple-false /--><!-- wp:tests/other-anchor-block /-->';
+
+        $actual = apply_block_hooks_to_content( $context->content, $context, 'insert_hooked_blocks' );
+        $this->assertSame(
+            '<!-- wp:tests/hooked-block-with-multiple-false /--><!-- wp:tests/other-anchor-block /-->',
+            $actual
+        );
+    }
+
+    /**
+     * @ticket 61902
+     */
+    public function test_apply_block_hooks_to_content_respect_multiple_false_after_inserting_once() {
+        $context          = new WP_Block_Template();
+        $context->content = '<!-- wp:tests/other-anchor-block /--><!-- wp:tests/other-block /--><!-- wp:tests/other-anchor-block /-->';
+
+        $actual = apply_block_hooks_to_content( $context->content, $context, 'insert_hooked_blocks' );
+        $this->assertSame(
+            '<!-- wp:tests/other-anchor-block /--><!-- wp:tests/hooked-block-with-multiple-false /--><!-- wp:tests/other-block /--><!-- wp:tests/other-anchor-block /-->',
+            $actual
+        );
+    }
+
+    /**
+     * @ticket 61902
+     */
+    public function test_apply_block_hooks_to_content_respect_multiple_false_with_filter() {
+        $filter = function ( $hooked_block_types, $relative_position, $anchor_block_type ) {
+            if ( 'tests/yet-another-anchor-block' === $anchor_block_type && 'after' === $relative_position ) {
+                $hooked_block_types[] = 'tests/dynamically-hooked-block-with-multiple-false';
+            }
+
+            return $hooked_block_types;
+        };
+
+        $context          = new WP_Block_Template();
+        $context->content = '<!-- wp:tests/dynamically-hooked-block-with-multiple-false /--><!-- wp:tests/yet-another-anchor-block /-->';
+
+        add_filter( 'hooked_block_types', $filter, 10, 3 );
+        $actual = apply_block_hooks_to_content( $context->content, $context, 'insert_hooked_blocks' );
+        remove_filter( 'hooked_block_types', $filter, 10 );
+
+        $this->assertSame(
+            '<!-- wp:tests/dynamically-hooked-block-with-multiple-false /--><!-- wp:tests/yet-another-anchor-block /-->',
+            $actual
+        );
+    }
+
+    /**
+     * @ticket 61902
+     */
+    public function test_apply_block_hooks_to_content_respect_multiple_false_after_inserting_once_with_filter() {
+        $filter = function ( $hooked_block_types, $relative_position, $anchor_block_type ) {
+            if ( 'tests/yet-another-anchor-block' === $anchor_block_type && 'after' === $relative_position ) {
+                $hooked_block_types[] = 'tests/dynamically-hooked-block-with-multiple-false';
+            }
+
+            return $hooked_block_types;
+        };
+
+        $context          = new WP_Block_Template();
+        $context->content = '<!-- wp:tests/yet-another-anchor-block /--><!-- wp:tests/other-block /--><!-- wp:tests/yet-another-anchor-block /-->';
+
+        add_filter( 'hooked_block_types', $filter, 10, 3 );
+        $actual = apply_block_hooks_to_content( $context->content, $context, 'insert_hooked_blocks' );
+        remove_filter( 'hooked_block_types', $filter, 10 );
+
+        $this->assertSame(
+            '<!-- wp:tests/yet-another-anchor-block /--><!-- wp:tests/dynamically-hooked-block-with-multiple-false /--><!-- wp:tests/other-block /--><!-- wp:tests/yet-another-anchor-block /-->',
+            $actual
+        );
+    }
 }