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

Timestamp:

06/17/2024 09:42:57 AM (2 years ago)

Author:

oandregal

Message:

Global styles: prevent duplicate CSS for block style variations.

Props aaronrobertshaw, mukesh27, ramonopoly, isabel_brison, oandregal.
Fixes #61443.

File:

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

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

@@ -751 +751 @@
          *                           One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.
          */
-        public function __construct( $theme_json = array( 'version' => WP_Theme_JSON::LATEST_SCHEMA ), $origin = 'theme' ) {
+        public function __construct( $theme_json = array( 'version' => self::LATEST_SCHEMA ), $origin = 'theme' ) {
                 if ( ! in_array( $origin, static::VALID_ORIGINS, true ) ) {
                         $origin = 'theme';
@@ -1248 +1248 @@
          * @since 5.9.0 Removed the `$type` parameter, added the `$types` and `$origins` parameters.
          * @since 6.3.0 Add fallback layout styles for Post Template when block gap support isn't available.
-         * @since 6.6.0 Added `skip_root_layout_styles` option to omit layout styles if desired.
+         * @since 6.6.0 Added boolean `skip_root_layout_styles` and `include_block_style_variations` options
+         *              to control styles output as desired.
          *
          * @param string[] $types   Types of styles to load. Will load all by default. It accepts:
@@ -1258 +1259 @@
          *     Optional. An array of options for now used for internal purposes only (may change without notice).
          *
-         *     @type string $scope                   Makes sure all style are scoped to a given selector
-         *     @type string $root_selector           Overwrites and forces a given selector to be used on the root node
-         *     @type bool   $skip_root_layout_styles Omits root layout styles from the generated stylesheet. Default false.
+         *     @type string $scope                           Makes sure all style are scoped to a given selector
+         *     @type string $root_selector                   Overwrites and forces a given selector to be used on the root node
+         *     @type bool   $skip_root_layout_styles         Omits root layout styles from the generated stylesheet. Default false.
+         *     @type bool   $include_block_style_variations  Includes styles for block style variations in the generated stylesheet. Default false.
          * }
          * @return string The resulting stylesheet.
@@ -1282 +1284 @@
 
                 $blocks_metadata = static::get_blocks_metadata();
-                $style_nodes     = static::get_style_nodes( $this->theme_json, $blocks_metadata );
+                $style_nodes     = static::get_style_nodes( $this->theme_json, $blocks_metadata, $options );
                 $setting_nodes   = static::get_setting_nodes( $this->theme_json, $blocks_metadata );
 
@@ -2447 +2449 @@
          *
          * @since 5.8.0
+         * @since 6.6.0 Added options array for modifying generated nodes.
          *
          * @param array $theme_json The tree to extract style nodes from.
          * @param array $selectors  List of selectors per block.
+         * @param array $options {
+         *     Optional. An array of options for now used for internal purposes only (may change without notice).
+         *
+         *     @type bool $include_block_style_variations Includes style nodes for block style variations. Default false.
+         * }
          * @return array An array of style nodes metadata.
          */
-        protected static function get_style_nodes( $theme_json, $selectors = array() ) {
+        protected static function get_style_nodes( $theme_json, $selectors = array(), $options = array() ) {
                 $nodes = array();
                 if ( ! isset( $theme_json['styles'] ) ) {
@@ -2494 +2502 @@
                 }
 
-                $block_nodes = static::get_block_nodes( $theme_json );
+                $block_nodes = static::get_block_nodes( $theme_json, $selectors, $options );
                 foreach ( $block_nodes as $block_node ) {
                         $nodes[] = $block_node;
@@ -2565 +2573 @@
          * @since 6.1.0
          * @since 6.3.0 Refactored and stabilized selectors API.
+         * @since 6.6.0 Added optional selectors and options for generating block nodes.
          *
          * @param array $theme_json The theme.json converted to an array.
+         * @param array $selectors  Optional list of selectors per block.
+         * @param array $options {
+         *     Optional. An array of options for now used for internal purposes only (may change without notice).
+         *
+         *     @type bool   $include_block_style_variations  Includes nodes for block style variations. Default false.
+         * }
          * @return array The block nodes in theme.json.
          */
-        private static function get_block_nodes( $theme_json ) {
-                $selectors = static::get_blocks_metadata();
+        private static function get_block_nodes( $theme_json, $selectors = array(), $options = array() ) {
+                $selectors = empty( $selectors ) ? static::get_blocks_metadata() : $selectors;
                 $nodes     = array();
                 if ( ! isset( $theme_json['styles'] ) ) {
@@ -2598 +2613 @@
 
                         $variation_selectors = array();
-                        if ( isset( $node['variations'] ) ) {
+                        $include_variations  = $options['include_block_style_variations'] ?? false;
+                        if ( $include_variations && isset( $node['variations'] ) ) {
                                 foreach ( $node['variations'] as $variation => $node ) {
                                         $variation_selectors[] = array(
@@ -3281 +3297 @@
 
                 $blocks_metadata = static::get_blocks_metadata();
-                $style_nodes     = static::get_style_nodes( $theme_json, $blocks_metadata );
+                $style_options   = array( 'include_block_style_variations' => true ); // Allow variations data.
+                $style_nodes     = static::get_style_nodes( $theme_json, $blocks_metadata, $style_options );
 
                 foreach ( $style_nodes as $metadata ) {