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

Timestamp:

02/08/2024 08:55:18 AM (3 years ago)

Author:

gziolo

Message:

Editor: Introduce WP_Block_Bindings_Source class

Abstracts the block bindings source array into a well-defined object.

Fixes #60447.
See #60282.
Follow-up [57373].
Props czapla, santosguillamot, gziolo.

File:

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

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

@@ -21 +21 @@
          *
          * @since 6.5.0
-         * @var array
+         * @var WP_Block_Bindings_Source[]
          */
         private $sources = array();
@@ -67 +67 @@
          *                                        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.
+         * @return WP_Block_Bindings_Source|false Source when the registration was successful, or `false` on failure.
          */
         public function register( string $source_name, array $source_properties ) {
@@ -108 +108 @@
                 }
 
-                $source = array_merge(
-                        array( 'name' => $source_name ),
+                /* Validate that the source properties contain the label */
+                if ( ! isset( $source_properties['label'] ) ) {
+                        _doing_it_wrong(
+                                __METHOD__,
+                                __( 'The $source_properties must contain a "label".' ),
+                                '6.5.0'
+                        );
+                        return false;
+                }
+
+                /* Validate that the source properties contain the get_value_callback */
+                if ( ! isset( $source_properties['get_value_callback'] ) ) {
+                        _doing_it_wrong(
+                                __METHOD__,
+                                __( 'The $source_properties must contain a "get_value_callback".' ),
+                                '6.5.0'
+                        );
+                        return false;
+                }
+
+                /* 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'
+                        );
+                        return false;
+                }
+
+                $source = new WP_Block_Bindings_Source(
+                        $source_name,
                         $source_properties
                 );
@@ -124 +154 @@
          *
          * @param string $source_name Block bindings source name including namespace.
-         * @return array|false The unregistered block bindings source on success and `false` otherwise.
+         * @return WP_Block_Bindings_Source|false The unregistered block bindings source on success and `false` otherwise.
          */
         public function unregister( string $source_name ) {
@@ -148 +178 @@
          * @since 6.5.0
          *
-         * @return array The array of registered sources.
+         * @return WP_Block_Bindings_Source[] The array of registered sources.
          */
         public function get_all_registered() {
@@ -160 +190 @@
          *
          * @param string $source_name The name of the source.
-         * @return array|null The registered block bindings source, or `null` if it is not registered.
+         * @return WP_Block_Bindings_Source|null The registered block bindings source, or `null` if it is not registered.
          */
         public function get_registered( string $source_name ) {