From d0a190b65cebe27652e1a4d8d38a714d624e54ad Mon Sep 17 00:00:00 2001
From: Ramon <ramonjd@users.noreply.github.com>
Date: Thu, 14 Nov 2024 09:59:02 +1100
Subject: [PATCH] Theme JSON: include block style variations in path only
output of get_block_nodes (#66948)
Follow up to https://github.com/WordPress/gutenberg/pull/66002
Including variations in the nodes array when 'include_node_paths_only' => true
Co-authored-by: ramonjd <ramonopoly@git.wordpress.org>
Co-authored-by: aaronrobertshaw <aaronrobertshaw@git.wordpress.org>
---
backport-changelog/6.8/7784.md | 3 ++
lib/class-wp-theme-json-gutenberg.php | 14 ++++-
phpunit/class-wp-theme-json-test.php | 77 +++++++++++++++++++++++++++
3 files changed, 93 insertions(+), 1 deletion(-)
create mode 100644 backport-changelog/6.8/7784.md
diff --git a/backport-changelog/6.8/7784.md b/backport-changelog/6.8/7784.md
new file mode 100644
index 0000000000000..b18dca88112a7
--- /dev/null
+++ b/backport-changelog/6.8/7784.md
@@ -0,0 +1,3 @@
+https://github.com/WordPress/wordpress-develop/pull/7784
+
+* https://github.com/WordPress/gutenberg/pull/66948
diff --git a/lib/class-wp-theme-json-gutenberg.php b/lib/class-wp-theme-json-gutenberg.php
index d505916450caf..10f80c3f3cdb7 100644
--- a/lib/class-wp-theme-json-gutenberg.php
+++ b/lib/class-wp-theme-json-gutenberg.php
@@ -2749,9 +2749,21 @@ private static function get_block_nodes( $theme_json, $selectors = array(), $opt
foreach ( $theme_json['styles']['blocks'] as $name => $node ) {
$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;
if ( isset( $selectors[ $name ]['selector'] ) ) {
diff --git a/phpunit/class-wp-theme-json-test.php b/phpunit/class-wp-theme-json-test.php
index f77086cf0dd04..1aacb92759e59 100644
--- a/phpunit/class-wp-theme-json-test.php
+++ b/phpunit/class-wp-theme-json-test.php
@@ -5955,4 +5955,81 @@ public function test_return_block_node_paths() {
$this->assertEquals( $expected, $block_nodes );
}
+
+ /**
+ * This test covers `get_block_nodes` with the `$include_node_paths_only`
+ * and `include_block_style_variations` options.
+ */
+ public function test_return_block_node_paths_with_variations() {
+ $theme_json = new ReflectionClass( 'WP_Theme_JSON_Gutenberg' );
+
+ $func = $theme_json->getMethod( 'get_block_nodes' );
+ $func->setAccessible( true );
+
+ $theme_json = array(
+ 'version' => WP_Theme_JSON_Gutenberg::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' ),
+ ),
+ ),
+ ),
+ );
+
+ $this->assertEquals( $expected, $block_nodes );
+ }
}