<!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>[54251] trunk/src: Editor: Backport hooks to filter `theme.json` data from Gutenberg to 6.1.</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/54251">54251</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/54251","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-09-20 13:10:28 +0000 (Tue, 20 Sep 2022)</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: Backport hooks to filter `theme.json` data from Gutenberg to 6.1.
This changeset ports the work done in Gutenberg (released in 14.1) to add hooks to filter the `theme.json` data. Specifically, it adds the following filters: `theme_json_default`, `theme_json_blocks`, `theme_json_theme`, and `theme_json_user`.
For more details, see the following Gutenberg pull requests:
- [https://github.com/WordPress/gutenberg/pull/44015 gutenberg<a href="https://core.trac.wordpress.org/ticket/44015">#44015</a>]: Make global styles data filterable
- [https://github.com/WordPress/gutenberg/pull/44109 gutenberg<a href="https://core.trac.wordpress.org/ticket/44109">#44109</a>]: Prepare `WP_Theme_JSON_Data` class for backporting
- [https://github.com/WordPress/gutenberg/pull/44159 gutenberg<a href="https://core.trac.wordpress.org/ticket/44159">#44159</a>]: Update hook's names from `global_styles_*` to `theme_json_*`
Props oandregal, czapla, gziolo, bernhard-reiter.
See <a href="https://core.trac.wordpress.org/ticket/56467">#56467</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="#trunksrcwpsettingsphp">trunk/src/wp-settings.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpthemejsondataphp">trunk/src/wp-includes/class-wp-theme-json-data.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpthemejsondataphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/class-wp-theme-json-data.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-data.php (rev 0)
+++ trunk/src/wp-includes/class-wp-theme-json-data.php 2022-09-20 13:10:28 UTC (rev 54251)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,72 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * WP_Theme_JSON_Data class
+ *
+ * @package WordPress
+ * @subpackage Theme
+ * @since 6.1.0
+ */
+
+/**
+ * Class to provide access to update a theme.json structure.
+ */
+class WP_Theme_JSON_Data {
+
+ /**
+ * Container of the data to update.
+ *
+ * @since 6.1.0
+ * @var WP_Theme_JSON
+ */
+ private $theme_json = null;
+
+ /**
+ * The origin of the data: default, theme, user, etc.
+ *
+ * @since 6.1.0
+ * @var string
+ */
+ private $origin = '';
+
+ /**
+ * Constructor.
+ *
+ * @since 6.1.0
+ *
+ * @link https://developer.wordpress.org/block-editor/reference-guides/theme-json-reference/
+ *
+ * @param array $data Array following the theme.json specification.
+ * @param string $origin The origin of the data: default, theme, user.
+ */
+ public function __construct( $data = array(), $origin = 'theme' ) {
+ $this->origin = $origin;
+ $this->theme_json = new WP_Theme_JSON( $data, $this->origin );
+ }
+
+ /**
+ * Updates the theme.json with the the given data.
+ *
+ * @since 6.1.0
+ *
+ * @param array $new_data Array following the theme.json specification.
+ *
+ * @return WP_Theme_JSON_Data The own instance with access to the modified data.
+ */
+ public function update_with( $new_data ) {
+ $this->theme_json->merge( new WP_Theme_JSON( $new_data, $this->origin ) );
+ return $this;
+ }
+
+ /**
+ * Returns an array containing the underlying data
+ * following the theme.json specification.
+ *
+ * @since 6.1.0
+ *
+ * @return array
+ */
+ public function get_data() {
+ return $this->theme_json->get_raw_data();
+ }
+
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/src/wp-includes/class-wp-theme-json-data.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><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 2022-09-20 13:10:24 UTC (rev 54250)
+++ trunk/src/wp-includes/class-wp-theme-json-resolver.php 2022-09-20 13:10:28 UTC (rev 54251)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -137,6 +137,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $config = static::read_json_file( __DIR__ . '/theme.json' );
</span><span class="cx" style="display: block; padding: 0 10px"> $config = static::translate( $config );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the default data provided by WordPress for global styles & settings.
+ *
+ * @since 6.1.0
+ *
+ * @param WP_Theme_JSON_Data Class to access and update the underlying data.
+ */
+ $theme_json = apply_filters( 'theme_json_default', new WP_Theme_JSON_Data( $config, 'default' ) );
+ $config = $theme_json->get_data();
</ins><span class="cx" style="display: block; padding: 0 10px"> static::$core = new WP_Theme_JSON( $config, 'default' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return static::$core;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -172,6 +181,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( null === static::$theme ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $theme_json_data = static::read_json_file( static::get_file_path_from_theme( 'theme.json' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $theme_json_data = static::translate( $theme_json_data, wp_get_theme()->get( 'TextDomain' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the data provided by the theme for global styles & settings.
+ *
+ * @since 6.1.0
+ *
+ * @param WP_Theme_JSON_Data Class to access and update the underlying data.
+ */
+ $theme_json = apply_filters( 'theme_json_theme', new WP_Theme_JSON_Data( $theme_json_data, 'theme' ) );
+ $theme_json_data = $theme_json->get_data();
</ins><span class="cx" style="display: block; padding: 0 10px"> static::$theme = new WP_Theme_JSON( $theme_json_data );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( wp_get_theme()->parent() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -258,6 +276,16 @@
</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">+ /**
+ * Filters the data provided by the blocks for global styles & settings.
+ *
+ * @since 6.1.0
+ *
+ * @param WP_Theme_JSON_Data Class to access and update the underlying data.
+ */
+ $theme_json = apply_filters( 'theme_json_blocks', new WP_Theme_JSON_Data( $config, 'core' ) );
+ $config = $theme_json->get_data();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Core here means it's the lower level part of the styles chain.
</span><span class="cx" style="display: block; padding: 0 10px"> // It can be a core or a third-party block.
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Theme_JSON( $config, 'core' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -382,6 +410,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $json_decoding_error = json_last_error();
</span><span class="cx" style="display: block; padding: 0 10px"> if ( JSON_ERROR_NONE !== $json_decoding_error ) {
</span><span class="cx" style="display: block; padding: 0 10px"> trigger_error( 'Error when decoding a theme.json schema for user data. ' . json_last_error_msg() );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the data provided by the user for global styles & settings.
+ *
+ * @since 6.1.0
+ *
+ * @param WP_Theme_JSON_Data Class to access and update the underlying data.
+ */
+ $theme_json = apply_filters( 'theme_json_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
+ $config = $theme_json->get_data();
</ins><span class="cx" style="display: block; padding: 0 10px"> return new WP_Theme_JSON( $config, 'custom' );
</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">@@ -396,6 +433,16 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the data provided by the user for global styles & settings.
+ *
+ * @since 6.1.0
+ *
+ * @param WP_Theme_JSON_Data Class to access and update the underlying data.
+ */
+ $theme_json = apply_filters( 'theme_json_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
+ $config = $theme_json->get_data();
</ins><span class="cx" style="display: block; padding: 0 10px"> static::$user = new WP_Theme_JSON( $config, 'custom' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return static::$user;
</span></span></pre></div>
<a id="trunksrcwpsettingsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-settings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-settings.php 2022-09-20 13:10:24 UTC (rev 54250)
+++ trunk/src/wp-settings.php 2022-09-20 13:10:28 UTC (rev 54251)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -172,6 +172,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/theme.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/class-wp-theme.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/class-wp-theme-json-schema.php';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+require ABSPATH . WPINC . '/class-wp-theme-json-data.php';
</ins><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/class-wp-theme-json.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/class-wp-theme-json-resolver.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/global-styles-and-settings.php';
</span></span></pre>
</div>
</div>
</body>
</html>