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.



git-svn-id: https://develop.svn.wordpress.org/trunk@57526 602fd350-edb4-49c9-b593-d223f7449a82

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

src/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' );

src/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' );

src/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 @@ public function register( $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.
 	 */
-	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 @@ public function get_all_registered() {
 	 * @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;
 		}