Changeset 55912

Timestamp:

06/14/2023 07:40:50 AM (20 months ago)

Author:

oandregal

Message:

Ignore unregistered block style variations from theme.json.

This PR makes sure unregistered block style variations declared via theme.json are ignored. It fixes an issue by style variations don't work in the editor and CSS rules without a selector are output to the front-end.

Props isabel_brison.
Fixes #58462.

Location:

trunk

Files:

• src/wp-includes/class-wp-theme-json.php (modified) (4 diffs)
• tests/phpunit/tests/theme/wpThemeJson.php (modified) (5 diffs)

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

@@ -590 +590 @@
         $valid_block_names   = array_keys( static::get_blocks_metadata() );
         $valid_element_names = array_keys( static::ELEMENTS );
-        $theme_json          = static::sanitize( $this->theme_json, $valid_block_names, $valid_element_names );
-        $this->theme_json    = static::maybe_opt_in_into_settings( $theme_json );
+        $valid_variations    = array();
+        foreach ( self::get_blocks_metadata() as $block_name => $block_meta ) {
+            if ( ! isset( $block_meta['styleVariations'] ) ) {
+                continue;
+            }
+            $valid_variations[ $block_name ] = array_keys( $block_meta['styleVariations'] );
+        }
+        $theme_json       = static::sanitize( $this->theme_json, $valid_block_names, $valid_element_names, $valid_variations );
+        $this->theme_json = static::maybe_opt_in_into_settings( $theme_json );
 
         // Internally, presets are keyed by origin.
@@ -669 +676 @@
      * @param array $valid_block_names   List of valid block names.
      * @param array $valid_element_names List of valid element names.
+     * @param array $valid_variations List of valid variations per block.
      * @return array The sanitized output.
      */
