Editor: Refactor the way block bindings sources are handled

It fixes the coding style issues reported. It goes further and improves the code quality it other places where the logic for block bindings was added.

Follow-up for [57514].
Props: gziolo, mukesh27, youknowriad, santosguillamot.
See #60282.


Built from https://develop.svn.wordpress.org/trunk@57526


git-svn-id: http://core.svn.wordpress.org/trunk@57027 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-includes/block-bindings.php

@@ -19,10 +19,10 @@
  *
  * @since 6.5.0
  *
- * @param string   $source_name       The name of the source. It must be a string containing a namespace prefix, i.e.
- *                                    `my-plugin/my-custom-source`. It must only contain lowercase alphanumeric
- *                                    characters, the forward slash `/` and dashes.
- * @param array    $source_properties {
+ * @param string $source_name       The name of the source. It must be a string containing a namespace prefix, i.e.
+ *                                  `my-plugin/my-custom-source`. It must only contain lowercase alphanumeric
+ *                                  characters, the forward slash `/` and dashes.
+ * @param array  $source_properties {
  *     The array of arguments that are used to register a source.
  *
  *     @type string   $label              The label of the source.
@@ -40,7 +40,7 @@
  * }
  * @return array|false Source when the registration was successful, or `false` on failure.
  */
-function register_block_bindings_source( $source_name, array $source_properties ) {
+function register_block_bindings_source( string $source_name, array $source_properties ) {
 	return WP_Block_Bindings_Registry::get_instance()->register( $source_name, $source_properties );
 }
 
@@ -52,7 +52,7 @@ function register_block_bindings_source( $source_name, array $source_properties
  * @param string $source_name Block bindings source name including namespace.
  * @return array|false The unregistered block bindings source on success and `false` otherwise.
  */
-function unregister_block_bindings_source( $source_name ) {
+function unregister_block_bindings_source( string $source_name ) {
 	return WP_Block_Bindings_Registry::get_instance()->unregister( $source_name );
 }
 
@@ -66,3 +66,15 @@ function unregister_block_bindings_source( $source_name ) {
 function get_all_registered_block_bindings_sources() {
 	return WP_Block_Bindings_Registry::get_instance()->get_all_registered();
 }
+
+/**
+ * Retrieves a registered block bindings source.
+ *
+ * @since 6.5.0
+ *
+ * @param string $source_name The name of the source.
+ * @return array|null The registered block bindings source, or `null` if it is not registered.
+ */
+function get_block_bindings_source( string $source_name ) {
+	return WP_Block_Bindings_Registry::get_instance()->get_registered( $source_name );
+}

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

@@ -0,0 +1,46 @@
+<?php
+/**
+ * Pattern Overrides source for the Block Bindings.
+ *
+ * @since 6.5.0
+ * @package WordPress
+ * @subpackage Block Bindings
+ */
+
+/**
+ * Gets value for the Pattern Overrides source.
+ *
+ * @since 6.5.0
+ * @access private
+ *
+ * @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.
+ * @param string   $attribute_name The name of the target attribute.
+ * @return mixed The value computed for the source.
+ */
+function _block_bindings_pattern_overrides_get_value( array $source_args, $block_instance, string $attribute_name ) {
+	if ( empty( $block_instance->attributes['metadata']['id'] ) ) {
+		return null;
+	}
+	$block_id = $block_instance->attributes['metadata']['id'];
+	return _wp_array_get( $block_instance->context, array( 'pattern/overrides', $block_id, $attribute_name ), null );
+}
+
+/**
+ * Registers Pattern Overrides source in the Block Bindings registry.
+ *
+ * @since 6.5.0
+ * @access private
+ */
+function _register_block_bindings_pattern_overrides_source() {
+	register_block_bindings_source(
+		'core/pattern-overrides',
+		array(
+			'label'              => _x( 'Pattern Overrides', 'block bindings source' ),
+			'get_value_callback' => '_block_bindings_pattern_overrides_get_value',
+		)
+	);
+}
+
+add_action( 'init', '_register_block_bindings_pattern_overrides_source' );

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

@@ -0,0 +1,58 @@
+<?php
+/**
+ * Post Meta source for the block bindings.
+ *
+ * @since 6.5.0
+ * @package WordPress
+ * @subpackage Block Bindings
+ */
+
+/**
+ * Gets value for Post Meta source.
+ *
+ * @since 6.5.0
+ * @access private
+ *
+ * @param array $source_args Array containing source arguments used to look up the override value.
+ *                           Example: array( "key" => "foo" ).
+ * @return mixed The value computed for the source.
+ */
+function _block_bindings_post_meta_get_value( array $source_args ) {
+	if ( ! isset( $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 a post isn't public, we need to prevent unauthorized users from accessing the post meta.
+	$post = get_post( $post_id );
+	if ( ( ! is_post_publicly_viewable( $post ) && ! current_user_can( 'read_post', $post_id ) ) || post_password_required( $post ) ) {
+		return null;
+	}
+
+	return get_post_meta( $post_id, $source_args['key'], true );
+}
+
+/**
+ * Registers Post Meta source in the block bindings registry.
+ *
+ * @since 6.5.0
+ * @access private
+ */
+function _register_block_bindings_post_meta_source() {
+	register_block_bindings_source(
+		'core/post-meta',
+		array(
+			'label'              => _x( 'Post Meta', 'block bindings source' ),
+			'get_value_callback' => '_block_bindings_post_meta_get_value',
+		)
+	);
+}
+
+add_action( 'init', '_register_block_bindings_post_meta_source' );

wp-includes/block-bindings/sources/pattern.php

@@ -1,34 +0,0 @@
-<?php
-/**
- * The "pattern" source for the Block Bindings API. This source is used by the
- * Pattern Overrides.
- *
- * @since 6.5.0
- * @package WordPress
- */
-function pattern_source_callback( $source_attrs, $block_instance, $attribute_name ) {
-	if ( ! _wp_array_get( $block_instance->attributes, array( 'metadata', 'id' ), false ) ) {
-		return null;
-	}
-	$block_id = $block_instance->attributes['metadata']['id'];
-	return _wp_array_get( $block_instance->context, array( 'pattern/overrides', $block_id, $attribute_name ), null );
-}
-
-
-/**
- * Registers the "pattern" source for the Block Bindings API.
- *
- * @access private
- * @since 6.5.0
- */
-function _register_block_bindings_pattern_overrides_source() {
-	register_block_bindings_source(
-		'core/pattern-overrides',
-		array(
-			'label'              => _x( 'Pattern Overrides', 'block bindings source' ),
-			'get_value_callback' => 'pattern_source_callback',
-		)
-	);
-}
-
-add_action( 'init', '_register_block_bindings_pattern_overrides_source' );

wp-includes/block-bindings/sources/post-meta.php

@@ -1,47 +0,0 @@
-<?php
-/**
- * Add the post_meta source to the Block Bindings API.
- *
- * @since 6.5.0
- * @package WordPress
- */
-function post_meta_source_callback( $source_attrs ) {
-	if ( ! isset( $source_attrs['key'] ) ) {
-		return null;
-	}
-
-	// Use the postId attribute if available
-	if ( isset( $source_attrs['postId'] ) ) {
-		$post_id = $source_attrs['postId'];
-	} else {
-		// $block_instance->context['postId'] is not available in the Image block.
-		$post_id = get_the_ID();
-	}
-
-	// If a post isn't public, we need to prevent
-	// unauthorized users from accessing the post meta.
-	$post = get_post( $post_id );
-	if ( ( ! is_post_publicly_viewable( $post ) && ! current_user_can( 'read_post', $post_id ) ) || post_password_required( $post ) ) {
-		return null;
-	}
-
-	return get_post_meta( $post_id, $source_attrs['key'], true );
-}
-
-/**
- * Registers the "post_meta" source for the Block Bindings API.
- *
- * @access private
- * @since 6.5.0
- */
-function _register_block_bindings_post_meta_source() {
-	register_block_bindings_source(
-		'core/post-meta',
-		array(
-			'label'              => _x( 'Post Meta', 'block bindings source' ),
-			'get_value_callback' => 'post_meta_source_callback',
-		)
-	);
-}
-
-add_action( 'init', '_register_block_bindings_post_meta_source' );

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

@@ -57,13 +57,13 @@ final class WP_Block_Bindings_Registry {
 	 *                                                                              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 .
+	 *                                            - @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.
 	 * }
 	 * @return array|false Source when the registration was successful, or `false` on failure.
 	 */
-	public function register( $source_name, array $source_properties ) {
+	public function register( string $source_name, array $source_properties ) {
 		if ( ! is_string( $source_name ) ) {
 			_doing_it_wrong(
 				__METHOD__,
@@ -120,7 +120,7 @@ final class WP_Block_Bindings_Registry {
 	 * @param string $source_name Block bindings source name including namespace.
 	 * @return array|false The unregistered block bindings source on success and `false` otherwise.
 	 */
-	public function unregister( $source_name ) {
+	public function unregister( string $source_name ) {
 		if ( ! $this->is_registered( $source_name ) ) {
 			_doing_it_wrong(
 				__METHOD__,
@@ -156,7 +156,7 @@ final class WP_Block_Bindings_Registry {
 	 * @param string $source_name The name of the source.
 	 * @return array|null The registered block bindings source, or `null` if it is not registered.
 	 */
-	public function get_registered( $source_name ) {
+	public function get_registered( string $source_name ) {
 		if ( ! $this->is_registered( $source_name ) ) {
 			return null;
 		}

wp-includes/class-wp-block.php

@@ -211,11 +211,11 @@ class WP_Block {
 	 *   "metadata": {
 	 *     "bindings": {
 	 *       "title": {
-	 *         "source": "post_meta",
+	 *         "source": "core/post-meta",
 	 *         "args": { "key": "text_custom_field" }
 	 *       },
 	 *       "url": {
-	 *         "source": "post_meta",
+	 *         "source": "core/post-meta",
 	 *         "args": { "key": "url_custom_field" }
 	 *       }
 	 *     }
@@ -226,14 +226,14 @@ class WP_Block {
 	 * The above example will replace the `title` and `url` attributes of the Image
 	 * block with the values of the `text_custom_field` and `url_custom_field` post meta.
 	 *
-	 * @access private
 	 * @since 6.5.0
 	 *
-	 * @param string   $block_content Block content.
-	 * @param array    $block The full block, including name and attributes.
+	 * @param string $block_content Block content.
+	 * @param array  $block         The full block, including name and attributes.
+	 * @return string The modified block content.
 	 */
 	private function process_block_bindings( $block_content ) {
-		$block = $this->parsed_block;
+		$parsed_block = $this->parsed_block;
 
 		// Allowed blocks that support block bindings.
 		// TODO: Look for a mechanism to opt-in for this. Maybe adding a property to block attributes?
@@ -246,69 +246,68 @@ class WP_Block {
 
 		// If the block doesn't have the bindings property, isn't one of the allowed
 		// block types, or the bindings property is not an array, return the block content.
-		if ( ! isset( $block['attrs']['metadata']['bindings'] ) ||
-				! is_array( $block['attrs']['metadata']['bindings'] ) ||
-				! isset( $allowed_blocks[ $this->name ] )
-				) {
+		if (
+			! isset( $allowed_blocks[ $this->name ] ) ||
+			empty( $parsed_block['attrs']['metadata']['bindings'] ) ||
+			! is_array( $parsed_block['attrs']['metadata']['bindings'] )
+		) {
 			return $block_content;
 		}
 
-		$block_bindings_sources = get_all_registered_block_bindings_sources();
 		$modified_block_content = $block_content;
-		foreach ( $block['attrs']['metadata']['bindings'] as $binding_attribute => $binding_source ) {
-			// If the attribute is not in the list, process next attribute.
-			if ( ! in_array( $binding_attribute, $allowed_blocks[ $this->name ], true ) ) {
+		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 ) ) {
 				continue;
 			}
 			// If no source is provided, or that source is not registered, process next attribute.
-			if ( ! isset( $binding_source['source'] ) || ! is_string( $binding_source['source'] ) || ! isset( $block_bindings_sources[ $binding_source['source'] ] ) ) {
+			if ( ! isset( $block_binding['source'] ) || ! is_string( $block_binding['source'] ) ) {
 				continue;
 			}
 
-			$source_callback = $block_bindings_sources[ $binding_source['source'] ]['get_value_callback'];
-			// Get the value based on the source.
-			if ( ! isset( $binding_source['args'] ) ) {
-				$source_args = array();
-			} else {
-				$source_args = $binding_source['args'];
-			}
-			$source_value = call_user_func_array( $source_callback, array( $source_args, $this, $binding_attribute ) );
-			// If the value is null, process next attribute.
-			if ( is_null( $source_value ) ) {
+			$block_binding_source = get_block_bindings_source( $block_binding['source'] );
+			if ( null === $block_binding_source ) {
 				continue;
 			}
 
-			// Process the HTML based on the block and the attribute.
-			$modified_block_content = $this->replace_html( $modified_block_content, $this->name, $binding_attribute, $source_value );
+			$source_callback = $block_binding_source['get_value_callback'];
+			$source_args     = ! empty( $block_binding['args'] ) && is_array( $block_binding['args'] ) ? $block_binding['args'] : array();
+			$source_value    = call_user_func_array( $source_callback, array( $source_args, $this, $attribute_name ) );
+
+			// If the value is not null, process the HTML based on the block and the attribute.
+			if ( ! is_null( $source_value ) ) {
+				$modified_block_content = $this->replace_html( $modified_block_content, $attribute_name, $source_value );
+			}
 		}
+
 		return $modified_block_content;
 	}
 
 	/**
-	 * Depending on the block attributes, replace the HTML based on the value returned by the source.
+	 * Depending on the block attribute name, replace its value in the HTML based on the value provided.
 	 *
 	 * @since 6.5.0
 	 *
-	 * @param string $block_content Block content.
-	 * @param string $block_name The name of the block to process.
-	 * @param string $block_attr The attribute of the block we want to process.
-	 * @param string $source_value The value used to replace the HTML.
+	 * @param string $block_content  Block content.
+	 * @param string $attribute_name The attribute name to replace.
+	 * @param mixed  $source_value   The value used to replace in the HTML.
+	 * @return string The modified block content.
 	 */
-	private function replace_html( string $block_content, string $block_name, string $block_attr, string $source_value ) {
+	private function replace_html( string $block_content, string $attribute_name, $source_value ) {
 		$block_type = $this->block_type;
-		if ( null === $block_type || ! isset( $block_type->attributes[ $block_attr ] ) ) {
+		if ( ! isset( $block_type->attributes[ $attribute_name ] ) ) {
 			return $block_content;
 		}
 
 		// Depending on the attribute source, the processing will be different.
-		switch ( $block_type->attributes[ $block_attr ]['source'] ) {
+		switch ( $block_type->attributes[ $attribute_name ]['source'] ) {
 			case 'html':
 			case 'rich-text':
 				$block_reader = new WP_HTML_Tag_Processor( $block_content );
 
 				// TODO: Support for CSS selectors whenever they are ready in the HTML API.
 				// In the meantime, support comma-separated selectors by exploding them into an array.
-				$selectors = explode( ',', $block_type->attributes[ $block_attr ]['selector'] );
+				$selectors = explode( ',', $block_type->attributes[ $attribute_name ]['selector'] );
 				// Add a bookmark to the first tag to be able to iterate over the selectors.
 				$block_reader->next_tag();
 				$block_reader->set_bookmark( 'iterate-selectors' );
@@ -316,7 +315,7 @@ class WP_Block {
 				// TODO: This shouldn't be needed when the `set_inner_html` function is ready.
 				// Store the parent tag and its attributes to be able to restore them later in the button.
 				// The button block has a wrapper while the paragraph and heading blocks don't.
-				if ( 'core/button' === $block_name ) {
+				if ( 'core/button' === $this->name ) {
 					$button_wrapper                 = $block_reader->get_tag();
 					$button_wrapper_attribute_names = $block_reader->get_attribute_names_with_prefix( '' );
 					$button_wrapper_attrs           = array();
@@ -348,10 +347,10 @@ class WP_Block {
 						foreach ( $selector_attrs as $attribute_key => $attribute_value ) {
 							$amended_content->set_attribute( $attribute_key, $attribute_value );
 						}
-						if ( 'core/paragraph' === $block_name || 'core/heading' === $block_name ) {
+						if ( 'core/paragraph' === $this->name || 'core/heading' === $this->name ) {
 							return $amended_content->get_updated_html();
 						}
-						if ( 'core/button' === $block_name ) {
+						if ( 'core/button' === $this->name ) {
 							$button_markup  = "<$button_wrapper>{$amended_content->get_updated_html()}</$button_wrapper>";
 							$amended_button = new WP_HTML_Tag_Processor( $button_markup );
 							$amended_button->next_tag();
@@ -372,12 +371,12 @@ class WP_Block {
 				if ( ! $amended_content->next_tag(
 					array(
 						// TODO: build the query from CSS selector.
-						'tag_name' => $block_type->attributes[ $block_attr ]['selector'],
+						'tag_name' => $block_type->attributes[ $attribute_name ]['selector'],
 					)
 				) ) {
 					return $block_content;
 				}
-				$amended_content->set_attribute( $block_type->attributes[ $block_attr ]['attribute'], esc_attr( $source_value ) );
+				$amended_content->set_attribute( $block_type->attributes[ $attribute_name ]['attribute'], esc_attr( $source_value ) );
 				return $amended_content->get_updated_html();
 				break;
 

wp-includes/version.php

@@ -16,7 +16,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '6.5-alpha-57525';
+$wp_version = '6.5-alpha-57526';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

wp-settings.php

@@ -344,6 +344,8 @@ require ABSPATH . WPINC . '/class-wp-block-parser.php';
 require ABSPATH . WPINC . '/class-wp-classic-to-block-menu-converter.php';
 require ABSPATH . WPINC . '/class-wp-navigation-fallback.php';
 require ABSPATH . WPINC . '/block-bindings.php';
+require ABSPATH . WPINC . '/block-bindings/pattern-overrides.php';
+require ABSPATH . WPINC . '/block-bindings/post-meta.php';
 require ABSPATH . WPINC . '/blocks.php';
 require ABSPATH . WPINC . '/blocks/index.php';
 require ABSPATH . WPINC . '/block-editor.php';
@@ -376,8 +378,6 @@ require ABSPATH . WPINC . '/fonts/class-wp-font-face.php';
 require ABSPATH . WPINC . '/fonts.php';
 require ABSPATH . WPINC . '/class-wp-script-modules.php';
 require ABSPATH . WPINC . '/script-modules.php';
-require ABSPATH . WPINC . '/block-bindings/sources/post-meta.php';
-require ABSPATH . WPINC . '/block-bindings/sources/pattern.php';
 require ABSPATH . WPINC . '/interactivity-api.php';
 
 wp_script_modules()->add_hooks();