Changeset 58466 for trunk/src/wp-includes/class-wp-theme-json.php

Timestamp:

06/24/2024 08:49:52 AM (13 months 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.

File:

• trunk/src/wp-includes/class-wp-theme-json.php (modified) (4 diffs)

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 spacingSizes from spacingScale.
+     *              Added unwrapping of shared block style variations into block type variations if registered.
      *
      * @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::unwrap_shared_block_style_variations( $this->theme_json, $valid_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 );
         }
+    }
+
+    /**
+     * Unwraps shared block style variations.
+     *
+     * It takes the shared variations (styles.variations.variationName) and
+     * applies them to all the blocks that have the given variation registered
+     * (styles.blocks.blockType.variations.variationName).
+     *
+     * For example, given the `core/paragraph` and `core/group` blocks have
+     * registered the `section-a` style variation, and given the following input:
+     *
+     * {
+     *   "styles": {
+     *     "variations": {
+     *       "section-a": { "color": { "background": "backgroundColor" } }
+     *     }
+     *   }
+     * }
+     *
+     * It returns the following output:
+     *
+     * {
+     *   "styles": {
+     *     "blocks": {
+     *       "core/paragraph": {
+     *         "variations": {
+     *             "section-a": { "color": { "background": "backgroundColor" } }
+     *         },
+     *       },
+     *       "core/group": {
+     *         "variations": {
+     *           "section-a": { "color": { "background": "backgroundColor" } }
+     *         }
+     *       }
+     *     }
+     *   }
+     * }
+     *
+     * @since 6.6.0
+     *
+     * @param array $theme_json       A structure that follows the theme.json schema.
+     * @param array $valid_variations Valid block style variations.
+     * @return array Theme json data with shared variation definitions unwrapped under appropriate block types.
+     */
+    private static function unwrap_shared_block_style_variations( $theme_json, $valid_variations ) {
+        if ( empty( $theme_json['styles']['variations'] ) || empty( $valid_variations ) ) {
+            return $theme_json;
+        }
+
+        $new_theme_json = $theme_json;
+        $variations     = $new_theme_json['styles']['variations'];
+
+        foreach ( $valid_variations as $block_type => $registered_variations ) {
+            foreach ( $registered_variations as $variation_name ) {
+                $block_level_data = $new_theme_json['styles']['blocks'][ $block_type ]['variations'][ $variation_name ] ?? array();
+                $top_level_data   = $variations[ $variation_name ] ?? array();
+                $merged_data      = array_replace_recursive( $top_level_data, $block_level_data );
+                if ( ! empty( $merged_data ) ) {
+                    _wp_array_set( $new_theme_json, array( 'styles', 'blocks', $block_type, 'variations', $variation_name ), $merged_data );
+                }
+            }
+        }
+
+        unset( $new_theme_json['styles']['variations'] );
+
+        return $new_theme_json;
     }
 
@@ -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.