<!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>[55146] trunk: Themes: Avoid unnecessary database queries from `get_default_block_editor_settings()` in `WP_Theme_JSON_Resolver::get_theme_data()`.</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/55146">55146</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/55146","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-01-26 18:37:47 +0000 (Thu, 26 Jan 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'>Themes: Avoid unnecessary database queries from `get_default_block_editor_settings()` in `WP_Theme_JSON_Resolver::get_theme_data()`.
The `get_default_block_editor_settings()` function included several pieces of data that are irrelevant for the purpose that `WP_Theme_JSON_Resolver` was calling it for, yet resulted in three database queries on page load that can be avoided.
This changeset introduces a new function `get_classic_theme_supports_block_editor_settings()` to takes responsibility of only the data needed in `WP_Theme_JSON_Resolver`, which now uses that function. This leads to a reduction of database queries and accordingly a performance improvement.
Props mamaduka, spacedmonkey, oandregal, flixos90, audrasjb, mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/57547">#57547</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblockeditorphp">trunk/src/wp-includes/block-editor.php</a></li>
<li><a href="#trunksrcwpincludesclasswpthemejsonresolverphp">trunk/src/wp-includes/class-wp-theme-json-resolver.php</a></li>
<li><a href="#trunktestsphpunittestsblockseditorphp">trunk/tests/phpunit/tests/blocks/editor.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="trunksrcwpincludesblockeditorphp"></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-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-editor.php 2023-01-26 18:10:54 UTC (rev 55145)
+++ trunk/src/wp-includes/block-editor.php 2023-01-26 18:37:47 UTC (rev 55146)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -216,13 +216,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'allowedMimeTypes' => get_allowed_mime_types(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'defaultEditorStyles' => $default_editor_styles,
</span><span class="cx" style="display: block; padding: 0 10px"> 'blockCategories' => get_default_block_categories(),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'disableCustomColors' => get_theme_support( 'disable-custom-colors' ),
- 'disableCustomFontSizes' => get_theme_support( 'disable-custom-font-sizes' ),
- 'disableCustomGradients' => get_theme_support( 'disable-custom-gradients' ),
- 'disableLayoutStyles' => get_theme_support( 'disable-layout-styles' ),
- 'enableCustomLineHeight' => get_theme_support( 'custom-line-height' ),
- 'enableCustomSpacing' => get_theme_support( 'custom-spacing' ),
- 'enableCustomUnits' => get_theme_support( 'custom-units' ),
</del><span class="cx" style="display: block; padding: 0 10px"> 'isRTL' => is_rtl(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'imageDefaultSize' => $image_default_size,
</span><span class="cx" style="display: block; padding: 0 10px"> 'imageDimensions' => $image_dimensions,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -233,22 +226,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> '__unstableGalleryWithImageBlocks' => true,
</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">- // Theme settings.
- $color_palette = current( (array) get_theme_support( 'editor-color-palette' ) );
- if ( false !== $color_palette ) {
- $editor_settings['colors'] = $color_palette;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $theme_settings = get_classic_theme_supports_block_editor_settings();
+ foreach ( $theme_settings as $key => $value ) {
+ $editor_settings[ $key ] = $value;
</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">- $font_sizes = current( (array) get_theme_support( 'editor-font-sizes' ) );
- if ( false !== $font_sizes ) {
- $editor_settings['fontSizes'] = $font_sizes;
- }
-
- $gradient_presets = current( (array) get_theme_support( 'editor-gradient-presets' ) );
- if ( false !== $gradient_presets ) {
- $editor_settings['gradients'] = $gradient_presets;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> return $editor_settings;
</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">@@ -694,3 +676,40 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $styles;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Returns the classic theme supports settings for block editor.
+ *
+ * @since 6.2.0
+ *
+ * @return array The classic theme supports settings.
+ */
+function get_classic_theme_supports_block_editor_settings() {
+ $theme_settings = array(
+ 'disableCustomColors' => get_theme_support( 'disable-custom-colors' ),
+ 'disableCustomFontSizes' => get_theme_support( 'disable-custom-font-sizes' ),
+ 'disableCustomGradients' => get_theme_support( 'disable-custom-gradients' ),
+ 'disableLayoutStyles' => get_theme_support( 'disable-layout-styles' ),
+ 'enableCustomLineHeight' => get_theme_support( 'custom-line-height' ),
+ 'enableCustomSpacing' => get_theme_support( 'custom-spacing' ),
+ 'enableCustomUnits' => get_theme_support( 'custom-units' ),
+ );
+
+ // Theme settings.
+ $color_palette = current( (array) get_theme_support( 'editor-color-palette' ) );
+ if ( false !== $color_palette ) {
+ $theme_settings['colors'] = $color_palette;
+ }
+
+ $font_sizes = current( (array) get_theme_support( 'editor-font-sizes' ) );
+ if ( false !== $font_sizes ) {
+ $theme_settings['fontSizes'] = $font_sizes;
+ }
+
+ $gradient_presets = current( (array) get_theme_support( 'editor-gradient-presets' ) );
+ if ( false !== $gradient_presets ) {
+ $theme_settings['gradients'] = $gradient_presets;
+ }
+
+ return $theme_settings;
+}
</ins></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 2023-01-26 18:10:54 UTC (rev 55145)
+++ trunk/src/wp-includes/class-wp-theme-json-resolver.php 2023-01-26 18:37:47 UTC (rev 55146)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -286,7 +286,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * So we take theme supports, transform it to theme.json shape
</span><span class="cx" style="display: block; padding: 0 10px"> * and merge the static::$theme upon that.
</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_support_data = WP_Theme_JSON::get_from_editor_settings( get_default_block_editor_settings() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $theme_support_data = WP_Theme_JSON::get_from_editor_settings( get_classic_theme_supports_block_editor_settings() );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! wp_theme_has_theme_json() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $theme_support_data['settings']['color'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $theme_support_data['settings']['color'] = array();
</span></span></pre></div>
<a id="trunktestsphpunittestsblockseditorphp"></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/blocks/editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/editor.php 2023-01-26 18:10:54 UTC (rev 55145)
+++ trunk/tests/phpunit/tests/blocks/editor.php 2023-01-26 18:37:47 UTC (rev 55146)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -569,6 +569,44 @@
</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">+ * @ticket 57547
+ *
+ * @covers ::get_classic_theme_supports_block_editor_settings
+ */
+ public function test_get_classic_theme_supports_block_editor_settings() {
+ $font_sizes = array(
+ array(
+ 'name' => 'Small',
+ 'size' => 12,
+ 'slug' => 'small',
+ ),
+ array(
+ 'name' => 'Regular',
+ 'size' => 16,
+ 'slug' => 'regular',
+ ),
+ );
+
+ add_theme_support( 'editor-font-sizes', $font_sizes );
+ $settings = get_classic_theme_supports_block_editor_settings();
+ remove_theme_support( 'editor-font-sizes' );
+
+ $this->assertFalse( $settings['disableCustomColors'], 'Value for array key "disableCustomColors" does not match expectations' );
+ $this->assertFalse( $settings['disableCustomFontSizes'], 'Value for array key "disableCustomFontSizes" does not match expectations' );
+ $this->assertFalse( $settings['disableCustomGradients'], 'Value for array key "disableCustomGradients" does not match expectations' );
+ $this->assertFalse( $settings['disableLayoutStyles'], 'Value for array key "disableLayoutStyles" does not match expectations' );
+ $this->assertFalse( $settings['enableCustomLineHeight'], 'Value for array key "enableCustomLineHeight" does not match expectations' );
+ $this->assertFalse( $settings['enableCustomSpacing'], 'Value for array key "enableCustomSpacing" does not match expectations' );
+ $this->assertFalse( $settings['enableCustomUnits'], 'Value for array key "enableCustomUnits" does not match expectations' );
+
+ $this->assertSame(
+ $font_sizes,
+ $settings['fontSizes'],
+ 'Value for array key "fontSizes" does not match expectations'
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Data provider.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array
</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 2023-01-26 18:10:54 UTC (rev 55145)
+++ trunk/tests/phpunit/tests/theme/wpThemeJson.php 2023-01-26 18:37:47 UTC (rev 55146)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2645,7 +2645,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_editor_settings_custom_units_can_be_disabled() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_theme_support( 'custom-units', array() );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $actual = WP_Theme_JSON::get_from_editor_settings( get_default_block_editor_settings() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $actual = WP_Theme_JSON::get_from_editor_settings( get_classic_theme_supports_block_editor_settings() );
</ins><span class="cx" style="display: block; padding: 0 10px"> remove_theme_support( 'custom-units' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $expected = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2662,7 +2662,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_editor_settings_custom_units_can_be_enabled() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_theme_support( 'custom-units' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $actual = WP_Theme_JSON::get_from_editor_settings( get_default_block_editor_settings() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $actual = WP_Theme_JSON::get_from_editor_settings( get_classic_theme_supports_block_editor_settings() );
</ins><span class="cx" style="display: block; padding: 0 10px"> remove_theme_support( 'custom-units' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $expected = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2679,7 +2679,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_editor_settings_custom_units_can_be_filtered() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_theme_support( 'custom-units', 'rem', 'em' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $actual = WP_Theme_JSON::get_from_editor_settings( get_default_block_editor_settings() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $actual = WP_Theme_JSON::get_from_editor_settings( get_classic_theme_supports_block_editor_settings() );
</ins><span class="cx" style="display: block; padding: 0 10px"> remove_theme_support( 'custom-units' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $expected = array(
</span></span></pre>
</div>
</div>
</body>
</html>