Changeset 58691 for trunk

Timestamp:

07/09/2024 10:22:10 AM (19 months ago)

Author:

ellatrix

Message:

Section Styles: Fix ref values within block style variations.

Fixes #61589.
Fixes ​https://github.com/WordPress/wordpress-develop/pull/6989.
See ​https://github.com/WordPress/gutenberg/pull/63172.

Props aaronrobertshaw, andrewserong, ramonopoly.

Location:

trunk

Files:

• src/wp-includes/block-supports/block-style-variations.php (modified) (2 diffs)
• tests/phpunit/tests/block-supports/block-style-variations.php (modified) (1 diff)

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

@@ -41 +41 @@
 }
 
+/**
+ * Recursively resolves any `ref` values within a block style variation's data.
+ *
+ * @since 6.6.0
+ * @access private
+ *
+ * @param array $variation_data Reference to the variation data being processed.
+ * @param array $theme_json     Theme.json data to retrieve referenced values from.
+ */
+function wp_resolve_block_style_variation_ref_values( &$variation_data, $theme_json ) {
+    foreach ( $variation_data as $key => &$value ) {
+        // Only need to potentially process arrays.
+        if ( is_array( $value ) ) {
+            // If ref value is set, attempt to find its matching value and update it.
+            if ( array_key_exists( 'ref', $value ) ) {
+                // Clean up any invalid ref value.
+                if ( empty( $value['ref'] ) || ! is_string( $value['ref'] ) ) {
+                    unset( $variation_data[ $key ] );
+                }
+
+                $value_path = explode( '.', $value['ref'] ?? '' );
+                $ref_value  = _wp_array_get( $theme_json, $value_path );
+
+                // Only update the current value if the referenced path matched a value.
+                if ( null === $ref_value ) {
+                    unset( $variation_data[ $key ] );
+                } else {
+                    $value = $ref_value;
+                }
+            } else {
+                // Recursively look for ref instances.
+                wp_resolve_block_style_variation_ref_values( $value, $theme_json );
+            }
+        }
+    }
+}
 /**
  * Render the block style variation's styles.
@@ -82 +118 @@
         return $parsed_block;
     }
+
+    /*
+     * Recursively resolve any ref values with the appropriate value within the
+     * theme_json data.
+     */
+    wp_resolve_block_style_variation_ref_values( $variation_data, $theme_json );
 
     $variation_instance = wp_create_block_style_variation_instance_name( $parsed_block, $variation );

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

@@ -160 +160 @@
         $this->assertSameSetsWithIndex( $expected, $group_styles, 'Variation data does not match' );
     }
+
+    /**
+     * Tests that block style variations resolve any `ref` values when generating styles.
+     *
+     * @ticket 61589
+     */
+    public function test_block_style_variation_ref_values() {
+        switch_theme( 'block-theme' );
+
+        $variation_data = array(
+            'color'    => array(
+                'text'       => array(
+                    'ref' => 'styles.does-not-exist',
+                ),
+                'background' => array(
+                    'ref' => 'styles.blocks.core/group.variations.block-style-variation-a.color.text',
+                ),
+            ),
+            'blocks'   => array(
+                'core/heading' => array(
+                    'color' => array(
+                        'text'       => array(
+                            'ref' => 'styles.blocks.core/group.variations.block-style-variation-a.color.background',
+                        ),
+                        'background' => array(
+                            'ref' => '',
+                        ),
+                    ),
+                ),
+            ),
+            'elements' => array(
+                'link' => array(
+                    'color'  => array(
+                        'text'       => array(
+                            'ref' => 'styles.blocks.core/group.variations.block-style-variation-b.color.text',
+                        ),
+                        'background' => array(
+                            'ref' => null,
+                        ),
+                    ),
+                    ':hover' => array(
+                        'color' => array(
+                            'text' => array(
+                                'ref' => 'styles.blocks.core/group.variations.block-style-variation-b.color.background',
+                            ),
+                        ),
+                    ),
+                ),
+            ),
+        );
+
+        $theme_json = WP_Theme_JSON_Resolver::get_theme_data()->get_raw_data();
+
+        wp_resolve_block_style_variation_ref_values( $variation_data, $theme_json );
+
+        $expected = array(
+            'color'    => array( 'background' => 'plum' ),
+            'blocks'   => array(
+                'core/heading' => array(
+                    'color' => array( 'text' => 'indigo' ),
+                ),
+            ),
+            'elements' => array(
+                'link' => array(
+                    'color'  => array( 'text' => 'lightblue' ),
+                    ':hover' => array(
+                        'color' => array( 'text' => 'midnightblue' ),
+                    ),
+                ),
+            ),
+        );
+
+        $this->assertSameSetsWithIndex( $expected, $variation_data, 'Variation data with resolved ref values does not match' );
+    }
 }