Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ramonjd merged 4 commits into from
Nov 13, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cfb332b
Follow up to https://github.com/WordPress/gutenberg/pull/66002
ramonjd Nov 13, 2024
e018000
change inner loop var name
ramonjd Nov 13, 2024
b4944e0
changelog
ramonjd Nov 13, 2024
5a5a99b
linto
ramonjd Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions backport-changelog/6.8/7784.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
https://github.com/WordPress/wordpress-develop/pull/7784

* https://github.com/WordPress/gutenberg/pull/66948
14 changes: 13 additions & 1 deletion lib/class-wp-theme-json-gutenberg.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'] ) ) {
Expand Down
77 changes: 77 additions & 0 deletions phpunit/class-wp-theme-json-test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 );
}
}