Port cache group management from PR 3712

oandregal · oandregal · commit 073766ed9300 · 2022-12-13T18:15:10.000+01:00
diff --git a/src/wp-includes/default-filters.php b/src/wp-includes/default-filters.php
@@ -346,8 +346,8 @@
 add_action( 'init', '_register_core_block_patterns_and_categories' );
 add_action( 'init', 'check_theme_switched', 99 );
 add_action( 'init', array( 'WP_Block_Supports', 'init' ), 22 );
-add_action( 'switch_theme', array( 'WP_Theme_JSON_Resolver', 'clean_cached_data' ) );
-add_action( 'start_previewing_theme', array( 'WP_Theme_JSON_Resolver', 'clean_cached_data' ) );
+add_action( 'switch_theme', '_wp_clean_theme_json_caches' );
+add_action( 'start_previewing_theme', '_wp_clean_theme_json_caches' );
 add_action( 'after_switch_theme', '_wp_menus_changed' );
 add_action( 'after_switch_theme', '_wp_sidebars_changed' );
 add_action( 'wp_print_styles', 'print_emoji_styles' );
diff --git a/src/wp-includes/global-styles-and-settings.php b/src/wp-includes/global-styles-and-settings.php
@@ -264,6 +264,22 @@ function ( $item ) {
  * @return boolean
  */
 function wp_theme_has_theme_json() {
+	/**
+	 * By using the 'theme_json' group, this data is marked to be non-persistent across requests.
+	 * See `wp_cache_add_non_persistent_groups` in src/wp-includes/load.php and other places.
+	 *
+	 * The rationale for this is to make sure 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.).
+	 * See some of the existing hooks to modify theme.json behaviour:
+	 * https://make.wordpress.org/core/2022/10/10/filters-for-theme-json-data/
+	 *
+	 * A different alternative considered was to invalidate the cache upon certain
+	 * events such as options add/update/delete, user meta, etc.
+	 * It was judged not enough, hence this approach.
+	 * See https://github.com/WordPress/gutenberg/pull/45372
+	 */
 	$cache_group       = 'theme_json';
 	$cache_key         = 'wp_theme_has_theme_json';
 	$theme_has_support = wp_cache_get( $cache_key, $cache_group );
@@ -295,3 +311,14 @@ function wp_theme_has_theme_json() {
 
 	return (bool) $theme_has_support;
 }
+
+/**
+ * Private function to clean the caches under the theme_json group.
+ *
+ * @since 6.1.2
+ * @access private
+ */
+function _wp_clean_theme_json_caches() {
+	wp_cache_delete( 'wp_theme_has_theme_json', 'theme_json' );
+	WP_Theme_JSON_Resolver::clean_cached_data();
+}
diff --git a/src/wp-includes/load.php b/src/wp-includes/load.php
@@ -753,7 +753,7 @@ function wp_start_object_cache() {
 			)
 		);
 
-		wp_cache_add_non_persistent_groups( array( 'counts', 'plugins' ) );
+		wp_cache_add_non_persistent_groups( array( 'counts', 'plugins', 'theme_json' ) );
 	}
 
 	$first_init = false;
diff --git a/src/wp-includes/ms-blogs.php b/src/wp-includes/ms-blogs.php
@@ -575,7 +575,7 @@ function switch_to_blog( $new_blog_id, $deprecated = null ) {
 				);
 			}
 
-			wp_cache_add_non_persistent_groups( array( 'counts', 'plugins' ) );
+			wp_cache_add_non_persistent_groups( array( 'counts', 'plugins', 'theme_json' ) );
 		}
 	}
 
@@ -666,7 +666,7 @@ function restore_current_blog() {
 				);
 			}
 
-			wp_cache_add_non_persistent_groups( array( 'counts', 'plugins' ) );
+			wp_cache_add_non_persistent_groups( array( 'counts', 'plugins', 'theme_json' ) );
 		}
 	}
 
diff --git a/tests/phpunit/includes/abstract-testcase.php b/tests/phpunit/includes/abstract-testcase.php
@@ -401,7 +401,7 @@ public static function flush_cache() {
 			)
 		);
 
-		wp_cache_add_non_persistent_groups( array( 'counts', 'plugins' ) );
+		wp_cache_add_non_persistent_groups( array( 'counts', 'plugins', 'theme_json' ) );
 	}
 
 	/**

Original file line number	Diff line number	Diff line change
`@@ -753,7 +753,7 @@ function wp_start_object_cache() {`
`753`	`753`	`)`
`754`	`754`	`);`
`755`	`755`
`756`		`- wp_cache_add_non_persistent_groups( array( 'counts', 'plugins' ) );`
	`756`	`+ wp_cache_add_non_persistent_groups( array( 'counts', 'plugins', 'theme_json' ) );`
`757`	`757`	`}`
`758`	`758`
`759`	`759`	`$first_init = false;`
Original file line number	Diff line number	Diff line change
`@@ -575,7 +575,7 @@ function switch_to_blog( $new_blog_id, $deprecated = null ) {`
`575`	`575`	`);`
`576`	`576`	`}`
`577`	`577`
`578`		`- wp_cache_add_non_persistent_groups( array( 'counts', 'plugins' ) );`
	`578`	`+ wp_cache_add_non_persistent_groups( array( 'counts', 'plugins', 'theme_json' ) );`
`579`	`579`	`}`
`580`	`580`	`}`
`581`	`581`
`@@ -666,7 +666,7 @@ function restore_current_blog() {`
`666`	`666`	`);`
`667`	`667`	`}`
`668`	`668`
`669`		`- wp_cache_add_non_persistent_groups( array( 'counts', 'plugins' ) );`
	`669`	`+ wp_cache_add_non_persistent_groups( array( 'counts', 'plugins', 'theme_json' ) );`
`670`	`670`	`}`
`671`	`671`	`}`
`672`	`672`
Original file line number	Diff line number	Diff line change
`@@ -401,7 +401,7 @@ public static function flush_cache() {`
`401`	`401`	`)`
`402`	`402`	`);`
`403`	`403`
`404`		`- wp_cache_add_non_persistent_groups( array( 'counts', 'plugins' ) );`
	`404`	`+ wp_cache_add_non_persistent_groups( array( 'counts', 'plugins', 'theme_json' ) );`
`405`	`405`	`}`
`406`	`406`
`407`	`407`	`/**`