Changeset 55146

Timestamp:

01/26/2023 06:37:47 PM (23 months ago)

Author:

flixos90

Message:

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 #57547.

Location:

trunk

Files:

• src/wp-includes/block-editor.php (modified) (3 diffs)
• src/wp-includes/class-wp-theme-json-resolver.php (modified) (1 diff)
• tests/phpunit/tests/blocks/editor.php (modified) (1 diff)
• tests/phpunit/tests/theme/wpThemeJson.php (modified) (3 diffs)

trunk/src/wp-includes/block-editor.php

@@ -217 +217 @@
         'defaultEditorStyles'              => $default_editor_styles,
         'blockCategories'                  => get_default_block_categories(),
-        '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' ),
         'isRTL'                            => is_rtl(),
         'imageDefaultSize'                 => $image_default_size,
@@ -234 +227 @@
     );
 
-    // Theme settings.
-    $color_palette = current( (array) get_theme_support( 'editor-color-palette' ) );
-    if ( false !== $color_palette ) {
-        $editor_settings['colors'] = $color_palette;
-    }
-
-    $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;
+    $theme_settings = get_classic_theme_supports_block_editor_settings();
+    foreach ( $theme_settings as $key => $value ) {
+        $editor_settings[ $key ] = $value;
     }
 
@@ -695 +677 @@
     return $styles;
 }
+
+/**
+ * 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;
+}

trunk/src/wp-includes/class-wp-theme-json-resolver.php

@@ -287 +287 @@
          * and merge the static::$theme upon that.
          */
-        $theme_support_data = WP_Theme_JSON::get_from_editor_settings( get_default_block_editor_settings() );
+        $theme_support_data = WP_Theme_JSON::get_from_editor_settings( get_classic_theme_supports_block_editor_settings() );
         if ( ! wp_theme_has_theme_json() ) {
             if ( ! isset( $theme_support_data['settings']['color'] ) ) {

trunk/tests/phpunit/tests/blocks/editor.php

@@ -570 +570 @@
 
     /**
+     * @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'
+        );
+    }
+
+    /**
      * Data provider.
      *

trunk/tests/phpunit/tests/theme/wpThemeJson.php

@@ -2646 +2646 @@
     public function test_get_editor_settings_custom_units_can_be_disabled() {
         add_theme_support( 'custom-units', array() );
-        $actual = WP_Theme_JSON::get_from_editor_settings( get_default_block_editor_settings() );
+        $actual = WP_Theme_JSON::get_from_editor_settings( get_classic_theme_supports_block_editor_settings() );
         remove_theme_support( 'custom-units' );
 
@@ -2663 +2663 @@
     public function test_get_editor_settings_custom_units_can_be_enabled() {
         add_theme_support( 'custom-units' );
-        $actual = WP_Theme_JSON::get_from_editor_settings( get_default_block_editor_settings() );
+        $actual = WP_Theme_JSON::get_from_editor_settings( get_classic_theme_supports_block_editor_settings() );
         remove_theme_support( 'custom-units' );
 
@@ -2680 +2680 @@
     public function test_get_editor_settings_custom_units_can_be_filtered() {
         add_theme_support( 'custom-units', 'rem', 'em' );
-        $actual = WP_Theme_JSON::get_from_editor_settings( get_default_block_editor_settings() );
+        $actual = WP_Theme_JSON::get_from_editor_settings( get_classic_theme_supports_block_editor_settings() );
         remove_theme_support( 'custom-units' );