<!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>[55912] trunk: Ignore unregistered block style variations from `theme.json`.</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/55912">55912</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/55912","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>oandregal</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-06-14 07:40:50 +0000 (Wed, 14 Jun 2023)</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'>Ignore unregistered block style variations from `theme.json`.
This PR makes sure unregistered block style variations declared via `theme.json` are ignored. It fixes an issue by style variations don't work in the editor and CSS rules without a selector are output to the front-end.
Props isabel_brison.
Fixes <a href="https://core.trac.wordpress.org/ticket/58462">#58462</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 2023-06-14 06:32:14 UTC (rev 55911)
+++ trunk/src/wp-includes/class-wp-theme-json.php 2023-06-14 07:40:50 UTC (rev 55912)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -589,8 +589,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->theme_json = WP_Theme_JSON_Schema::migrate( $theme_json );
</span><span class="cx" style="display: block; padding: 0 10px"> $valid_block_names = array_keys( static::get_blocks_metadata() );
</span><span class="cx" style="display: block; padding: 0 10px"> $valid_element_names = array_keys( static::ELEMENTS );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $theme_json = static::sanitize( $this->theme_json, $valid_block_names, $valid_element_names );
- $this->theme_json = static::maybe_opt_in_into_settings( $theme_json );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $valid_variations = array();
+ foreach ( self::get_blocks_metadata() as $block_name => $block_meta ) {
+ if ( ! isset( $block_meta['styleVariations'] ) ) {
+ continue;
+ }
+ $valid_variations[ $block_name ] = array_keys( $block_meta['styleVariations'] );
+ }
+ $theme_json = static::sanitize( $this->theme_json, $valid_block_names, $valid_element_names, $valid_variations );
+ $this->theme_json = static::maybe_opt_in_into_settings( $theme_json );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Internally, presets are keyed by origin.
</span><span class="cx" style="display: block; padding: 0 10px"> $nodes = static::get_setting_nodes( $this->theme_json );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -668,9 +675,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $input Structure to sanitize.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $valid_block_names List of valid block names.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $valid_element_names List of valid element names.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $valid_variations List of valid variations per block.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array The sanitized output.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- protected static function sanitize( $input, $valid_block_names, $valid_element_names ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected static function sanitize( $input, $valid_block_names, $valid_element_names, $valid_variations ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $output = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -728,9 +736,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $style_variation_names = array();
</span><span class="cx" style="display: block; padding: 0 10px"> if (
</span><span class="cx" style="display: block; padding: 0 10px"> ! empty( $input['styles']['blocks'][ $block ]['variations'] ) &&
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- is_array( $input['styles']['blocks'][ $block ]['variations'] )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ is_array( $input['styles']['blocks'][ $block ]['variations'] ) &&
+ isset( $valid_variations[ $block ] )
</ins><span class="cx" style="display: block; padding: 0 10px"> ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $style_variation_names = array_keys( $input['styles']['blocks'][ $block ]['variations'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $style_variation_names = array_intersect(
+ array_keys( $input['styles']['blocks'][ $block ]['variations'] ),
+ $valid_variations[ $block ]
+ );
</ins><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"> $schema_styles_variations = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2852,8 +2864,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $valid_block_names = array_keys( static::get_blocks_metadata() );
</span><span class="cx" style="display: block; padding: 0 10px"> $valid_element_names = array_keys( static::ELEMENTS );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $valid_variations = array();
+ foreach ( self::get_blocks_metadata() as $block_name => $block_meta ) {
+ if ( ! isset( $block_meta['styleVariations'] ) ) {
+ continue;
+ }
+ $valid_variations[ $block_name ] = array_keys( $block_meta['styleVariations'] );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $theme_json = static::sanitize( $theme_json, $valid_block_names, $valid_element_names );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $theme_json = static::sanitize( $theme_json, $valid_block_names, $valid_element_names, $valid_variations );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $blocks_metadata = static::get_blocks_metadata();
</span><span class="cx" style="display: block; padding: 0 10px"> $style_nodes = static::get_style_nodes( $theme_json, $blocks_metadata );
</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 2023-06-14 06:32:14 UTC (rev 55911)
+++ trunk/tests/phpunit/tests/theme/wpThemeJson.php 2023-06-14 07:40:50 UTC (rev 55912)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3698,6 +3698,54 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, $root_rules . $style_rules );
</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">+ /*
+ * @ticket 58462
+ */
+ public function test_sanitize_for_unregistered_style_variations() {
+ $theme_json = new WP_Theme_JSON(
+ array(
+ 'version' => 2,
+ 'styles' => array(
+ 'blocks' => array(
+ 'core/quote' => array(
+ 'variations' => array(
+ 'unregisteredVariation' => array(
+ 'color' => array(
+ 'background' => 'hotpink',
+ ),
+ ),
+ 'plain' => array(
+ 'color' => array(
+ 'background' => 'hotpink',
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ )
+ );
+
+ $sanitized_theme_json = $theme_json->get_raw_data();
+ $expected = array(
+ 'version' => 2,
+ 'styles' => array(
+ 'blocks' => array(
+ 'core/quote' => array(
+ 'variations' => array(
+ 'plain' => array(
+ 'color' => array(
+ 'background' => 'hotpink',
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ );
+ $this->assertSameSetsWithIndex( $expected, $sanitized_theme_json, 'Sanitized theme.json styles does not match' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 57583
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3732,7 +3780,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function data_sanitize_for_block_with_style_variations() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '1 variation with 1 invalid property' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '1 variation with 1 valid property' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'theme_json_variations' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'variations' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'plain' => array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3782,44 +3830,6 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '2 variations with 1 invalid property' => array(
- 'theme_json_variations' => array(
- 'variations' => array(
- 'plain' => array(
- 'color' => array(
- 'background' => 'hotpink',
- ),
- 'invalidProperty1' => 'value1',
- ),
- 'basic' => array(
- 'color' => array(
- 'background' => '#ffffff',
- 'text' => '#000000',
- ),
- 'foo' => 'bar',
- ),
- ),
- ),
- 'expected_sanitized' => array(
- 'blocks' => array(
- 'core/quote' => array(
- 'variations' => array(
- 'plain' => array(
- 'color' => array(
- 'background' => 'hotpink',
- ),
- ),
- 'basic' => array(
- 'color' => array(
- 'background' => '#ffffff',
- 'text' => '#000000',
- ),
- ),
- ),
- ),
- ),
- ),
- ),
</del><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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3913,13 +3923,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'styles' => '.is-style-plain.is-style-plain.wp-block-quote{background-color: hotpink;}',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $basic = array(
- 'metadata' => array(
- 'path' => array( 'styles', 'blocks', 'core/quote', 'variations', 'basic' ),
- 'selector' => '.is-style-basic.is-style-basic.wp-block-quote',
- ),
- 'styles' => '.is-style-basic.is-style-basic.wp-block-quote{background-color: #ffffff;color: #000000;}',
- );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><span class="cx" style="display: block; padding: 0 10px"> '1 variation with 1 invalid property' => array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3950,51 +3953,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'metadata_variation' => array( $plain['metadata'] ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => $plain['styles'],
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '2 variations with 1 invalid property' => array(
- 'theme_json_variations' => array(
- 'variations' => array(
- 'plain' => array(
- 'color' => array(
- 'background' => 'hotpink',
- ),
- 'invalidProperty1' => 'value1',
- ),
- 'basic' => array(
- 'color' => array(
- 'background' => '#ffffff',
- 'text' => '#000000',
- ),
- 'foo' => 'bar',
- ),
- ),
- ),
- 'metadata_variation' => array( $plain['metadata'], $basic['metadata'] ),
- 'expected_styles' => $plain['styles'] . $basic['styles'],
- ),
- '2 variations with multiple invalid properties' => array(
- 'theme_json_variations' => array(
- 'variations' => array(
- 'plain' => array(
- 'color' => array(
- 'background' => 'hotpink',
- ),
- 'invalidProperty1' => 'value1',
- 'invalidProperty2' => 'value2',
- ),
- 'basic' => array(
- 'foo' => 'foo',
- 'color' => array(
- 'background' => '#ffffff',
- 'text' => '#000000',
- ),
- 'bar' => 'bar',
- 'baz' => 'baz',
- ),
- ),
- ),
- 'metadata_variation' => array( $plain['metadata'], $basic['metadata'] ),
- 'expected_styles' => $plain['styles'] . $basic['styles'],
- ),
</del><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></span></pre>
</div>
</div>
</body>
</html>