Changeset 55086 for trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php

Timestamp:

01/18/2023 11:38:16 AM (4 years ago)

Author:

hellofromTonya

Message:

Themes: Introduce wp_theme_has_theme_json() for public consumption.

Adds wp_theme_has_theme_json() for public consumption, to replace the private internal Core-only WP_Theme_JSON_Resolver::theme_has_support() method. This new global function checks if a theme or its parent has a theme.json file.

For performance, results are cached as an integer 1 or 0 in the 'theme_json' group with 'wp_theme_has_theme_json' key. This is a non-persistent cache. Why? To make the derived data from theme.json is always fresh from the potential modifications done via hooks that can use dynamic data (modify the stylesheet depending on some option, settings depending on user permissions, etc.).

Also adds a new public function wp_clean_theme_json_cache() to clear the cache on 'switch_theme' and start_previewing_theme'.

References:

• ​Gutenberg PR 45168 Add wp_theme_has_theme_json as a public API to know whether a theme has a theme.json.
• ​Gutenberg PR 45380 Deprecate WP_Theme_JSON_Resolver:theme_has_support().
• ​Gutenberg PR 46150 Make theme.json object caches non-persistent.
• ​Gutenberg PR 45979 Don't check if constants set by wp_initial_constants() are defined.
• ​Gutenberg PR 45950 Cleaner logic in wp_theme_has_theme_json.

Follow-up to [54493], [53282], [52744], [52049], [50959].

Props oandregal, afragen, alexstine, aristath, azaozz, costdev, flixos90, hellofromTonya, mamaduka, mcsf, ocean90, spacedmonkey.
Fixes #56975.

File:

• trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php (modified) (7 diffs)

trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php

@@ -111 +111 @@
 
                 // Reset data between tests.
-                WP_Theme_JSON_Resolver::clean_cached_data();
+                wp_clean_theme_json_cache();
                 parent::tear_down();
         }
@@ -377 +377 @@
          */
         public function test_get_core_data( $should_fire_filter, $core_is_cached, $blocks_are_cached ) {
-                WP_Theme_JSON_Resolver::clean_cached_data();
+                wp_clean_theme_json_cache();
 
                 // If should cache core, then fire the method to cache it before running the tests.
@@ -430 +430 @@
                         ),
                 );
-        }
-
-        /**
-         * @ticket 52991
-         */
-        public function test_switching_themes_recalculates_data() {
-                // The "default" theme doesn't have theme.json support.
-                switch_theme( 'default' );
-                $default = WP_Theme_JSON_Resolver::theme_has_support();
-
-                // Switch to a theme that does have support.
-                switch_theme( 'block-theme' );
-                $has_theme_json_support = WP_Theme_JSON_Resolver::theme_has_support();
-
-                $this->assertFalse( $default );
-                $this->assertTrue( $has_theme_json_support );
         }
 
@@ -483 +467 @@
                 remove_theme_support( 'appearance-tools' );
 
-                $this->assertFalse( WP_Theme_JSON_Resolver::theme_has_support() );
+                $this->assertFalse( wp_theme_has_theme_json() );
                 $this->assertTrue( $settings['typography']['lineHeight'] );
                 $this->assertSame( $color_palette, $settings['color']['palette']['theme'] );
@@ -644 +628 @@
                 for ( $i = 0; $i < 3; $i++ ) {
                         WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme );
-                        WP_Theme_JSON_Resolver::clean_cached_data();
+                        wp_clean_theme_json_cache();
                 }
                 $this->assertSame( 0, $global_styles_query_count, 'Unexpected SQL queries detected for the wp_global_style post type prior to creation.' );
@@ -657 +641 @@
                 for ( $i = 0; $i < 3; $i++ ) {
                         $new_user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme );
-                        WP_Theme_JSON_Resolver::clean_cached_data();
+                        wp_clean_theme_json_cache();
                         $this->assertSameSets( $user_cpt, $new_user_cpt, "User CPTs do not match on run {$i}." );
                 }
@@ -674 +658 @@
                 for ( $i = 0; $i < 3; $i++ ) {
                         WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme );
-                        WP_Theme_JSON_Resolver::clean_cached_data();
+                        wp_clean_theme_json_cache();
                 }
                 $query_count = get_num_queries() - $query_count;