Changeset 55138

Timestamp:

01/25/2023 07:36:58 PM (4 years ago)

Author:

hellofromTonya

Message:

Themes: Add static cache variable to wp_theme_has_theme_json().

For performance, a static variable is added to wp_theme_has_theme_json() to cache the boolean result of determining if a theme (or its parent) has a theme.json file.

This cache avoids the overhead of calling get_stylesheet_directory() and get_template_directory() each time wp_theme_has_theme_json() is invoked.

The cache is lean, non-persistent, and encapsulated within the function (i.e. function scope and not available externally).

The cache is ignored when:

• WP_DEBUG is on to avoid interrupting theme developer's workflow and for extender automated test suites.
• WP_RUN_CORE_TESTS is on to ensure each Core test exercises the checking code.

Follow-up to [55092], [55086].

Props oandregal, azaozz, costdev, dmsnell, flixos90, hellofromTonya, Otto42, spacedmonkey.
Fixes #56975.

File:

• trunk/src/wp-includes/global-styles-and-settings.php (modified) (1 diff)

trunk/src/wp-includes/global-styles-and-settings.php

@@ -265 +265 @@
  */
 function wp_theme_has_theme_json() {
+        static $theme_has_support = null;
+
+        if (
+                null !== $theme_has_support &&
+                /*
+                 * Ignore static cache when `WP_DEBUG` is enabled. Why? To avoid interfering with
+                 * the theme developer's workflow.
+                 *
+                 * @todo Replace `WP_DEBUG` once an "in development mode" check is available in Core.
+                 */
+                ! WP_DEBUG &&
+                /*
+                 * Ignore cache when automated test suites are running. Why? To ensure
+                 * the static cache is reset between each test.
+                 */
+                ! ( defined( 'WP_RUN_CORE_TESTS' ) && WP_RUN_CORE_TESTS )
+        ) {
+                return $theme_has_support;
+        }
+
         // Does the theme have its own theme.json?
         $theme_has_support = is_readable( get_stylesheet_directory() . '/theme.json' );