Changeset 58246

Timestamp:

05/30/2024 07:33:23 AM (14 months ago)

Author:

isabel_brison

Message:

Editor: allow registering block styles for multiple block types.

Updates the WP_Block_Styles_Registry class to allow registering an array of blocks.

Props aaronrobertshaw, talldanwp, isabel_brison.
Fixes #61274.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (1 diff)
• src/wp-includes/class-wp-block-styles-registry.php (modified) (4 diffs)
• tests/phpunit/tests/blocks/wpBlockStylesRegistry.php (added)

trunk/src/wp-includes/blocks.php

@@ -1903 +1903 @@
  *
  * @since 5.3.0
+ * @since 6.6.0 Updated types as registry now allows registering styles for multiple block types at once.
  *
  * @link https://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles/
  *
- * @param string $block_name       Block type name including namespace.
- * @param array  $style_properties Array containing the properties of the style name, label,
- *                                 style_handle (name of the stylesheet to be enqueued),
- *                                 inline_style (string containing the CSS to be added).
- *                                 See WP_Block_Styles_Registry::register().
+ * @param string|array $block_name       Block type name including namespace or array of namespaced block type names.
+ * @param array        $style_properties Array containing the properties of the style name, label,
+ *                                       style_handle (name of the stylesheet to be enqueued),
+ *                                       inline_style (string containing the CSS to be added),
+ *                                       style_data (theme.json-like array to generate CSS from).
+ *                                       See WP_Block_Styles_Registry::register().
  * @return bool True if the block style was registered with success and false otherwise.
  */

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

@@ -43 +43 @@
      *
      * @since 5.3.0
+     * @since 6.6.0 Added ability to register style across multiple block types along with theme.json-like style data.
      *
      * @link https://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles/
      *
-     * @param string $block_name       Block type name including namespace.
-     * @param array  $style_properties {
+     * @param string|array $block_name       Block type name including namespace or array of namespaced block type names.
+     * @param array        $style_properties {
      *     Array containing the properties of the style.
      *
@@ -57 +58 @@
      *                                enqueued in places where block styles are needed.
      *     @type bool   $is_default   Whether this is the default style for the block type.
+     *     @type array  $style_data   Theme.json-like object to generate CSS from.
      * }
      * @return bool True if the block style was registered with success and false otherwise.
@@ -62 +64 @@
     public function register( $block_name, $style_properties ) {
 
-        if ( ! isset( $block_name ) || ! is_string( $block_name ) ) {
-            _doing_it_wrong(
-                __METHOD__,
-                __( 'Block name must be a string.' ),
-                '5.3.0'
+        if ( ! is_string( $block_name ) && ! is_array( $block_name ) ) {
+            _doing_it_wrong(
+                __METHOD__,
+                __( 'Block name must be a string or array.' ),
+                '6.6.0'
             );
             return false;
@@ -90 +92 @@
 
         $block_style_name = $style_properties['name'];
-
-        if ( ! isset( $this->registered_block_styles[ $block_name ] ) ) {
-            $this->registered_block_styles[ $block_name ] = array();
-        }
-        $this->registered_block_styles[ $block_name ][ $block_style_name ] = $style_properties;
+        $block_names      = is_string( $block_name ) ? array( $block_name ) : $block_name;
+
+        foreach ( $block_names as $name ) {
+            if ( ! isset( $this->registered_block_styles[ $name ] ) ) {
+                $this->registered_block_styles[ $name ] = array();
+            }
+            $this->registered_block_styles[ $name ][ $block_style_name ] = $style_properties;
+        }
 
         return true;