<!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>[58354] trunk/src/wp-includes: Editor: code quality improvements for theme.json migrate API</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/58354">58354</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/58354","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-06 08:00:08 +0000 (Thu, 06 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'>Editor: code quality improvements for theme.json migrate API
Backports https://github.com/WordPress/gutenberg/pull/62305
Follow-up to <a href="https://core.trac.wordpress.org/changeset/58328">[58328]</a>, <a href="https://core.trac.wordpress.org/ticket/61282">#61282</a>.
Props ajlende, oandregal, ramonopoly, mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/61282">#61282</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpthemejsonresolverphp">trunk/src/wp-includes/class-wp-theme-json-resolver.php</a></li>
<li><a href="#trunksrcwpincludesclasswpthemejsonschemaphp">trunk/src/wp-includes/class-wp-theme-json-schema.php</a></li>
<li><a href="#trunksrcwpincludesclasswpthemejsonphp">trunk/src/wp-includes/class-wp-theme-json.php</a></li>
<li><a href="#trunksrcwpincludesksesphp">trunk/src/wp-includes/kses.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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-05 23:17:18 UTC (rev 58353)
+++ trunk/src/wp-includes/class-wp-theme-json-resolver.php 2024-06-06 08:00:08 UTC (rev 58354)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -525,19 +525,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> isset( $decoded_data['isGlobalStylesUserThemeJSON'] ) &&
</span><span class="cx" style="display: block; padding: 0 10px"> $decoded_data['isGlobalStylesUserThemeJSON']
</span><span class="cx" style="display: block; padding: 0 10px"> ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $decoded_data['isGlobalStylesUserThemeJSON'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $config = $decoded_data;
</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><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/class-wp-theme-json-resolver.php */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $theme_json = apply_filters( 'wp_theme_json_data_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
- $config = $theme_json->get_data();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $theme_json = apply_filters( 'wp_theme_json_data_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
+ static::$user = $theme_json->get_theme_json();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Needs to be set for schema migrations of user data.
- $config['isGlobalStylesUserThemeJSON'] = true;
-
- static::$user = new WP_Theme_JSON( $config, 'custom' );
-
</del><span class="cx" style="display: block; padding: 0 10px"> return static::$user;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpthemejsonschemaphp"></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-schema.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-schema.php 2024-06-05 23:17:18 UTC (rev 58353)
+++ trunk/src/wp-includes/class-wp-theme-json-schema.php 2024-06-06 08:00:08 UTC (rev 58354)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,13 +35,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Function that migrates a given theme.json structure to the last version.
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 6.6.0 Migrate up to v3.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.6.0 Migrate up to v3 and add $origin parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $theme_json The structure to migrate.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $origin Optional. What source of data this object represents.
+ * One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array The structure in the last version.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public static function migrate( $theme_json ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function migrate( $theme_json, $origin = 'theme' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $theme_json['version'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $theme_json = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'version' => WP_Theme_JSON::LATEST_SCHEMA,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,7 +55,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $theme_json = self::migrate_v1_to_v2( $theme_json );
</span><span class="cx" style="display: block; padding: 0 10px"> // Deliberate fall through. Once migrated to v2, also migrate to v3.
</span><span class="cx" style="display: block; padding: 0 10px"> case 2:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $theme_json = self::migrate_v2_to_v3( $theme_json );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $theme_json = self::migrate_v2_to_v3( $theme_json, $origin );
</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"> return $theme_json;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,11 +101,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $old Data to migrate.
- *
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $old Data to migrate.
+ * @param string $origin What source of data this object represents.
+ * One of 'blocks', 'default', 'theme', or 'custom'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Data with defaultFontSizes set to false.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- private static function migrate_v2_to_v3( $old ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ private static function migrate_v2_to_v3( $old, $origin ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> // Copy everything.
</span><span class="cx" style="display: block; padding: 0 10px"> $new = $old;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -115,10 +117,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Remaining changes do not need to be applied to the custom origin,
</span><span class="cx" style="display: block; padding: 0 10px"> * as they should take on the value of the theme origin.
</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 (
- isset( $new['isGlobalStylesUserThemeJSON'] ) &&
- true === $new['isGlobalStylesUserThemeJSON']
- ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'custom' === $origin ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return $new;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<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-06-05 23:17:18 UTC (rev 58353)
+++ trunk/src/wp-includes/class-wp-theme-json.php 2024-06-06 08:00:08 UTC (rev 58354)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -747,7 +747,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $theme_json A structure that follows the theme.json schema.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $origin Optional. What source of data this object represents.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * One of 'default', 'theme', or 'custom'. Default 'theme'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $theme_json = array( 'version' => WP_Theme_JSON::LATEST_SCHEMA ), $origin = 'theme' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! in_array( $origin, static::VALID_ORIGINS, true ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -754,7 +754,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $origin = 'theme';
</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">- $this->theme_json = WP_Theme_JSON_Schema::migrate( $theme_json );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->theme_json = WP_Theme_JSON_Schema::migrate( $theme_json, $origin );
</ins><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><span class="cx" style="display: block; padding: 0 10px"> $valid_variations = static::get_valid_block_style_variations();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3242,15 +3242,21 @@
</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.3.2 Preserves global styles block variations when securing styles.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 6.6.0 Updated to allow variation element styles.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.6.0 Updated to allow variation element styles and $origin parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $theme_json Structure to sanitize.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $origin Optional. What source of data this object represents.
+ * One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Sanitized structure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public static function remove_insecure_properties( $theme_json ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function remove_insecure_properties( $theme_json, $origin = 'theme' ) {
+ if ( ! in_array( $origin, static::VALID_ORIGINS, true ) ) {
+ $origin = 'theme';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $sanitized = array();
</span><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 = WP_Theme_JSON_Schema::migrate( $theme_json );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $theme_json = WP_Theme_JSON_Schema::migrate( $theme_json, $origin );
</ins><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></span></pre></div>
<a id="trunksrcwpincludesksesphp"></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/kses.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/kses.php 2024-06-05 23:17:18 UTC (rev 58353)
+++ trunk/src/wp-includes/kses.php 2024-06-06 08:00:08 UTC (rev 58354)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2146,7 +2146,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ) {
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $decoded_data['isGlobalStylesUserThemeJSON'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data_to_encode = WP_Theme_JSON::remove_insecure_properties( $decoded_data );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $data_to_encode = WP_Theme_JSON::remove_insecure_properties( $decoded_data, 'custom' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $data_to_encode['isGlobalStylesUserThemeJSON'] = true;
</span><span class="cx" style="display: block; padding: 0 10px"> return wp_slash( wp_json_encode( $data_to_encode ) );
</span></span></pre>
</div>
</div>
</body>
</html>