Changeset 58466

Timestamp:

06/24/2024 08:49:52 AM (5 weeks ago)

Author:

oandregal

Message:

Section styles: improve performance and conceptual consistency.

These changes involve:

• Move shared variation definitions from styles.blocks.variations to styles.variations
• Remove blockTypes from styles.variations.
• Do not register shared variations from theme style variation or primary theme.json files.
• Move the merging of theme.json data into the WP_Theme_JSON_Resolver and WP_Theme_JSON classes.

These changes improve performance and are more future-proof API wise.
See conversation at ​https://github.com/WordPress/gutenberg/issues/62686

Props aaronrobertshaw, oandregal, andrewserong, joemcgill, talldanwp, andrewserong, ramonopoly, richtabor, youknowriad.

See #61312, #61451.

Location:

trunk

Files:

• src/wp-includes/block-supports/block-style-variations.php (modified) (3 diffs)
• src/wp-includes/class-wp-theme-json-resolver.php (modified) (5 diffs)
• src/wp-includes/class-wp-theme-json.php (modified) (4 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php (modified) (2 diffs)
• src/wp-includes/theme-i18n.json (modified) (1 diff)
• tests/phpunit/data/themedir1/block-theme-child-with-block-style-variations/theme.json (modified) (1 diff)
• tests/phpunit/tests/block-supports/block-style-variations.php (modified) (4 diffs)
• tests/phpunit/tests/rest-api/rest-global-styles-controller.php (modified) (3 diffs)
• tests/phpunit/tests/theme/wpThemeJson.php (modified) (1 diff)
• tests/phpunit/tests/theme/wpThemeJsonResolver.php (modified) (1 diff)

trunk/src/wp-includes/block-supports/block-style-variations.php

@@ -214 +214 @@
 
 /**
- * Collects block style variation data for merging with theme.json data.
- *
- * @since 6.6.0
- * @access private
- *
- * @param array $variations Shared block style variations.
- *
- * @return array Block variations data to be merged under `styles.blocks`.
- */
-function wp_resolve_block_style_variations( $variations ) {
-    $variations_data = array();
-
-    if ( empty( $variations ) ) {
-        return $variations_data;
-    }
-
-    $have_named_variations = ! wp_is_numeric_array( $variations );
-
-    foreach ( $variations as $key => $variation ) {
-        $supported_blocks = $variation['blockTypes'] ?? array();
-
-        /*
-         * Standalone theme.json partial files for block style variations
-         * will have their styles under a top-level property by the same name.
-         * Variations defined within an existing theme.json or theme style
-         * variation will themselves already be the required styles data.
-         */
-        $variation_data = $variation['styles'] ?? $variation;
-
-        if ( empty( $variation_data ) ) {
-            continue;
-        }
-
-        /*
-         * Block style variations read in via standalone theme.json partials
-         * need to have their name set to the kebab case version of their title.
-         */
-        $variation_name = $have_named_variations ? $key : ( $variation['slug'] ?? _wp_to_kebab_case( $variation['title'] ) );
-
-        foreach ( $supported_blocks as $block_type ) {
-            // Add block style variation data under current block type.
-            $path = array( $block_type, 'variations', $variation_name );
-            _wp_array_set( $variations_data, $path, $variation_data );
-        }
-    }
-
-    return $variations_data;
-}
-
-/**
- * Merges variations data with existing theme.json data ensuring that the
- * current theme.json data values take precedence.
- *
- * @since 6.6.0
- * @access private
- *
- * @param array              $variations_data Block style variations data keyed by block type.
- * @param WP_Theme_JSON_Data $theme_json      Current theme.json data.
- * @param string             $origin          Origin for the theme.json data.
- *
- * @return WP_Theme_JSON The merged theme.json data.
- */
-function wp_merge_block_style_variations_data( $variations_data, $theme_json, $origin = 'theme' ) {
-    if ( empty( $variations_data ) ) {
-        return $theme_json;
-    }
-
-    $variations_theme_json_data = array(
-        'version' => WP_Theme_JSON::LATEST_SCHEMA,
-        'styles'  => array( 'blocks' => $variations_data ),
-    );
-
-    $variations_theme_json = new WP_Theme_JSON_Data( $variations_theme_json_data, $origin );
-
-    /*
-     * Merge the current theme.json data over shared variation data so that
-     * any explicit per block variation values take precedence.
-     */
-    return $variations_theme_json->update_with( $theme_json->get_data() );
-}
-
-/**
- * Merges any shared block style variation definitions from a theme style
- * variation into their appropriate block type within theme json styles. Any
- * custom user selections already made will take precedence over the shared
- * style variation value.
- *
- * @since 6.6.0
- * @access private
- *
- * @param WP_Theme_JSON_Data $theme_json Current theme.json data.
- *
- * @return WP_Theme_JSON_Data
- */
-function wp_resolve_block_style_variations_from_theme_style_variation( $theme_json ) {
-    $theme_json_data   = $theme_json->get_data();
-    $shared_variations = $theme_json_data['styles']['blocks']['variations'] ?? array();
-    $variations_data   = wp_resolve_block_style_variations( $shared_variations );
-
-    return wp_merge_block_style_variations_data( $variations_data, $theme_json, 'user' );
-}
-
-/**
- * Merges block style variation data sourced from standalone partial
- * theme.json files.
- *
- * @since 6.6.0
- * @access private
- *
- * @param WP_Theme_JSON_Data $theme_json Current theme.json data.
- *
- * @return WP_Theme_JSON_Data
- */
-function wp_resolve_block_style_variations_from_theme_json_partials( $theme_json ) {
-    $block_style_variations = WP_Theme_JSON_Resolver::get_style_variations( 'block' );
-    $variations_data        = wp_resolve_block_style_variations( $block_style_variations );
-
-    return wp_merge_block_style_variations_data( $variations_data, $theme_json );
-}
-
-/**
- * Merges shared block style variations registered within the
- * `styles.blocks.variations` property of the primary theme.json file.
- *
- * @since 6.6.0
- * @access private
- *
- * @param WP_Theme_JSON_Data $theme_json Current theme.json data.
- *
- * @return WP_Theme_JSON_Data
- */
-function wp_resolve_block_style_variations_from_primary_theme_json( $theme_json ) {
-    $theme_json_data        = $theme_json->get_data();
-    $block_style_variations = $theme_json_data['styles']['blocks']['variations'] ?? array();
-    $variations_data        = wp_resolve_block_style_variations( $block_style_variations );
-
-    return wp_merge_block_style_variations_data( $variations_data, $theme_json );
-}
-
-/**
- * Merges block style variations registered via the block styles registry with a
- * style object, under their appropriate block types within theme.json styles.
- * Any variation values defined within the theme.json specific to a block type
- * will take precedence over these shared definitions.
- *
- * @since 6.6.0
- * @access private
- *
- * @param WP_Theme_JSON_Data $theme_json Current theme.json data.
- *
- * @return WP_Theme_JSON_Data
- */
-function wp_resolve_block_style_variations_from_styles_registry( $theme_json ) {
-    $registry        = WP_Block_Styles_Registry::get_instance();
-    $styles          = $registry->get_all_registered();
-    $variations_data = array();
-
-    foreach ( $styles as $block_type => $variations ) {
-        foreach ( $variations as $variation_name => $variation ) {
-            if ( ! empty( $variation['style_data'] ) ) {
-                $path = array( $block_type, 'variations', $variation_name );
-                _wp_array_set( $variations_data, $path, $variation['style_data'] );
-            }
-        }
-    }
-
-    return wp_merge_block_style_variations_data( $variations_data, $theme_json );
-}
-
-/**
  * Enqueues styles for block style variations.
  *
@@ -400 +230 @@
 add_action( 'wp_enqueue_scripts', 'wp_enqueue_block_style_variation_styles', 1 );
 
-// Resolve block style variations from all their potential sources. The order here is deliberate.
-add_filter( 'wp_theme_json_data_theme', 'wp_resolve_block_style_variations_from_primary_theme_json', 10, 1 );
-add_filter( 'wp_theme_json_data_theme', 'wp_resolve_block_style_variations_from_theme_json_partials', 10, 1 );
-add_filter( 'wp_theme_json_data_theme', 'wp_resolve_block_style_variations_from_styles_registry', 10, 1 );
-
-add_filter( 'wp_theme_json_data_user', 'wp_resolve_block_style_variations_from_theme_style_variation', 10, 1 );
-
-/**
- * Registers any block style variations contained within the provided
- * theme.json data.
+/**
+ * Registers block style variations read in from theme.json partials.
  *
  * @since 6.6.0
@@ -416 +238 @@
  * @param array $variations Shared block style variations.
  */
-function wp_register_block_style_variations_from_theme_json_data( $variations ) {
+function wp_register_block_style_variations_from_theme_json_( $variations ) {
     if ( empty( $variations ) ) {
-        return $variations;
-    }
-
-    $registry              = WP_Block_Styles_Registry::get_instance();
-    $have_named_variations = ! wp_is_numeric_array( $variations );
-
-    foreach ( $variations as $key => $variation ) {
-        $supported_blocks = $variation['blockTypes'] ?? array();
-
-        /*
-         * Standalone theme.json partial files for block style variations
-         * will have their styles under a top-level property by the same name.
-         * Variations defined within an existing theme.json or theme style
-         * variation will themselves already be the required styles data.
-         */
-        $variation_data = $variation['styles'] ?? $variation;
-
-        if ( empty( $variation_data ) ) {
+        return;
+    }
+
+    $registry = WP_Block_Styles_Registry::get_instance();
+
+    foreach ( $variations as $variation ) {
+        if ( empty( $variation['blockTypes'] ) || empty( $variation['styles'] ) ) {
             continue;
         }
 
-        /*
-         * Block style variations read in via standalone theme.json partials
-         * need to have their name set to the kebab case version of their title.
-         */
-        $variation_name  = $have_named_variations ? $key : ( $variation['slug'] ?? _wp_to_kebab_case( $variation['title'] ) );
+        $variation_name  = $variation['slug'] ?? _wp_to_kebab_case( $variation['title'] );
         $variation_label = $variation['title'] ?? $variation_name;
 
-        foreach ( $supported_blocks as $block_type ) {
+        foreach ( $ as $block_type ) {
             $registered_styles = $registry->get_registered_styles_for_block( $block_type );
 

trunk/src/wp-includes/class-wp-theme-json-resolver.php

@@ -232 +232 @@
      * @since 6.0.0 Added an `$options` parameter to allow the theme data to be returned without theme supports.
      * @since 6.6.0 Add support for 'default-font-sizes' and 'default-spacing-sizes' theme supports.
-     *              Register the block style variations coming from the partials and the theme.json.
+     *              .
      *
      * @param array $deprecated Deprecated. Not used.
@@ -259 +259 @@
             }
 
-            // Register variations defined by the theme.
-            $variations = $theme_json_data['styles']['blocks']['variations'] ?? array();
-            wp_register_block_style_variations_from_theme_json_data( $variations );
-
-            // Register variations defined by theme partials (theme.json files in the styles directory).
+            /*
+             * Register variations defined by theme partials (theme.json files in the styles directory).
+             * This is required so the variations pass sanitization of theme.json data.
+             */
             $variations = static::get_style_variations( 'block' );
-            wp_register_block_style_variations_from_theme_json_data( $variations );
+            wp_register_block_style_variations_from_theme_json_partials( $variations );
+
+            /*
+             * Source variations from the block registry and block style variation files. Then, merge them into the existing theme.json data.
+             *
+             * In case the same style properties are defined in several sources, this is how we should resolve the values,
+             * from higher to lower priority:
+             *
+             * - styles.blocks.blockType.variations from theme.json
+             * - styles.variations from theme.json
+             * - variations from block style variation files
+             * - variations from block styles registry
+             *
+             * See test_add_registered_block_styles_to_theme_data and test_unwraps_block_style_variations.
+             *
+             */
+            $theme_json_data = static::inject_variations_from_block_style_variation_files( $theme_json_data, $variations );
+            $theme_json_data = static::inject_variations_from_block_styles_registry( $theme_json_data );
 
             /**
@@ -580 +596 @@
                 $config = $decoded_data;
             }
-
-            // Register variations defined by the user.
-            $variations = $config['styles']['blocks']['variations'] ?? array();
-            wp_register_block_style_variations_from_theme_json_data( $variations );
         }
 
@@ -886 +898 @@
      * @since 6.6.0
      *
-     * @param WP_Theme_JSON  $theme_json A theme json instance.
+     * @param WP_Theme_JSON $theme_json A theme json instance.
      * @return WP_Theme_JSON Theme merged with resolved paths, if any found.
      */
@@ -908 +920 @@
         return $theme_json;
     }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }

trunk/src/wp-includes/class-wp-theme-json.php

@@ -744 +744 @@
      *
      * @since 5.8.0
-     * @since 6.6.0 Key spacingScale by origin, and Pre-generate the
-     *              spacingSizes from spacingScale.
+     * @since 6.6.0 Key spacingScale by origin, and Pre-generate the
+     *              .
      *
      * @param array  $theme_json A structure that follows the theme.json schema.
@@ -760 +760 @@
         $valid_element_names = array_keys( static::ELEMENTS );
         $valid_variations    = static::get_valid_block_style_variations();
+
         $this->theme_json    = static::sanitize( $this->theme_json, $valid_block_names, $valid_element_names, $valid_variations );
         $this->theme_json    = static::maybe_opt_in_into_settings( $this->theme_json );
@@ -801 +802 @@
             _wp_array_set( $this->theme_json, $sizes_path, $merged_spacing_sizes );
         }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     }
 
@@ -967 +1035 @@
         $schema['settings']['blocks']                     = $schema_settings_blocks;
         $schema['settings']['typography']['fontFamilies'] = static::schema_in_root_and_per_origin( static::FONT_FAMILY_SCHEMA );
-
-        /*
-         * Shared block style variations can be registered from the theme.json data so we can't
-         * validate them against pre-registered block style variations.
-         */
-        $schema['styles']['blocks']['variations'] = null;
 
         // Remove anything that's not present in the schema.

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php

@@ -266 +266 @@
             }
 
-            // Register theme-defined variations.
-            WP_Theme_JSON_Resolver::get_theme_data();
-
-            // Register user-defined variations.
-            if ( ! empty( $config['styles']['blocks']['variations'] ) ) {
-                wp_register_block_style_variations_from_theme_json_data( $config['styles']['blocks']['variations'] );
-            }
+            // Register theme-defined variations e.g. from block style variation partials under `/styles`.
+            $variations = WP_Theme_JSON_Resolver::get_style_variations( 'block' );
+            wp_register_block_style_variations_from_theme_json_partials( $variations );
 
             if ( isset( $request['settings'] ) ) {
@@ -636 +632 @@
 
         $response   = array();
+
+
+
+
+
         $variations = WP_Theme_JSON_Resolver::get_style_variations();
-
         foreach ( $variations as $variation ) {
             $variation_theme_json = new WP_Theme_JSON( $variation );

trunk/src/wp-includes/theme-i18n.json

@@ -81 +81 @@
         }
     },
-    "styles": {
-        "blocks": {
-            "variations": {
-                "*": {
-                    "title": "Style variation name"
-                }
-            }
-        }
-    },
     "customTemplates": [
         {

trunk/tests/phpunit/data/themedir1/block-theme-child-with-block-style-variations/theme.json

@@ -1 +1 @@
 {
     "$schema": "https://schemas.wp.org/trunk/theme.json",
-    "version": 3
+    "version": 3,
+    "styles": {
+        "variations": {
+            "outline": {
+                "color": {
+                    "background": "green",
+                    "text": "white"
+                }
+            },
+            "block-style-variation-a": {
+                "color": {
+                    "background": "darkseagreen"
+                },
+                "typography": {
+                    "fontSize": "2em",
+                    "lineHeight": "1.4em"
+                }
+            }
+        },
+        "blocks": {
+            "core/button": {
+                "variations": {
+                    "outline": {
+                        "color": {
+                            "background": "red"
+                        }
+                    }
+                }
+            },
+            "core/media-text": {
+                "variations": {
+                    "block-style-variation-a": {
+                        "color": {
+                            "background": "blue"
+                        },
+                        "typography": {
+                            "fontSize": "1.5em"
+                        }
+                    }
+                }
+            },
+            "core/heading": {
+                "variations": {
+                    "block-style-variation-b": {
+                        "typography": {
+                            "fontSize": "3em"
+                        }
+                    }
+                }
+            }
+        }
+    }
 }

trunk/tests/phpunit/tests/block-supports/block-style-variations.php

@@ -63 +63 @@
      * @ticket 61312
      * @ticket 61440
+
      */
     public function test_add_registered_block_styles_to_theme_data() {
         switch_theme( 'block-theme' );
-
-        // Register theme-defined variations.
-        WP_Theme_JSON_Resolver::get_theme_data();
-        // Register user-defined variations.
-        WP_Theme_JSON_Resolver::get_user_data();
 
         $variation_styles_data = array(
@@ -126 +122 @@
         $expected     = array(
             'variations' => array(
-                // @ticket 61440
-                'WithSlug'                => array(
-                    'color' => array(
-                        'background' => 'aliceblue',
-                        'text'       => 'midnightblue',
-                    ),
-                ),
-                'my-variation'            => $variation_styles_data,
 
                 /*
@@ -152 +140 @@
                     ),
                 ),
+
+
+
+
+
+
+
+
+
+
+
+
             ),
         );
@@ -158 +158 @@
         unregister_block_style( 'core/group', 'WithSlug' );
 
-        $this->assertSameSetsWithIndex( $expected, $group_styles );
+        $this->assertSameSetsWithIndex( $expected, $group_styles );
     }
 }

trunk/tests/phpunit/tests/rest-api/rest-global-styles-controller.php

@@ -610 +610 @@
      * @covers WP_REST_Global_Styles_Controller_Gutenberg::update_item
      * @ticket 61312
+
      */
     public function test_update_item_with_custom_block_style_variations() {
@@ -616 +617 @@
             grant_super_admin( self::$admin_id );
         }
+
+
+
+
+
+
+
+
+
+
+
+
 
         $group_variations = array(
@@ -630 +643 @@
             array(
                 'styles' => array(
-                    'blocks' => array(
-                        'variations' => array(
-                            'fromThemeStyleVariation' => array(
-                                'blockTypes' => array( 'core/group', 'core/columns' ),
-                                'color'      => array(
-                                    'background' => '#000000',
-                                    'text'       => '#ffffff',
-                                ),
+                    'variations' => array(
+                        'fromThemeStyleVariation' => array(
+                            'blockTypes' => array( 'core/group', 'core/columns' ),
+                            'color'      => array(
+                                'background' => '#000000',
+                                'text'       => '#ffffff',
                             ),
                         ),
+
+
                         'core/group' => array(
                             'variations' => $group_variations,

trunk/tests/phpunit/tests/theme/wpThemeJson.php

@@ -3932 +3932 @@
 
     /**
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      * @ticket 57583
      *

trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php

@@ -1322 +1322 @@
         $this->assertSame( $expected_data, $actual );
     }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }