Changeset 56649 for trunk/tests/phpunit/tests/blocks/serialize.php

Timestamp:

09/21/2023 04:16:05 PM (16 months ago)

Author:

Bernhard Reiter

Message:

Blocks: Implement automatic block insertion into Block Hooks.

Block Hooks allow a third-party block to specify a position relative to a given block into which it will then be automatically inserted (e.g. a "Like" button block can ask to be inserted after the Post Content block, or an eCommerce shopping cart block can ask to be inserted after the Navigation block).

The underlying idea is to provide an extensibility mechanism for Block Themes, in analogy to WordPress' ​Hooks concept that has allowed extending Classic Themes through filters and actions.

The two core tenets for Block Hooks are:

1. Insertion into the frontend should happen right after a plugin containing a hooked block is activated (i.e. the user isn't required to insert the block manually in the editor first); similarly, disabling the plugin should remove the hooked block from the frontend.
2. The user has the ultimate power to customize that automatic insertion: The hooked block is also visible in the editor, and the user's decision to persist, dismiss (i.e. remove), customize, or move it will be respected (and reflected on the frontend).

To account for both tenets, the tradeoff was made to limit automatic block insertion to unmodified templates (and template parts, respectively). The reason for this is that the simplest way of storing the information whether a block has been persisted to (or dismissed from) a given template (or part) is right in the template markup.

To accommodate for that tradeoff, ​UI controls (toggles) are being added to increase visibility of hooked blocks, and to allow for their later insertion into templates (or parts) that already have been modified by the user.

For hooked blocks to appear both in the frontend and in the editor (see tenet number 2), they need to be inserted into both the frontend markup and the REST API (templates and patterns endpoints) equally. As a consequence, this means that automatic insertion couldn't (only) be implemented at block render stage, as for the editor, the serialized (but unrendered) markup needs to be modified.

Furthermore, hooked blocks also have to be inserted into block patterns. Since practically no filters exist for the patterns registry, this has to be done in the registry's get_registered and get_all_registered methods.

Props gziolo.
Fixes #59313.

File:

• trunk/tests/phpunit/tests/blocks/serialize.php (modified) (2 diffs)

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

@@ -63 +63 @@
      * @covers ::traverse_and_serialize_blocks
      */
-    public function test_traverse_and_serialize_blocks() {
+    public function test_traverse_and_serialize_blocks_pre_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 );
@@ -82 +82 @@
 
     /**
+     * @ticket 59313
+     *
+     * @covers ::traverse_and_serialize_blocks
+     */
+    public function test_traverse_and_serialize_blocks_pre_callback_prepends_to_inner_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, array( __CLASS__, 'insert_next_to_inner_block_callback' ) );
+
+        $this->assertSame(
+            "<!-- wp:outer --><!-- wp:tests/inserted-block /--><!-- wp:inner {\"key\":\"value\"} -->Example.<!-- /wp:inner -->\n\nExample.\n\n<!-- wp:void /--><!-- /wp:outer -->",
+            $actual
+        );
+    }
+
+    /**
+     * @ticket 59313
+     *
+     * @covers ::traverse_and_serialize_blocks
+     */
+    public function test_traverse_and_serialize_blocks_post_callback_appends_to_inner_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__, 'insert_next_to_inner_block_callback' ) );
+
+        $this->assertSame(
+            "<!-- wp:outer --><!-- wp:inner {\"key\":\"value\"} -->Example.<!-- /wp:inner --><!-- wp:tests/inserted-block /-->\n\nExample.\n\n<!-- wp:void /--><!-- /wp:outer -->",
+            $actual
+        );
+    }
+
+    public static function insert_next_to_inner_block_callback( $block ) {
+        if ( 'core/inner' !== $block['blockName'] ) {
+            return '';
+        }
+
+        return get_comment_delimited_block_content( 'tests/inserted-block', array(), '' );
+    }
+
+    /**
+     * @ticket 59313
+     *
+     * @covers ::traverse_and_serialize_blocks
+     */
+    public function test_traverse_and_serialize_blocks_pre_callback_prepends_to_child_blocks() {
+        $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, array( __CLASS__, 'insert_next_to_child_blocks_callback' ) );
+
+        $this->assertSame(
+            "<!-- wp:outer --><!-- wp:tests/inserted-block {\"parent\":\"core/outer\"} /--><!-- wp:inner {\"key\":\"value\"} -->Example.<!-- /wp:inner -->\n\nExample.\n\n<!-- wp:tests/inserted-block {\"parent\":\"core/outer\"} /--><!-- wp:void /--><!-- /wp:outer -->",
+            $actual
+        );
+    }
+
+    /**
+     * @ticket 59313
+     *
+     * @covers ::traverse_and_serialize_blocks
+     */
+    public function test_traverse_and_serialize_blocks_post_callback_appends_to_child_blocks() {
+        $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__, 'insert_next_to_child_blocks_callback' ) );
+
+        $this->assertSame(
+            "<!-- wp:outer --><!-- wp:inner {\"key\":\"value\"} -->Example.<!-- /wp:inner --><!-- wp:tests/inserted-block {\"parent\":\"core/outer\"} /-->\n\nExample.\n\n<!-- wp:void /--><!-- wp:tests/inserted-block {\"parent\":\"core/outer\"} /--><!-- /wp:outer -->",
+            $actual
+        );
+    }
+
+    public static function insert_next_to_child_blocks_callback( $block, $parent_block ) {
+        if ( ! isset( $parent_block ) ) {
+            return '';
+        }
+
+        return get_comment_delimited_block_content(
+            'tests/inserted-block',
+            array(
+                'parent' => $parent_block['blockName'],
+            ),
+            ''
+        );
+    }
+
+    /**
+     * @ticket 59313
+     *
+     * @covers ::traverse_and_serialize_blocks
+     */
+    public function test_traverse_and_serialize_blocks_pre_callback_prepends_if_prev_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, array( __CLASS__, 'insert_next_to_if_prev_or_next_block_callback' ) );
+
+        $this->assertSame(
+            "<!-- wp:outer --><!-- wp:inner {\"key\":\"value\"} -->Example.<!-- /wp:inner -->\n\nExample.\n\n<!-- wp:tests/inserted-block {\"prev_or_next\":\"core/inner\"} /--><!-- wp:void /--><!-- /wp:outer -->",
+            $actual
+        );
+    }
+
+    /**
+     * @ticket 59313
+     *
+     * @covers ::traverse_and_serialize_blocks
+     */
+    public function test_traverse_and_serialize_blocks_post_callback_appends_if_prev_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__, 'insert_next_to_if_prev_or_next_block_callback' ) );
+
+        $this->assertSame(
+            "<!-- wp:outer --><!-- wp:inner {\"key\":\"value\"} -->Example.<!-- /wp:inner --><!-- wp:tests/inserted-block {\"prev_or_next\":\"core/void\"} /-->\n\nExample.\n\n<!-- wp:void /--><!-- /wp:outer -->",
+            $actual
+        );
+    }
+
+    public static function insert_next_to_if_prev_or_next_block_callback( $block, $parent_block, $prev_or_next ) {
+        if ( ! isset( $prev_or_next ) ) {
+            return '';
+        }
+
+        return get_comment_delimited_block_content(
+            'tests/inserted-block',
+            array(
+                'prev_or_next' => $prev_or_next['blockName'],
+            ),
+            ''
+        );
+    }
+
+    /**
      * @ticket 59327
      * @ticket 59412