Changeset 57354 for trunk/tests/phpunit/tests/blocks/getHookedBlockMarkup.php

Timestamp:

01/25/2024 01:46:49 PM (9 months ago)

Author:

Bernhard Reiter

Message:

Block Hooks: Introduce a new hooked_block_{$block_type} filter.

Add a new hooked_block_{$block_type} filter that allows modifying a hooked block (in parsed block format) prior to insertion, while providing read access to its anchor block (in the same format).

This allows block authors to e.g. set a hooked block's attributes, or its inner blocks; the filter can peruse information about the anchor block when doing so. As such, this filter provides a solution to both #59572 and #60126.

The new filter is designed to strike a good balance and separation of concerns with regard to the existing ​`hooked_block_types` filter, which allows addition or removal of a block to the list of hooked blocks for a given anchor block -- all of which are identified only by their block types. This new filter, on the other hand, only applies to one hooked block at a time, and allows modifying the entire (parsed) hooked block; it also gives (read) access to the parsed anchor block.

Props gziolo, tomjcafferkey, andrewserong, isabel_brison, timbroddin, yansern.
Fixes #59572, #60126.

File:

• trunk/tests/phpunit/tests/blocks/getHookedBlockMarkup.php (modified) (3 diffs)

trunk/tests/phpunit/tests/blocks/getHookedBlockMarkup.php

@@ -12 +12 @@
  */
 class Tests_Blocks_GetHookedBlockMarkup extends WP_UnitTestCase {
+    const HOOKED_BLOCK_TYPE = 'tests/hooked-block';
+    const HOOKED_BLOCK      = array(
+        'blockName'    => 'tests/different-hooked-block',
+        'attrs'        => array(),
+        'innerContent' => array(),
+    );
+
     /**
+     * @ticket 59572
      * @ticket 60008
+     * @ticket 60126
      *
      * @covers ::get_hooked_block_markup
@@ -22 +31 @@
         );
 
-        $actual = get_hooked_block_markup( $anchor_block, 'tests/hooked-block' );
-        $this->assertSame( array( 'tests/hooked-block' ), $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] );
-        $this->assertSame( '<!-- wp:tests/hooked-block /-->', $actual );
+        $actual = get_hooked_block_markup( self::HOOKED_BLOCK, self::HOOKED_BLOCK_TYPE, $anchor_block );
+        $this->assertSame(
+            array( self::HOOKED_BLOCK_TYPE ),
+            $anchor_block['attrs']['metadata']['ignoredHookedBlocks'],
+            "Hooked block type wasn't added to ignoredHookedBlocks metadata."
+        );
+        $this->assertSame(
+            '<!-- wp:' . self::HOOKED_BLOCK['blockName'] . ' /-->',
+            $actual,
+            "Markup for hooked block wasn't generated correctly."
+        );
     }
 
     /**
+     * @ticket 59572
      * @ticket 60008
+     * @ticket 60126
      *
      * @covers ::get_hooked_block_markup
@@ -37 +56 @@
             'attrs'     => array(
                 'metadata' => array(
-                    'ignoredHookedBlocks' => array( 'tests/hooked-block' ),
+                    'ignoredHookedBlocks' => array( self::HOOKED_BLOCK_TYPE ),
                 ),
             ),
         );
 
-        $actual = get_hooked_block_markup( $anchor_block, 'tests/hooked-block' );
-        $this->assertSame( array( 'tests/hooked-block' ), $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] );
-        $this->assertSame( '', $actual );
+        $actual = get_hooked_block_markup( self::HOOKED_BLOCK, self::HOOKED_BLOCK_TYPE, $anchor_block );
+        $this->assertSame(
+            array( self::HOOKED_BLOCK_TYPE ),
+            $anchor_block['attrs']['metadata']['ignoredHookedBlocks'],
+            "ignoredHookedBlocks metadata shouldn't have been modified."
+        );
+        $this->assertSame(
+            '',
+            $actual,
+            "No markup should've been generated for ignored hooked block."
+        );
     }
 
     /**
+     * @ticket 59572
      * @ticket 60008
+     * @ticket 60126
      *
      * @covers ::get_hooked_block_markup
      */
     public function test_get_hooked_block_markup_adds_to_ignored_hooked_blocks() {
+        $other_hooked_block_type = 'tests/other-hooked-block';
+        $other_hooked_block      = array(
+            'blockName'    => $other_hooked_block_type,
+            'attrs'        => array(),
+            'innerContent' => array(),
+        );
+
         $anchor_block = array(
             'blockName' => 'tests/anchor-block',
             'attrs'     => array(
                 'metadata' => array(
-                    'ignoredHookedBlocks' => array( 'tests/hooked-block' ),
+                    'ignoredHookedBlocks' => array( self::HOOKED_BLOCK_TYPE ),
                 ),
             ),
         );
 
-        $actual = get_hooked_block_markup( $anchor_block, 'tests/other-hooked-block' );
-        $this->assertSame( array( 'tests/hooked-block', 'tests/other-hooked-block' ), $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] );
-        $this->assertSame( '<!-- wp:tests/other-hooked-block /-->', $actual );
+        $actual = get_hooked_block_markup( $other_hooked_block, $other_hooked_block_type, $anchor_block );
+        $this->assertSame(
+            array( self::HOOKED_BLOCK_TYPE, $other_hooked_block_type ),
+            $anchor_block['attrs']['metadata']['ignoredHookedBlocks'],
+            "Newly hooked block should've been added to ignoredHookedBlocks metadata while retaining previously ignored one."
+        );
+        $this->assertSame(
+            '<!-- wp:' . $other_hooked_block_type . ' /-->',
+            $actual,
+            "Markup for newly hooked block should've been generated."
+        );
     }
 }