<!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>[58429] trunk: Do not use init to register block style variations defined via 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/58429">58429</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/58429","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>2024-06-18 07:07:52 +0000 (Tue, 18 Jun 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'>Do not use init to register block style variations defined via theme.json.
Props oandregal, aaronrobertshaw, joemcgill, ramonopoly, andrewserong, swissspidy.
See <a href="https://core.trac.wordpress.org/ticket/61451">#61451</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/61312">#61312</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksupportsblockstylevariationsphp">trunk/src/wp-includes/block-supports/block-style-variations.php</a></li>
<li><a href="#trunksrcwpincludesclasswpthemejsonresolverphp">trunk/src/wp-includes/class-wp-theme-json-resolver.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestglobalstylescontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php</a></li>
<li><a href="#trunktestsphpunittestsblocksupportsblockstylevariationsphp">trunk/tests/phpunit/tests/block-supports/block-style-variations.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblocksupportsblockstylevariationsphp"></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/block-supports/block-style-variations.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-supports/block-style-variations.php 2024-06-18 06:00:51 UTC (rev 58428)
+++ trunk/src/wp-includes/block-supports/block-style-variations.php 2024-06-18 07:07:52 UTC (rev 58429)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -461,58 +461,3 @@
</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">-
-/**
- * Register shared block style variations defined by the theme.
- *
- * These can come in three forms:
- * - the theme's theme.json
- * - the theme's partials (standalone files in `/styles` that only define block style variations)
- * - the user's theme.json (for example, theme style variations the user selected)
- *
- * @since 6.6.0
- * @access private
- */
-function wp_register_block_style_variations_from_theme() {
- /*
- * Skip any registration of styles if no theme.json or variation partials are present.
- *
- * Given the possibility of hybrid themes, this check can't rely on if the theme
- * is a block theme or not. Instead:
- * - If there is a primary theme.json, continue.
- * - If there is a partials directory, continue.
- * - The only variations to be registered from the global styles user origin,
- * are those that have been copied in from the selected theme style variation.
- * For a theme style variation to be selected it would have to have a partial
- * theme.json file covered by the previous check.
- */
- $has_partials_directory = is_dir( get_stylesheet_directory() . '/styles' ) || is_dir( get_template_directory() . '/styles' );
- if ( ! wp_theme_has_theme_json() && ! $has_partials_directory ) {
- return;
- }
-
- // Partials from `/styles`.
- $variations_partials = WP_Theme_JSON_Resolver::get_style_variations( 'block' );
- wp_register_block_style_variations_from_theme_json_data( $variations_partials );
-
- /*
- * Pull the data from the specific origin instead of the merged data.
- * This is because, for 6.6, we only support registering block style variations
- * for the 'theme' and 'custom' origins but not for 'default' (core theme.json)
- * or 'custom' (theme.json in a block).
- *
- * When/If we add support for every origin, we should switch to using the public API
- * instead, e.g.: wp_get_global_styles( array( 'blocks', 'variations' ) ).
- */
-
- // theme.json of the theme.
- $theme_json_theme = WP_Theme_JSON_Resolver::get_theme_data();
- $variations_theme = $theme_json_theme->get_data()['styles']['blocks']['variations'] ?? array();
- wp_register_block_style_variations_from_theme_json_data( $variations_theme );
-
- // User data linked for this theme.
- $theme_json_user = WP_Theme_JSON_Resolver::get_user_data();
- $variations_user = $theme_json_user->get_data()['styles']['blocks']['variations'] ?? array();
- wp_register_block_style_variations_from_theme_json_data( $variations_user );
-}
-add_action( 'init', 'wp_register_block_style_variations_from_theme' );
</del></span></pre></div>
<a id="trunksrcwpincludesclasswpthemejsonresolverphp"></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-resolver.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-resolver.php 2024-06-18 06:00:51 UTC (rev 58428)
+++ trunk/src/wp-includes/class-wp-theme-json-resolver.php 2024-06-18 07:07:52 UTC (rev 58429)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -221,6 +221,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0 Theme supports have been inlined and the `$theme_support_data` argument removed.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.0.0 Added an `$options` parameter to allow the theme data to be returned without theme supports.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.6.0 Add support for 'default-font-sizes' and 'default-spacing-sizes' theme supports.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Register the block style variations coming from the partials and the theme.json.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $deprecated Deprecated. Not used.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $options {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -247,6 +248,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $theme_json_data = array( 'version' => WP_Theme_JSON::LATEST_SCHEMA );
</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">+ // Register variations defined by the theme.
+ $variations = $theme_json_data['styles']['blocks']['variations'] ?? array();
+ wp_register_block_style_variations_from_theme_json_data( $variations );
+
+ // Register variations defined by theme partials (theme.json files in the styles directory).
+ $variations = static::get_style_variations( 'block' );
+ wp_register_block_style_variations_from_theme_json_data( $variations );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the data provided by the theme for global styles and settings.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -488,6 +497,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.6.0 The 'isGlobalStylesUserThemeJSON' flag is left on the user data.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Register the block style variations coming from the user data.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return WP_Theme_JSON Entity that holds styles for user data.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -528,6 +538,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $decoded_data['isGlobalStylesUserThemeJSON'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $config = $decoded_data;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Register variations defined by the user.
+ $variations = $config['styles']['blocks']['variations'] ?? array();
+ wp_register_block_style_variations_from_theme_json_data( $variations );
</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"> /** This filter is documented in wp-includes/class-wp-theme-json-resolver.php */
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestglobalstylescontrollerphp"></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/rest-api/endpoints/class-wp-rest-global-styles-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php 2024-06-18 06:00:51 UTC (rev 58428)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php 2024-06-18 07:07:52 UTC (rev 58429)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -231,7 +231,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0 Added validation of styles.css property.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 6.6.0 Added registration of newly created style variations provided by the user.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.6.0 Added registration of block style variations from theme.json sources (theme.json, user theme.json, partials).
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Request object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return stdClass|WP_Error Prepared item on success. WP_Error on when the custom CSS is not valid.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -265,22 +265,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $config['styles'] = $existing_config['styles'];
</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">- /*
- * If the incoming request is going to create a new variation
- * that is not yet registered, we register it here.
- * This is because the variations are registered on init,
- * but we want this endpoint to return the new variation immediately:
- * if we don't register it, it'll be stripped out of the response
- * just in this request (subsequent ones will be ok).
- * Take the variations defined in styles.blocks.variations from the incoming request
- * that are not part of the $exsting_config.
- */
- if ( isset( $request['styles']['blocks']['variations'] ) ) {
- $existing_variations = isset( $existing_config['styles']['blocks']['variations'] ) ? $existing_config['styles']['blocks']['variations'] : array();
- $new_variations = array_diff_key( $request['styles']['blocks']['variations'], $existing_variations );
- if ( ! empty( $new_variations ) ) {
- wp_register_block_style_variations_from_theme_json_data( $new_variations );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Register theme-defined variations.
+ WP_Theme_JSON_Resolver::get_theme_data();
+
+ // Register user-defined variations.
+ if ( ! empty( $config['styles']['blocks']['variations'] ) ) {
+ wp_register_block_style_variations_from_theme_json_data( $config['styles']['blocks']['variations'] );
</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"> if ( isset( $request['settings'] ) ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsblocksupportsblockstylevariationsphp"></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/block-supports/block-style-variations.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/block-supports/block-style-variations.php 2024-06-18 06:00:51 UTC (rev 58428)
+++ trunk/tests/phpunit/tests/block-supports/block-style-variations.php 2024-06-18 07:07:52 UTC (rev 58429)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,12 +66,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_add_registered_block_styles_to_theme_data() {
</span><span class="cx" style="display: block; padding: 0 10px"> switch_theme( 'block-theme' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * Trigger block style registration that occurs on `init` action.
- * do_action( 'init' ) could be used here however this direct call
- * means only the updates being tested are performed.
- */
- wp_register_block_style_variations_from_theme();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Register theme-defined variations.
+ WP_Theme_JSON_Resolver::get_theme_data();
+ // Register user-defined variations.
+ WP_Theme_JSON_Resolver::get_user_data();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $variation_styles_data = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'color' => array(
</span></span></pre>
</div>
</div>
</body>
</html>