Changeset 54670 for trunk/src/wp-includes/class-wp-block-type.php

Timestamp:

10/24/2022 02:14:25 PM (3 years ago)

Author:

Bernhard Reiter

Message:

Blocks: Allow arrays for deprecated asset types in block registration.

In register_block_type, continue to allow passing arrays as the editor_script, script, view_script, editor_style, and style arguments. Note that those fields were soft-deprecated in favor of their _handles counterparts in [54155], which would allow specifying multiple items. At the same time, the deprecated fields were limited to string or null.

However, this broke existing code that passed an array as one of those arguments. For backwards compatibility, this change thus restores the previous behavior. It is implemented in WP_Block_Type as a pair of __get() and __set() methods that wrap around the corresponding _handles members, which are arrays of strings.

It also affects the REST API endpoint for block types. The latter’s schema has never allowed for anything other than string or null for any of those fields. For this reason, it now returns the first element of the array stored in the corresponding _handles member in WP_Block_Type.

Follow-up [54155].
Props nendeb55, costdev, gziolo, spacedmonkey, mukesh27, sergeybiryukov, audrasjb.
Fixes #56707.

File:

• trunk/src/wp-includes/class-wp-block-type.php (modified) (3 diffs)

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

@@ -296 +296 @@
      * @param string $name Deprecated property name.
      *
-     * @return string|null|void The value read from the new property if the first item in the array provided,
-     *                          null when value not found, or void when unknown property name provided.
+     * @return string|string[]|null|void The value read from the new property if the first item in the array provided,
+     *                                   null when value not found, or void when unknown property name provided.
      */
     public function __get( $name ) {
@@ -305 +305 @@
 
         $new_name = $name . '_handles';
+
+        if ( ! property_exists( $this, $new_name ) || ! is_array( $this->{$new_name} ) ) {
+            return null;
+        }
+
+        if ( count( $this->{$new_name} ) > 1 ) {
+            return $this->{$new_name};
+        }
         return isset( $this->{$new_name}[0] ) ? $this->{$new_name}[0] : null;
     }
@@ -344 +352 @@
         }
 
+        $new_name = $name . '_handles';
+
+        if ( is_array( $value ) ) {
+            $filtered = array_filter( $value, 'is_string' );
+
+            if ( count( $filtered ) !== count( $value ) ) {
+                    _doing_it_wrong(
+                        __METHOD__,
+                        sprintf(
+                            /* translators: %s: The '$value' argument. */
+                            __( 'The %s argument must be a string or a string array.' ),
+                            '<code>$value</code>'
+                        ),
+                        '6.1.0'
+                    );
+            }
+
+            $this->{$new_name} = array_values( $filtered );
+            return;
+        }
+
         if ( ! is_string( $value ) ) {
             return;
         }
 
-        $new_name             = $name . '_handles';
-        $this->{$new_name}[0] = $value;
+        $this->{$new_name} = array( $value );
     }