Editor: Use a non-persistent object cache instead of transient in wp_get_global_stylesheet().

This changeset is part of a greater effort to enhance the caching strategy for theme.json based data. Similar to [55138], [55148], and [55155], the cache is currently ignored when `WP_DEBUG` is on to avoid interrupting the theme developer's workflow.

Props spacedmonkey, oandregal, flixos90, ajlende, hellofromtonya.
Fixes #57568.


git-svn-id: https://develop.svn.wordpress.org/trunk@55185 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Felix Arntz 2023-02-01 22:57:04 +00:00
parent 888e139a94
commit 6b4b2eb60f
2 changed files with 49 additions and 12 deletions

View File

@ -233,17 +233,17 @@ function wp_get_global_stylesheet( $types = array() ) {
* @return string
*/
function wp_get_global_styles_svg_filters() {
// Return cached value if it can be used and exists.
// It's cached by theme to make sure that theme switching clears the cache.
$can_use_cached = (
( ! defined( 'WP_DEBUG' ) || ! WP_DEBUG ) &&
( ! defined( 'SCRIPT_DEBUG' ) || ! SCRIPT_DEBUG ) &&
( ! defined( 'REST_REQUEST' ) || ! REST_REQUEST ) &&
! is_admin()
);
$transient_name = 'global_styles_svg_filters_' . get_stylesheet();
/*
* Ignore cache when `WP_DEBUG` is enabled, so it doesn't interfere with the theme
* developer's workflow.
*
* @todo Replace `WP_DEBUG` once an "in development mode" check is available in Core.
*/
$can_use_cached = ! WP_DEBUG;
$cache_group = 'theme_json';
$cache_key = 'wp_get_global_styles_svg_filters';
if ( $can_use_cached ) {
$cached = get_transient( $transient_name );
$cached = wp_cache_get( $cache_key, $cache_group );
if ( $cached ) {
return $cached;
}
@ -260,8 +260,7 @@ function wp_get_global_styles_svg_filters() {
$svgs = $tree->get_svg_filters( $origins );
if ( $can_use_cached ) {
// Cache for a minute, same as wp_get_global_stylesheet.
set_transient( $transient_name, $svgs, MINUTE_IN_SECONDS );
wp_cache_set( $cache_key, $svgs, $cache_group );
}
return $svgs;
@ -367,6 +366,7 @@ function wp_theme_has_theme_json() {
*/
function wp_clean_theme_json_cache() {
wp_cache_delete( 'wp_get_global_stylesheet', 'theme_json' );
wp_cache_delete( 'wp_get_global_styles_svg_filters', 'theme_json' );
wp_cache_delete( 'wp_get_global_settings_custom', 'theme_json' );
wp_cache_delete( 'wp_get_global_settings_theme', 'theme_json' );
WP_Theme_JSON_Resolver::clean_cached_data();

View File

@ -0,0 +1,37 @@
<?php
/**
* Tests wp_get_global_styles_svg_filters().
*
* @group themes
*/
class Tests_Theme_wpGetGlobalStylesSvgFilters extends WP_UnitTestCase {
public function set_up() {
parent::set_up();
// Clear caches.
wp_clean_themes_cache();
}
public function tear_down() {
wp_clean_themes_cache();
parent::tear_down();
}
/**
* Tests that switching themes recalculates the svgs.
*
* @covers ::wp_get_global_styles_svg_filters
*
* @ticket 57568
*/
public function test_switching_themes_should_recalculate_svg() {
$svg_for_default_theme = wp_get_global_styles_svg_filters();
switch_theme( 'block-theme' );
$svg_for_block_theme = wp_get_global_styles_svg_filters();
switch_theme( WP_DEFAULT_THEME );
$this->assertStringContainsString( '<svg', $svg_for_default_theme, 'Default theme should contain SVG' );
$this->assertStringContainsString( '<svg', $svg_for_default_theme, 'Block theme should contain SVG' );
$this->assertNotSame( $svg_for_default_theme, $svg_for_block_theme, 'Cache value should have changed' );
}
}