Changeset 59418

Timestamp:

11/19/2024 04:42:17 AM (2 months ago)

Author:

ramonopoly

Message:

Theme JSON: include block style variations in path only output of get_block_nodes

An $include_node_paths_only option to get_block_nodes() was introduced to improve performance.

When set to true, this option tells the function to only return paths, and not selectors, for consumers that only needed paths to style values.

For one of the conditional blocks, block style variations wasn't included.

This commit adds them to the array of paths following the existing model $node[]['path' => [], 'variations' => ['path' => []]].

Follow-up to [61858].

Props aaronrobertshaw, ramonopoly.
Fixes #62399.

Location:

trunk

Files:

• src/wp-includes/class-wp-theme-json.php (modified) (1 diff)
• tests/phpunit/tests/theme/wpThemeJson.php (modified) (1 diff)

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

@@ -2723 +2723 @@
             $node_path = array( 'styles', 'blocks', $name );
             if ( $include_node_paths_only ) {
-                $nodes[] = array(
+                $variation_paths = array();
+                if ( $include_variations && isset( $node['variations'] ) ) {
+                    foreach ( $node['variations'] as $variation => $variation_node ) {
+                        $variation_paths[] = array(
+                            'path' => array( 'styles', 'blocks', $name, 'variations', $variation ),
+                        );
+                    }
+                }
+                $node = array(
                     'path' => $node_path,
                 );
+                if ( ! empty( $variation_paths ) ) {
+                    $node['variations'] = $variation_paths;
+                }
+                $nodes[] = $node;
             } else {
                 $selector = null;

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

@@ -2497 +2497 @@
             array(
                 'path' => array( 'styles', 'blocks', 'core/group', 'elements', 'link' ),
+            ),
+        );
+
+        $this->assertEquals( $expected, $block_nodes );
+    }
+
+    /**
+     * This test covers `get_block_nodes` with the `$include_node_paths_only`
+     * and `include_block_style_variations` options.
+     *
+     * @ticket 62399
+     */
+    public function test_return_block_node_paths_with_variations() {
+        $theme_json = new ReflectionClass( 'WP_Theme_JSON' );
+
+        $func = $theme_json->getMethod( 'get_block_nodes' );
+        $func->setAccessible( true );
+
+        $theme_json = array(
+            'version' => WP_Theme_JSON::LATEST_SCHEMA,
+            'styles'  => array(
+                'typography' => array(
+                    'fontSize' => '16px',
+                ),
+                'blocks'     => array(
+                    'core/button' => array(
+                        'color'      => array(
+                            'background' => 'red',
+                        ),
+                        'variations' => array(
+                            'cheese' => array(
+                                'color' => array(
+                                    'background' => 'cheese',
+                                ),
+                            ),
+                        ),
+                    ),
+                    'core/group'  => array(
+                        'color'      => array(
+                            'background' => 'blue',
+                        ),
+                        'variations' => array(
+                            'apricot' => array(
+                                'color' => array(
+                                    'background' => 'apricot',
+                                ),
+                            ),
+                        ),
+                    ),
+                ),
+            ),
+        );
+
+        $block_nodes = $func->invoke(
+            null,
+            $theme_json,
+            array(),
+            array(
+                'include_node_paths_only'        => true,
+                'include_block_style_variations' => true,
+            )
+        );
+
+        $expected = array(
+            array(
+                'path'       => array( 'styles', 'blocks', 'core/button' ),
+                'variations' => array(
+                    array(
+                        'path' => array( 'styles', 'blocks', 'core/button', 'variations', 'cheese' ),
+                    ),
+                ),
+            ),
+            array(
+                'path'       => array( 'styles', 'blocks', 'core/group' ),
+                'variations' => array(
+                    array(
+                        'path' => array( 'styles', 'blocks', 'core/group', 'variations', 'apricot' ),
+                    ),
+                ),
             ),
         );