Changeset 57668 for trunk/src/wp-includes/blocks.php

Timestamp:

02/20/2024 03:20:39 PM (2 years 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/src/wp-includes/blocks.php (modified) (4 diffs)

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