Changeset 57641 for trunk/src/wp-includes/class-wp-block-bindings-registry.php

Timestamp:

02/16/2024 12:53:16 PM (13 months ago)

Author:

gziolo

Message:

Editor: Merge uses_context defined by block bindings sources with block types

Adds logic that fixes the limitation for souces by allowing merging the uses_context defined by block bindings sources into supported block types. Each source defines the context it needs and it is added to the block types that are using the block bindings API.

Fixes #60525.
Props santosguillamot, gziolo, czapla, thekt12.

File:

• trunk/src/wp-includes/class-wp-block-bindings-registry.php (modified) (6 diffs)

trunk/src/wp-includes/class-wp-block-bindings-registry.php

@@ -34 +34 @@
 
     /**
+     * Supported source properties that can be passed to the registered source.
+     *
+     * @since 6.5.0
+     * @var array
+     */
+    private $allowed_source_properties = array(
+        'label',
+        'get_value_callback',
+        'uses_context',
+    );
+
+    /**
+     * Supported blocks that can use the block bindings API.
+     *
+     * @since 6.5.0
+     * @var array
+     */
+    private $supported_blocks = array(
+        'core/paragraph',
+        'core/heading',
+        'core/image',
+        'core/button',
+    );
+
+    /**
      * Registers a new block bindings source.
      *
@@ -54 +79 @@
      *     The array of arguments that are used to register a source.
      *
-     *     @type string   $label              The label of the source.
-     *     @type callback $get_value_callback A callback executed when the source is processed during block rendering.
-     *                                        The callback should have the following signature:
-     *
-     *                                        `function ($source_args, $block_instance,$attribute_name): mixed`
-     *                                            - @param array    $source_args    Array containing source arguments
-     *                                                                              used to look up the override value,
-     *                                                                              i.e. {"key": "foo"}.
-     *                                            - @param WP_Block $block_instance The block instance.
-     *                                            - @param string   $attribute_name The name of the target attribute.
-     *                                        The callback has a mixed return type; it may return a string to override
-     *                                        the block's original value, null, false to remove an attribute, etc.
+     *     @type string   $label                   The label of the source.
+     *     @type callback $get_value_callback      A callback executed when the source is processed during block rendering.
+     *                                             The callback should have the following signature:
+     *
+     *                                             `function ($source_args, $block_instance,$attribute_name): mixed`
+     *                                                 - @param array    $source_args    Array containing source arguments
+     *                                                                                   used to look up the override value,
+     *                                                                                   i.e. {"key": "foo"}.
+     *                                                 - @param WP_Block $block_instance The block instance.
+     *                                                 - @param string   $attribute_name The name of the target attribute.
+     *                                             The callback has a mixed return type; it may return a string to override
+     *                                             the block's original value, null, false to remove an attribute, etc.
+     *     @type array    $uses_context (optional) Array of values to add to block `uses_context` needed by the source.
      * }
      * @return WP_Block_Bindings_Source|false Source when the registration was successful, or `false` on failure.
@@ -108 +134 @@
         }
 
-        /* Validate that the source properties contain the label */
+        // Validates that the source properties contain the label.
         if ( ! isset( $source_properties['label'] ) ) {
             _doing_it_wrong(
@@ -118 +144 @@
         }
 
-        /* Validate that the source properties contain the get_value_callback */
+        // Validates that the source properties contain the get_value_callback.
         if ( ! isset( $source_properties['get_value_callback'] ) ) {
             _doing_it_wrong(
@@ -128 +154 @@
         }
 
-        /* Validate that the get_value_callback is a valid callback */
+        // Validates that the get_value_callback is a valid callback.
         if ( ! is_callable( $source_properties['get_value_callback'] ) ) {
             _doing_it_wrong(
                 __METHOD__,
                 __( 'The "get_value_callback" parameter must be a valid callback.' ),
+                '6.5.0'
+            );
+            return false;
+        }
+
+        // Validates that the uses_context parameter is an array.
+        if ( isset( $source_properties['uses_context'] ) && ! is_array( $source_properties['uses_context'] ) ) {
+            _doing_it_wrong(
+                __METHOD__,
+                __( 'The "uses_context" parameter must be an array.' ),
+                '6.5.0'
+            );
+            return false;
+        }
+
+        if ( ! empty( array_diff( array_keys( $source_properties ), $this->allowed_source_properties ) ) ) {
+            _doing_it_wrong(
+                __METHOD__,
+                __( 'The $source_properties array contains invalid properties.' ),
                 '6.5.0'
             );
@@ -145 +190 @@
         $this->sources[ $source_name ] = $source;
 
+        // Adds `uses_context` defined by block bindings sources.
+        add_filter(
+            'get_block_type_uses_context',
+            function ( $uses_context, $block_type ) use ( $source ) {
+                if ( ! in_array( $block_type->name, $this->supported_blocks, true ) || empty( $source->uses_context ) ) {
+                    return $uses_context;
+                }
+                // Use array_values to reset the array keys.
+                return array_values( array_unique( array_merge( $uses_context, $source->uses_context ) ) );
+            },
+            10,
+            2
+        );
+
         return $source;
     }