<!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>[55950] trunk/src/wp-includes/class-wp-theme-json.php: Editor: Introduce `WP_Theme_JSON::prepend_to_selector()` to improve code quality and performance.</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/55950">55950</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/55950","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>2023-06-20 17:52:32 +0000 (Tue, 20 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'>Editor: Introduce `WP_Theme_JSON::prepend_to_selector()` to improve code quality and performance.
The `WP_Theme_JSON::append_to_selector()` method was previously used for both appending and prepending which violated the single responsibility principle. It resulted in additional conditionals which also came at a performance cost, particularly because the method is called over 1,000 times during a regular WordPress request.
With the new `WP_Theme_JSON::prepend_to_selector()` method, there are now two distinct methods for the two distinct purposes. The now useless third parameter on `WP_Theme_JSON::append_to_selector()` has been removed (rather than deprecated), which is acceptable given that it is a protected method on a class that is not intended for extensions.
Props bor0, costdev, flixos90, isabel_brison, oandregal, spacedmonkey.
Fixes <a href="https://core.trac.wordpress.org/ticket/58193">#58193</a>.
See <a href="https://core.trac.wordpress.org/ticket/58457">#58457</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpthemejsonphp">trunk/src/wp-includes/class-wp-theme-json.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-20 15:45:23 UTC (rev 55949)
+++ trunk/src/wp-includes/class-wp-theme-json.php 2023-06-20 17:52:32 UTC (rev 55950)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -795,25 +795,50 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.1.0 Added append position.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.3.0 Removed append position parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $selector Original selector.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $to_append Selector to append.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $position A position sub-selector should be appended. Default 'right'.
</del><span class="cx" style="display: block; padding: 0 10px"> * @return string The new selector.
</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 append_to_selector( $selector, $to_append, $position = 'right' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected static function append_to_selector( $selector, $to_append ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! str_contains( $selector, ',' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return 'right' === $position ? $selector . $to_append : $to_append . $selector;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $selector . $to_append;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $new_selectors = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $selectors = explode( ',', $selector );
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $selectors as $sel ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $new_selectors[] = 'right' === $position ? $sel . $to_append : $to_append . $sel;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $new_selectors[] = $sel . $to_append;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> return implode( ',', $new_selectors );
</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">+ * Prepends a sub-selector to an existing one.
+ *
+ * Given the compounded $selector "h1, h2, h3"
+ * and the $to_prepend selector ".some-class " the result will be
+ * ".some-class h1, .some-class h2, .some-class h3".
+ *
+ * @since 6.3.0
+ *
+ * @param string $selector Original selector.
+ * @param string $to_prepend Selector to prepend.
+ * @return string The new selector.
+ */
+ protected static function prepend_to_selector( $selector, $to_prepend ) {
+ if ( ! str_contains( $selector, ',' ) ) {
+ return $to_prepend . $selector;
+ }
+ $new_selectors = array();
+ $selectors = explode( ',', $selector );
+ foreach ( $selectors as $sel ) {
+ $new_selectors[] = $to_prepend . $sel;
+ }
+ return implode( ',', $new_selectors );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Returns the metadata for each block.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Example:
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -900,7 +925,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $element_selector = array( $el_selector );
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $element_selector[] = static::append_to_selector( $el_selector, $selector . ' ', 'left' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $element_selector[] = static::prepend_to_selector( $el_selector, $selector . ' ' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> static::$blocks_metadata[ $block_name ]['elements'][ $el_name ] = implode( ',', $element_selector );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1537,10 +1562,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $slugs = static::get_settings_slugs( $settings, $preset_metadata, $origins );
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $preset_metadata['classes'] as $class => $property ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $slugs as $slug ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $css_var = static::replace_slug_in_string( $preset_metadata['css_vars'], $slug );
- $class_name = static::replace_slug_in_string( $class, $slug );
- $stylesheet .= static::to_ruleset(
- static::append_to_selector( $selector, $class_name ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $css_var = static::replace_slug_in_string( $preset_metadata['css_vars'], $slug );
+ $class_name = static::replace_slug_in_string( $class, $slug );
+
+ // $selector is often empty, so we can save ourselves the `append_to_selector()` call then.
+ $new_selector = '' === $selector ? $class_name : static::append_to_selector( $selector, $class_name );
+ $stylesheet .= static::to_ruleset(
+ $new_selector,
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => $property,
</span></span></pre>
</div>
</div>
</body>
</html>