<!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>[58699] branches/6.6/tests/phpunit/tests/block-supports/block-style-variations.php: Editor: Fix ref values within block style variations.</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/58699">58699</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/58699","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-07-09 16:06:20 +0000 (Tue, 09 Jul 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'>Editor: Fix ref values within block style variations.
Fixes an issue where block style variations that use `ref` values to reference styles elsewhere in theme.json weren't working.
Retrieves reference values when generating styles for block style variations. How? When retrieving variation data, to generate styles from, also retrieve any referenced values.
Reviewed by audrasjb.
Merges <a href="https://core.trac.wordpress.org/changeset/58691">[58691]</a> to the 6.6 branch.
Props aaronrobertshaw, andrewserong, ramonopoly.
Fixes <a href="https://core.trac.wordpress.org/ticket/61589">#61589</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches66srcwpincludesblocksupportsblockstylevariationsphp">branches/6.6/src/wp-includes/block-supports/block-style-variations.php</a></li>
<li><a href="#branches66testsphpunittestsblocksupportsblockstylevariationsphp">branches/6.6/tests/phpunit/tests/block-supports/block-style-variations.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches66">branches/6.6/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/6.6
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/6.6 2024-07-09 15:58:01 UTC (rev 58698)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/6.6 2024-07-09 16:06:20 UTC (rev 58699)
</ins><a id="branches66"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/6.6</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.5:49373-49379,49381
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.8:51889
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:58570,58585,58588,58612,58617-58618,58671-58672,58685,58690,58693
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:58570,58585,58588,58612,58617-58618,58671-58672,58685,58690-58691,58693
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches66srcwpincludesblocksupportsblockstylevariationsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.6/src/wp-includes/block-supports/block-style-variations.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.6/src/wp-includes/block-supports/block-style-variations.php 2024-07-09 15:58:01 UTC (rev 58698)
+++ branches/6.6/src/wp-includes/block-supports/block-style-variations.php 2024-07-09 16:06:20 UTC (rev 58699)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -41,6 +41,42 @@
</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">+ * 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 );
+ }
+ }
+ }
+}
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Render the block style variation's styles.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * In the case of nested blocks with variations applied, we want the parent
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -82,6 +118,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $parsed_block;
</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">+ /*
+ * 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 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $variation_instance = wp_create_block_style_variation_instance_name( $parsed_block, $variation );
</span><span class="cx" style="display: block; padding: 0 10px"> $class_name = "is-style-$variation_instance";
</span><span class="cx" style="display: block; padding: 0 10px"> $updated_class_name = $parsed_block['attrs']['className'] . " $class_name";
</span></span></pre></div>
<a id="branches66testsphpunittestsblocksupportsblockstylevariationsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.6/tests/phpunit/tests/block-supports/block-style-variations.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.6/tests/phpunit/tests/block-supports/block-style-variations.php 2024-07-09 15:58:01 UTC (rev 58698)
+++ branches/6.6/tests/phpunit/tests/block-supports/block-style-variations.php 2024-07-09 16:06:20 UTC (rev 58699)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -159,4 +159,78 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSameSetsWithIndex( $expected, $group_styles, 'Variation data does not match' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * 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' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>