Changeset 57668

Timestamp:

02/20/2024 03:20:39 PM (8 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.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (4 diffs)
• tests/phpunit/tests/blocks/insertHookedBlocks.php (modified) (1 diff)
• tests/phpunit/tests/blocks/setIgnoredHookedBlocksMetadata.php (modified) (1 diff)

trunk/src/wp-includes/blocks.php

@@ -898 +898 @@
          * @since 6.5.0
          *
-         * @param array                           $parsed_hooked_block The parsed block array for the given hooked block type.
+         * @param array|null                      $parsed_hooked_block The parsed block array for the given hooked block type, or null to suppress the block.
          * @param string                          $hooked_block_type   The hooked block type name.
          * @param string                          $relative_position   The relative position of the hooked block.
@@ -914 +914 @@
          * @since 6.5.0
          *
-         * @param array                           $parsed_hooked_block The parsed block array for the given hooked block type.
+         * @param array|null                      $parsed_hooked_block The parsed block array for the given hooked block type, or null to suppress the block.
          * @param string                          $hooked_block_type   The hooked block type name.
          * @param string                          $relative_position   The relative position of the hooked block.
@@ -923 +923 @@
         $parsed_hooked_block = apply_filters( "hooked_block_{$hooked_block_type}", $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block, $context );
 
+        if ( null === $parsed_hooked_block ) {
+            continue;
+        }
+
         // It's possible that the filter returned a block of a different type, so we explicitly
         // look for the original `$hooked_block_type` in the `ignoredHookedBlocks` metadata.
@@ -961 +965 @@
     if ( empty( $hooked_block_types ) ) {
         return '';
+    }
+
+    foreach ( $hooked_block_types as $index => $hooked_block_type ) {
+        $parsed_hooked_block = array(
+            'blockName'    => $hooked_block_type,
+            'attrs'        => array(),
+            'innerBlocks'  => array(),
+            'innerContent' => array(),
+        );
+
+        /** This filter is documented in wp-includes/blocks.php */
+        $parsed_hooked_block = apply_filters( 'hooked_block', $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block, $context );
+
+        /** This filter is documented in wp-includes/blocks.php */
+        $parsed_hooked_block = apply_filters( "hooked_block_{$hooked_block_type}", $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block, $context );
+
+        if ( null === $parsed_hooked_block ) {
+            unset( $hooked_block_types[ $index ] );
+        }
     }
 

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." );
+    }
 }

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'] );
+    }
 }