<!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>[59213] trunk: Themes: Improve performance of applying background image styles in `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/59213">59213</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/59213","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>flixos90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-10-10 21:05:04 +0000 (Thu, 10 Oct 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'>Themes: Improve performance of applying background image styles in `theme.json`.
The cost of using `WP_Theme_JSON::get_block_nodes()` for this in its original shape was high enough to lead to a performance regression. Therefore this changeset introduces a new option on the method that allows to bypass all logic except for retrieving the node paths, which is much faster and everything that this functionality needs.
Follow up to <a href="https://core.trac.wordpress.org/changeset/58936">[58936]</a>.
Props mukesh27, flixos90, ramonopoly, joemcgill, andrewserong, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/61858">#61858</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 2024-10-10 18:06:13 UTC (rev 59212)
+++ trunk/src/wp-includes/class-wp-theme-json.php 2024-10-10 21:05:04 UTC (rev 59213)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2690,6 +2690,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.3.0 Refactored and stabilized selectors API.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.6.0 Added optional selectors and options for generating block nodes.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.7.0 Added $include_node_paths_only option.
</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 theme.json converted to an array.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $selectors Optional list of selectors per block.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2696,7 +2697,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $options {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. An array of options for now used for internal purposes only (may change without notice).
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type bool $include_block_style_variations Includes nodes for block style variations. Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type bool $include_block_style_variations Include nodes for block style variations. Default false.
+ * @type bool $include_node_paths_only Return only block nodes node paths. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array The block nodes in theme.json.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2712,48 +2714,65 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $nodes;
</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">+ $include_variations = $options['include_block_style_variations'] ?? false;
+ $include_node_paths_only = $options['include_node_paths_only'] ?? false;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $theme_json['styles']['blocks'] as $name => $node ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $selector = null;
- if ( isset( $selectors[ $name ]['selector'] ) ) {
- $selector = $selectors[ $name ]['selector'];
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $node_path = array( 'styles', 'blocks', $name );
+ if ( $include_node_paths_only ) {
+ $nodes[] = array(
+ 'path' => $node_path,
+ );
+ } else {
+ $selector = null;
+ if ( isset( $selectors[ $name ]['selector'] ) ) {
+ $selector = $selectors[ $name ]['selector'];
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $duotone_selector = null;
- if ( isset( $selectors[ $name ]['duotone'] ) ) {
- $duotone_selector = $selectors[ $name ]['duotone'];
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $duotone_selector = null;
+ if ( isset( $selectors[ $name ]['duotone'] ) ) {
+ $duotone_selector = $selectors[ $name ]['duotone'];
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $feature_selectors = null;
- if ( isset( $selectors[ $name ]['selectors'] ) ) {
- $feature_selectors = $selectors[ $name ]['selectors'];
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $feature_selectors = null;
+ if ( isset( $selectors[ $name ]['selectors'] ) ) {
+ $feature_selectors = $selectors[ $name ]['selectors'];
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $variation_selectors = array();
- $include_variations = $options['include_block_style_variations'] ?? false;
- if ( $include_variations && isset( $node['variations'] ) ) {
- foreach ( $node['variations'] as $variation => $node ) {
- $variation_selectors[] = array(
- 'path' => array( 'styles', 'blocks', $name, 'variations', $variation ),
- 'selector' => $selectors[ $name ]['styleVariations'][ $variation ],
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $variation_selectors = array();
+ if ( $include_variations && isset( $node['variations'] ) ) {
+ foreach ( $node['variations'] as $variation => $node ) {
+ $variation_selectors[] = array(
+ 'path' => array( 'styles', 'blocks', $name, 'variations', $variation ),
+ 'selector' => $selectors[ $name ]['styleVariations'][ $variation ],
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $nodes[] = array(
+ 'name' => $name,
+ 'path' => $node_path,
+ 'selector' => $selector,
+ 'selectors' => $feature_selectors,
+ 'duotone' => $duotone_selector,
+ 'features' => $feature_selectors,
+ 'variations' => $variation_selectors,
+ 'css' => $selector,
+ );
</ins><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">- $nodes[] = array(
- 'name' => $name,
- 'path' => array( 'styles', 'blocks', $name ),
- 'selector' => $selector,
- 'selectors' => $feature_selectors,
- 'duotone' => $duotone_selector,
- 'features' => $feature_selectors,
- 'variations' => $variation_selectors,
- 'css' => $selector,
- );
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $theme_json['styles']['blocks'][ $name ]['elements'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $theme_json['styles']['blocks'][ $name ]['elements'] as $element => $node ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $node_path = array( 'styles', 'blocks', $name, 'elements', $element );
+ if ( $include_node_paths_only ) {
+ $nodes[] = array(
+ 'path' => $node_path,
+ );
+ continue;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $nodes[] = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'path' => array( 'styles', 'blocks', $name, 'elements', $element ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'path' => $node_path,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'selector' => $selectors[ $name ]['elements'][ $element ],
</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">@@ -2761,8 +2780,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( static::VALID_ELEMENT_PSEUDO_SELECTORS[ $element ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( static::VALID_ELEMENT_PSEUDO_SELECTORS[ $element ] as $pseudo_selector ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $theme_json['styles']['blocks'][ $name ]['elements'][ $element ][ $pseudo_selector ] ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $node_path = array( 'styles', 'blocks', $name, 'elements', $element );
+ if ( $include_node_paths_only ) {
+ $nodes[] = array(
+ 'path' => $node_path,
+ );
+ continue;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $nodes[] = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'path' => array( 'styles', 'blocks', $name, 'elements', $element ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'path' => $node_path,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'selector' => static::append_to_selector( $selectors[ $name ]['elements'][ $element ], $pseudo_selector ),
</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">@@ -3236,7 +3263,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * some values provide exceptions, namely style values that are
</span><span class="cx" style="display: block; padding: 0 10px"> * objects and represent unique definitions for the style.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $style_nodes = static::get_styles_block_nodes();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $style_nodes = static::get_block_nodes(
+ $this->theme_json,
+ array(),
+ array( 'include_node_paths_only' => true )
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $style_nodes as $style_node ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $path = $style_node['path'];
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</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 2024-10-10 18:06:13 UTC (rev 59212)
+++ trunk/tests/phpunit/tests/theme/wpThemeJson.php 2024-10-10 21:05:04 UTC (rev 59213)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2444,6 +2444,60 @@
</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">+ * This test covers `get_block_nodes` with the `$include_node_paths_only` option.
+ * When `true`, `$include_node_paths_only` should return only the paths of the block nodes.
+ *
+ * @ticket 61858
+ */
+ public function test_return_block_node_paths() {
+ $theme_json = new ReflectionClass( 'WP_Theme_JSON' );
+
+ $func = $theme_json->getMethod( 'get_block_nodes' );
+ $func->setAccessible( true );
+
+ $theme_json = array(
+ 'version' => WP_Theme_JSON::LATEST_SCHEMA,
+ 'styles' => array(
+ 'typography' => array(
+ 'fontSize' => '16px',
+ ),
+ 'blocks' => array(
+ 'core/button' => array(
+ 'color' => array(
+ 'background' => 'red',
+ ),
+ ),
+ 'core/group' => array(
+ 'elements' => array(
+ 'link' => array(
+ 'color' => array(
+ 'background' => 'blue',
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ );
+
+ $block_nodes = $func->invoke( null, $theme_json, array(), array( 'include_node_paths_only' => true ) );
+
+ $expected = array(
+ array(
+ 'path' => array( 'styles', 'blocks', 'core/button' ),
+ ),
+ array(
+ 'path' => array( 'styles', 'blocks', 'core/group' ),
+ ),
+ array(
+ 'path' => array( 'styles', 'blocks', 'core/group', 'elements', 'link' ),
+ ),
+ );
+
+ $this->assertEquals( $expected, $block_nodes );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 54336
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_remove_insecure_properties_removes_unsafe_styles() {
</span></span></pre>
</div>
</div>
</body>
</html>