Changeset 57668 for trunk/tests/phpunit/tests/blocks/setIgnoredHookedBlocksMetadata.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/setIgnoredHookedBlocksMetadata.php (modified) (1 diff)

trunk/tests/phpunit/tests/blocks/setIgnoredHookedBlocksMetadata.php

@@ -145 +145 @@
         );
     }
+
+    /**
+     * @ticket 60580
+     *
+     * @covers ::set_ignored_hooked_blocks_metadata
+     */
+    public function test_set_ignored_hooked_blocks_metadata_for_block_suppressed_by_filter() {
+        $anchor_block = array(
+            'blockName' => 'tests/anchor-block',
+            'attrs'     => array(),
+        );
+
+        $hooked_blocks = array(
+            'tests/anchor-block' => array(
+                'after' => array( 'tests/hooked-block', 'tests/hooked-block-suppressed-by-filter' ),
+            ),
+        );
+
+        $filter = function ( $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block ) {
+            if ( 'tests/anchor-block' === $parsed_anchor_block['blockName'] && 'after' === $relative_position ) {
+                return null;
+            }
+
+            return $parsed_hooked_block;
+        };
+
+        add_filter( 'hooked_block_tests/hooked-block-suppressed-by-filter', $filter, 10, 4 );
+        set_ignored_hooked_blocks_metadata( $anchor_block, 'after', $hooked_blocks, null );
+        remove_filter( 'hooked_block_tests/hooked-block-suppressed-by-filter', $filter );
+
+        $this->assertSame( array( 'tests/hooked-block' ), $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] );
+    }
 }