Changeset 52705

Timestamp:

02/11/2022 06:31:48 PM (3 years ago)

Author:

SergeyBiryukov

Message:

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.

Location:

trunk/src/wp-includes

Files:

• cache.php (modified) (2 diffs)
• class-wp-object-cache.php (modified) (1 diff)

trunk/src/wp-includes/cache.php

@@ -340 +340 @@
  *
  * @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()
  *
@@ -346 +346 @@
  */
 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;

trunk/src/wp-includes/class-wp-object-cache.php

@@ -462 +462 @@
      * @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.