-    protected static function sanitize( $input, $valid_block_names, $valid_element_names ) {
+    protected static function sanitize( $input, $valid_block_names, $valid_element_names, $valid_variations ) {
 
         $output = array();
@@ -729 +737 @@
             if (
                 ! empty( $input['styles']['blocks'][ $block ]['variations'] ) &&
-                is_array( $input['styles']['blocks'][ $block ]['variations'] )
+                is_array( $input['styles']['blocks'][ $block ]['variations'] ) &&
+                isset( $valid_variations[ $block ] )
             ) {
-                $style_variation_names = array_keys( $input['styles']['blocks'][ $block ]['variations'] );
+                $style_variation_names = array_intersect(
+                    array_keys( $input['styles']['blocks'][ $block ]['variations'] ),
+                    $valid_variations[ $block ]
+                );
             }
 
@@ -2853 +2865 @@
         $valid_block_names   = array_keys( static::get_blocks_metadata() );
         $valid_element_names = array_keys( static::ELEMENTS );
-
-        $theme_json = static::sanitize( $theme_json, $valid_block_names, $valid_element_names );
+        $valid_variations    = array();
+        foreach ( self::get_blocks_metadata() as $block_name => $block_meta ) {
+            if ( ! isset( $block_meta['styleVariations'] ) ) {
+                continue;
+            }
+            $valid_variations[ $block_name ] = array_keys( $block_meta['styleVariations'] );
+        }
+
+        $theme_json = static::sanitize( $theme_json, $valid_block_names, $valid_element_names, $valid_variations );
 
         $blocks_metadata = static::get_blocks_metadata();

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

@@ -3699 +3699 @@
     }
 
+    /*
+     * @ticket 58462
+     */
+    public function test_sanitize_for_unregistered_style_variations() {
+        $theme_json = new WP_Theme_JSON(
+            array(
+                'version' => 2,
+                'styles'  => array(
+                    'blocks' => array(
+                        'core/quote' => array(
+                            'variations' => array(
+                                'unregisteredVariation' => array(
+                                    'color' => array(
+                                        'background' => 'hotpink',
+                                    ),
+                                ),
+                                'plain'                 => array(
+                                    'color' => array(
+                                        'background' => 'hotpink',
+                                    ),
+                                ),
+                            ),
+                        ),
+                    ),
+                ),
+            )
+        );
+
+        $sanitized_theme_json = $theme_json->get_raw_data();
+        $expected             = array(
+            'version' => 2,
+            'styles'  => array(
+                'blocks' => array(
+                    'core/quote' => array(
+                        'variations' => array(
+                            'plain' => array(
+                                'color' => array(
+                                    'background' => 'hotpink',
+                                ),
+                            ),
+                        ),
+                    ),
+                ),
+            ),
+        );
+        $this->assertSameSetsWithIndex( $expected, $sanitized_theme_json, 'Sanitized theme.json styles does not match' );
+    }
+
     /**
      * @ticket 57583
@@ -3733 +3781 @@
     public function data_sanitize_for_block_with_style_variations() {
         return array(
-            '1 variation with 1 invalid property'   => array(
+            '1 variation with 1 valid property'     => array(
                 'theme_json_variations' => array(
                     'variations' => array(
@@ -3783 +3831 @@
                 ),
             ),
-            '2 variations with 1 invalid property'  => array(
-                'theme_json_variations' => array(
-                    'variations' => array(
-                        'plain' => array(
-                            'color'            => array(
-                                'background' => 'hotpink',
-                            ),
-                            'invalidProperty1' => 'value1',
-                        ),
-                        'basic' => array(
-                            'color' => array(
-                                'background' => '#ffffff',
-                                'text'       => '#000000',
-                            ),
-                            'foo'   => 'bar',
-                        ),
-                    ),
-                ),
-                'expected_sanitized'    => array(
-                    'blocks' => array(
-                        'core/quote' => array(
-                            'variations' => array(
-                                'plain' => array(
-                                    'color' => array(
-                                        'background' => 'hotpink',
-                                    ),
-                                ),
-                                'basic' => array(
-                                    'color' => array(
-                                        'background' => '#ffffff',
-                                        'text'       => '#000000',
-                                    ),
-                                ),
-                            ),
-                        ),
-                    ),
-                ),
-            ),
         );
     }
@@ -3913 +3923 @@
             ),
             'styles'   => '.is-style-plain.is-style-plain.wp-block-quote{background-color: hotpink;}',
-        );
-        $basic = array(
-            'metadata' => array(
-                'path'     => array( 'styles', 'blocks', 'core/quote', 'variations', 'basic' ),
-                'selector' => '.is-style-basic.is-style-basic.wp-block-quote',
-            ),
-            'styles'   => '.is-style-basic.is-style-basic.wp-block-quote{background-color: #ffffff;color: #000000;}',
         );
 
@@ -3950 +3953 @@
                 'metadata_variation'    => array( $plain['metadata'] ),
                 'expected'              => $plain['styles'],
-            ),
-            '2 variations with 1 invalid property'  => array(
-                'theme_json_variations' => array(
-                    'variations' => array(
-                        'plain' => array(
-                            'color'            => array(
-                                'background' => 'hotpink',
-                            ),
-                            'invalidProperty1' => 'value1',
-                        ),
-                        'basic' => array(
-                            'color' => array(
-                                'background' => '#ffffff',
-                                'text'       => '#000000',
-                            ),
-                            'foo'   => 'bar',
-                        ),
-                    ),
-                ),
-                'metadata_variation'    => array( $plain['metadata'], $basic['metadata'] ),
-                'expected_styles'       => $plain['styles'] . $basic['styles'],
-            ),
-            '2 variations with multiple invalid properties' => array(
-                'theme_json_variations' => array(
-                    'variations' => array(
-                        'plain' => array(
-                            'color'            => array(
-                                'background' => 'hotpink',
-                            ),
-                            'invalidProperty1' => 'value1',
-                            'invalidProperty2' => 'value2',
-                        ),
-                        'basic' => array(
-                            'foo'   => 'foo',
-                            'color' => array(
-                                'background' => '#ffffff',
-                                'text'       => '#000000',
-                            ),
-                            'bar'   => 'bar',
-                            'baz'   => 'baz',
-                        ),
-                    ),
-                ),
-                'metadata_variation'    => array( $plain['metadata'], $basic['metadata'] ),
-                'expected_styles'       => $plain['styles'] . $basic['styles'],
             ),
         );