Changeset 57668 for trunk/tests/phpunit/tests/blocks/insertHookedBlocks.php

Timestamp:

02/20/2024 03:20:39 PM (11 months ago)

Author:

Bernhard Reiter

Message:

Block Hooks: Allow hooked_block filters to return null.

Allow returning null from the hooked_block and hooked_block_{$hooked_block_type} filters to suppress a hooked block from being inserted. This is required to allow extenders conditionally inserting a hooked block based on e.g. the value of an attribute of the anchor block.

Props swissspidy, gziolo, joshuatf, tomjcafferkey.
Fixes 60580.

File:

• trunk/tests/phpunit/tests/blocks/insertHookedBlocks.php (modified) (1 diff)

trunk/tests/phpunit/tests/blocks/insertHookedBlocks.php

@@ -181 +181 @@
         );
     }
+
+    /**
+     * @ticket 60580
+     *
+     * @covers ::insert_hooked_blocks
+     */
+    public function test_insert_hooked_blocks_filter_can_suppress_hooked_block() {
+        $anchor_block = array(
+            'blockName'    => self::ANCHOR_BLOCK_TYPE,
+            'attrs'        => array(
+                'layout' => array(
+                    'type' => 'flex',
+                ),
+            ),
+            'innerContent' => array(),
+        );
+
+        $filter = function ( $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block ) {
+            // Is the hooked block adjacent to the anchor block?
+            if ( 'before' !== $relative_position && 'after' !== $relative_position ) {
+                return $parsed_hooked_block;
+            }
+
+            if (
+                isset( $parsed_anchor_block['attrs']['layout']['type'] ) &&
+                'flex' === $parsed_anchor_block['attrs']['layout']['type']
+            ) {
+                return null;
+            }
+
+            return $parsed_hooked_block;
+        };
+        add_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter, 10, 4 );
+        $actual = insert_hooked_blocks( $anchor_block, 'after', self::HOOKED_BLOCKS, array() );
+        remove_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter );
+
+        $this->assertSame( '', $actual, "No markup should've been generated for hooked block suppressed by filter." );
+    }
 }