<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[59418] trunk: Theme JSON: include block style variations in path only output of get_block_nodes</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/59418">59418</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/59418","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ramonopoly</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-11-19 04:42:17 +0000 (Tue, 19 Nov 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/changeset/61858">[61858]</a>.
Props aaronrobertshaw, ramonopoly.
Fixes <a href="https://core.trac.wordpress.org/ticket/62399">#62399</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpthemejsonphp">trunk/src/wp-includes/class-wp-theme-json.php</a></li>
<li><a href="#trunktestsphpunitteststhemewpThemeJsonphp">trunk/tests/phpunit/tests/theme/wpThemeJson.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpthemejsonphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-theme-json.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-theme-json.php 2024-11-18 23:36:26 UTC (rev 59417)
+++ trunk/src/wp-includes/class-wp-theme-json.php 2024-11-19 04:42:17 UTC (rev 59418)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2722,9 +2722,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $theme_json['styles']['blocks'] as $name => $node ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $node_path = array( 'styles', 'blocks', $name );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $include_node_paths_only ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $nodes[] = array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'path' => $node_path,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $variation_paths ) ) {
+ $node['variations'] = $variation_paths;
+ }
+ $nodes[] = $node;
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $selector = null;
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $selectors[ $name ]['selector'] ) ) {
</span></span></pre></div>
<a id="trunktestsphpunitteststhemewpThemeJsonphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/theme/wpThemeJson.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/theme/wpThemeJson.php 2024-11-18 23:36:26 UTC (rev 59417)
+++ trunk/tests/phpunit/tests/theme/wpThemeJson.php 2024-11-19 04:42:17 UTC (rev 59418)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2503,6 +2503,85 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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' ),
+ ),
+ ),
+ ),
+ );
+
+ $this->assertEquals( $expected, $block_nodes );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 54336
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_remove_insecure_properties_removes_unsafe_styles() {
</span></span></pre>
</div>
</div>
</body>
</html>