From 72cf1aa905ccc664968e90634aa4c601651f66f0 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Fri, 11 Feb 2022 18:31:48 +0000 Subject: [PATCH] Docs: Correct the suggested alternative for the deprecated `wp_cache_reset()` function. While this was previously added and reverted more than once as part of various documentation cleanup efforts, `wp_cache_switch_to_blog()` appears to be the correct alternative for `wp_cache_reset()`, per the latter's DocBlock. This commit also corrects the `@deprecated` tag for `WP_Object_Cache::reset()` to link to the `::switch_to_blog()` method of the class, instead of the function of the same name. Follow-up to [13066], [21403], [22111], [33678], [34225], [34226], [40929]. See #54729. git-svn-id: https://develop.svn.wordpress.org/trunk@52705 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/cache.php | 4 ++-- src/wp-includes/class-wp-object-cache.php | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/wp-includes/cache.php b/src/wp-includes/cache.php index 30257e02af..06c8647ef9 100644 --- a/src/wp-includes/cache.php +++ b/src/wp-includes/cache.php @@ -339,13 +339,13 @@ function wp_cache_add_non_persistent_groups( $groups ) { * recommended outside of unit tests as the performance penalty for using it is high. * * @since 3.0.0 - * @deprecated 3.5.0 WP_Object_Cache::reset() + * @deprecated 3.5.0 Use wp_cache_switch_to_blog() * @see WP_Object_Cache::reset() * * @global WP_Object_Cache $wp_object_cache Object cache global instance. */ function wp_cache_reset() { - _deprecated_function( __FUNCTION__, '3.5.0', 'WP_Object_Cache::reset()' ); + _deprecated_function( __FUNCTION__, '3.5.0', 'wp_cache_switch_to_blog()' ); global $wp_object_cache; diff --git a/src/wp-includes/class-wp-object-cache.php b/src/wp-includes/class-wp-object-cache.php index 2a93c53746..da32611974 100644 --- a/src/wp-includes/class-wp-object-cache.php +++ b/src/wp-includes/class-wp-object-cache.php @@ -461,11 +461,11 @@ class WP_Object_Cache { * * @since 3.0.0 * - * @deprecated 3.5.0 Use switch_to_blog() + * @deprecated 3.5.0 Use WP_Object_Cache::switch_to_blog() * @see switch_to_blog() */ public function reset() { - _deprecated_function( __FUNCTION__, '3.5.0', 'switch_to_blog()' ); + _deprecated_function( __FUNCTION__, '3.5.0', 'WP_Object_Cache::switch_to_blog()' ); // Clear out non-global caches since the blog ID has changed. foreach ( array_keys( $this->cache ) as $group ) {