Changeset 57641

Timestamp:

02/16/2024 12:53:16 PM (5 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.

Location:

trunk

Files:

• src/wp-includes/block-bindings.php (modified) (1 diff)
• src/wp-includes/block-bindings/pattern-overrides.php (modified) (1 diff)
• src/wp-includes/block-bindings/post-meta.php (modified) (2 diffs)
• src/wp-includes/class-wp-block-bindings-registry.php (modified) (6 diffs)
• src/wp-includes/class-wp-block-bindings-source.php (modified) (2 diffs)
• src/wp-includes/class-wp-block-type.php (modified) (5 diffs)
• src/wp-includes/class-wp-block.php (modified) (3 diffs)
• tests/phpunit/tests/block-bindings/render.php (modified) (1 diff)
• tests/phpunit/tests/block-bindings/wpBlockBindingsRegistry.php (modified) (4 diffs)

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

@@ -76 +76 @@
  *     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:
+ *     @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 an 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.
+ *                                             `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 an 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.

trunk/src/wp-includes/block-bindings/pattern-overrides.php

@@ -40 +40 @@
             'label'              => _x( 'Pattern Overrides', 'block bindings source' ),
             'get_value_callback' => '_block_bindings_pattern_overrides_get_value',
+
         )
     );

trunk/src/wp-includes/block-bindings/post-meta.php

@@ -14 +14 @@
  * @access private
  *
- * @param array $source_args Array containing source arguments used to look up the override value.
- *                           Example: array( "key" => "foo" ).
+ * @param array    $source_args    Array containing source arguments used to look up the override value.
+ *                                 Example: array( "key" => "foo" ).
+ * @param WP_Block $block_instance The block instance.
  * @return mixed The value computed for the source.
  */
-function _block_bindings_post_meta_get_value( array $source_args ) {
-    if ( ! isset( $source_args['key'] ) ) {
+function _block_bindings_post_meta_get_value( array $source_args ) {
+    if ( ( $source_args['key'] ) ) {
         return null;
     }
 
-    // Use the postId attribute if available.
-    if ( isset( $source_args['postId'] ) ) {
-        $post_id = $source_args['postId'];
-    } else {
-        // $block_instance->context['postId'] is not available in the Image block.
-        $post_id = get_the_ID();
+    if ( empty( $block_instance->context['postId'] ) ) {
+        return null;
     }
+
 
     // If a post isn't public, we need to prevent unauthorized users from accessing the post meta.
@@ -52 +50 @@
             'label'              => _x( 'Post Meta', 'block bindings source' ),
             'get_value_callback' => '_block_bindings_post_meta_get_value',
+
         )
     );

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

@@ -34 +34 @@
 
     /**
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      * 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 */
+        /
         if ( ! isset( $source_properties['label'] ) ) {
             _doing_it_wrong(
@@ -118 +144 @@
         }
 
-        /* Validate 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 */
+        /
         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'
             );
@@ -145 +190 @@
         $this->sources[ $source_name ] = $source;
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
         return $source;
     }

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

@@ -47 +47 @@
 
     /**
+
+
+
+
+
+
+
+
      * Constructor.
      *
@@ -58 +66 @@
      */
     public function __construct( string $name, array $source_properties ) {
-        $this->name               = $name;
-        $this->label              = $source_properties['label'];
-        $this->get_value_callback = $source_properties['get_value_callback'];
+        $this->name = $name;
+        foreach ( $source_properties as $property_name => $property_value ) {
+            $this->$property_name = $property_value;
+        }
     }
 

trunk/src/wp-includes/class-wp-block-type.php

@@ -181 +181 @@
      * @var string[]
      */
-    public $uses_context = array();
+    p $uses_context = array();
 
     /**
@@ -367 +367 @@
         }
 
+
+
+
+
         if ( ! in_array( $name, $this->deprecated_properties, true ) ) {
             return;
@@ -395 +399 @@
      */
     public function __isset( $name ) {
-        if ( 'variations' === $name ) {
+        if (  ) {
             return true;
         }
@@ -418 +422 @@
      */
     public function __set( $name, $value ) {
-        if ( 'variations' === $name ) {
-            $this->variations = $value;
-            return;
-        }
-
         if ( ! in_array( $name, $this->deprecated_properties, true ) ) {
             $this->{$name} = $value;
@@ -617 +616 @@
         return apply_filters( 'get_block_type_variations', $this->variations, $this );
     }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }

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

@@ -232 +232 @@
      */
     private function process_block_bindings() {
-        $parsed_block = $this->parsed_block;
-
-        $computed_attributes = array();
-
-        // Allowed blocks that support block bindings.
-        // TODO: Look for a mechanism to opt-in for this. Maybe adding a property to block attributes?
-        $allowed_blocks = array(
+        $parsed_block               = $this->parsed_block;
+        $computed_attributes        = array();
+        $supported_block_attributes = array(
             'core/paragraph' => array( 'content' ),
             'core/heading'   => array( 'content' ),
@@ -245 +241 @@
         );
 
-        // If the block doesn't have the bindings property, isn't one of the allowed
+        // If the block doesn't have the bindings property, isn't one of the ed
         // block types, or the bindings property is not an array, return the block content.
         if (
-            ! isset( $allowed_blocks[ $this->name ] ) ||
+            ! isset( $s[ $this->name ] ) ||
             empty( $parsed_block['attrs']['metadata']['bindings'] ) ||
             ! is_array( $parsed_block['attrs']['metadata']['bindings'] )
@@ -256 +252 @@
 
         foreach ( $parsed_block['attrs']['metadata']['bindings'] as $attribute_name => $block_binding ) {
-            // If the attribute is not in the allowed list, process next attribute.
-            if ( ! in_array( $attribute_name, $allowed_blocks[ $this->name ], true ) ) {
+            // If the attribute is not in the ed list, process next attribute.
+            if ( ! in_array( $attribute_name, $s[ $this->name ], true ) ) {
                 continue;
             }

trunk/tests/phpunit/tests/block-bindings/render.php

@@ -116 +116 @@
 
     /**
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      * Tests if the block content is updated with the value returned by the source
      * for the Image block in the placeholder state.

trunk/tests/phpunit/tests/block-bindings/wpBlockBindingsRegistry.php

@@ -40 +40 @@
                 return 'test-value';
             },
+
         );
     }
@@ -158 +159 @@
 
         self::$test_source_properties['get_value_callback'] = 'not-a-callback';
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
         $result = $this->registry->register( self::$test_source_name, self::$test_source_properties );
@@ -180 +198 @@
             $result
         );
+
+
+
+
+
+
+
     }
 
@@ -322 +347 @@
         $this->assertTrue( $result );
     }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }