Changeset 57716

Timestamp:

02/27/2024 10:13:13 AM (9 months ago)

Author:

youknowriad

Message:

Editor: Check for null values in Theme JSON to cater for blockGap.

When resolving theme.json preset variables, add a check to make sure the value is not empty before we run it through strpos() and preg_match_all().

Props ramonopoly, mukesh27, get_dave.
Fixes #60613.

Location:

trunk

Files:

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

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

@@ -3858 +3858 @@
      *
      * @since 6.3.0
+     * @since 6.5.0 Check for empty style before processing its value.
+     *
      * @param array $styles CSS declarations to convert.
      * @param array $values key => value pairs to use for replacement.
@@ -3864 +3866 @@
     private static function convert_variables_to_value( $styles, $values ) {
         foreach ( $styles as $key => $style ) {
+            if ( empty( $style ) ) {
+                continue;
+            }
+
             if ( is_array( $style ) ) {
                 $styles[ $key ] = self::convert_variables_to_value( $style, $values );

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

@@ -5093 +5093 @@
     }
 
+    /**
+     * Tests that the theme.json file is correctly parsed and the variables are resolved.
+     *
+     * @ticket 58588
+     * @ticket 60613
+     *
+     * @covers WP_Theme_JSON_Gutenberg::resolve_variables
+     * @covers WP_Theme_JSON_Gutenberg::convert_variables_to_value
+     */
     public function test_resolve_variables() {
         $primary_color   = '#9DFF20';
@@ -5100 +5109 @@
         $large_font      = '18px';
         $small_font      = '12px';
+        $spacing         = 'clamp(1.5rem, 5vw, 2rem)';
         $theme_json      = new WP_Theme_JSON(
             array(
@@ -5136 +5146 @@
                                 'name' => 'Font size large',
                                 'slug' => 'large',
+                            ),
+                        ),
+                    ),
+                    'spacing'    => array(
+                        'spacingSizes' => array(
+                            array(
+                                'size' => $spacing,
+                                'name' => '100',
+                                'slug' => '100',
                             ),
                         ),
@@ -5201 +5220 @@
                             ),
                         ),
+                        'core/post-template'   => array(
+                            'spacing' => array(
+                                'blockGap' => null,
+                            ),
+                        ),
+                        'core/columns'         => array(
+                            'spacing' => array(
+                                'blockGap' => 'var(--wp--preset--spacing--100)',
+                            ),
+                        ),
                     ),
                 ),
@@ -5244 +5273 @@
         $this->assertEquals( $small_font, $styles['blocks']['core/quote']['variations']['plain']['typography']['fontSize'], 'Block variations: font-size' );
         $this->assertEquals( $secondary_color, $styles['blocks']['core/quote']['variations']['plain']['color']['background'], 'Block variations: color' );
+        /*
+         * As with wp_get_global_styles(), WP_Theme_JSON::resolve_variables may be called with merged data from
+         * WP_Theme_JSON_Resolver. WP_Theme_JSON_Resolver::get_block_data() sets blockGap for supported blocks to `null` if the value is not defined.
+         */
+        $this->assertNull(
+            $styles['blocks']['core/post-template']['spacing']['blockGap'],
+            'Blocks: Post Template spacing.blockGap should be null'
+        );
+        $this->assertEquals(
+            $spacing,
+            $styles['blocks']['core/columns']['spacing']['blockGap'],
+            'Blocks: Columns spacing.blockGap should match'
+        );
     }