Changeset 54448

Timestamp:

10/10/2022 06:20:28 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Cache API: Introduce wp_cache_supports() function.

WordPress has recently introduced a variety of caching API improvements:

• wp_cache_add_multiple()
• wp_cache_set_multiple()
• wp_cache_get_multiple()
• wp_cache_delete_multiple()
• wp_cache_flush_runtime()
• wp_cache_flush_group()

Although WordPress core provides a compatibility layer if these functions are missing from third-party object cache implementations, there should be a method of checking whether the cache backend supports a particular feature.

This commit aims to improve developer experience by allowing third-party object cache plugins to declare a wp_cache_supports() function and correctly list their supported features:

• add_multiple
• set_multiple
• get_multiple
• delete_multiple
• flush_runtime
• flush_group

Note: The wp_cache_supports() function replaces and supersedes the wp_cache_supports_group_flush() function added earlier.

Follow-up to [47938], [47944], [52700], [52703], [52706], [52708], [53763], [53767], [54423].

Props johnjamesjacoby, tillkruess, spacedmonkey, SergeyBiryukov.
Fixes #56605.

Location:

trunk

Files:

• src/wp-includes/cache-compat.php (modified) (4 diffs)
• src/wp-includes/cache.php (modified) (2 diffs)
• tests/phpunit/includes/object-cache.php (modified) (1 diff)
• tests/phpunit/tests/pluggable.php (modified) (1 diff)

trunk/src/wp-includes/cache-compat.php

@@ -139 +139 @@
      */
     function wp_cache_flush_runtime() {
-        return wp_using_ext_object_cache() ? false : wp_cache_flush();
+        if ( ! wp_cache_supports( 'flush_runtime' ) ) {
+            _doing_it_wrong(
+                __FUNCTION__,
+                __( 'Your object cache implementation does not support flushing the in-memory runtime cache.' ),
+                '6.1.0'
+            );
+
+            return false;
+        }
+
+        return wp_cache_flush();
     }
 endif;
@@ -148 +158 @@
      *
      * Before calling this function, always check for group flushing support using the
-     * `wp_cache_supports_group_flush()` function.
+     * `wp_cache_supports( 'flush_group' )` function.
      *
      * @since 6.1.0
@@ -161 +171 @@
         global $wp_object_cache;
 
-        if ( ! wp_cache_supports_group_flush() ) {
+        if ( ! wp_cache_supports( 'flush_group' ) ) {
             _doing_it_wrong(
                 __FUNCTION__,
@@ -175 +185 @@
 endif;
 
-if ( ! function_exists( 'wp_cache_supports_group_flush' ) ) :
-    /**
-     * Determines whether the object cache implementation supports flushing individual cache groups.
+if ( ! function_exists( 'wp_cache_supports' ) ) :
+    /**
+     * Determines whether the object cache implementation supports a particular feature.
      *
      * @since 6.1.0
      *
-     * @see WP_Object_Cache::flush_group()
-     *
-     * @return bool True if group flushing is supported, false otherwise.
-     */
-    function wp_cache_supports_group_flush() {
+     * @param string $feature Name of the feature to check for. Possible values include:
+     *                        'add_multiple', 'set_multiple', 'get_multiple', 'delete_multiple',
+     *                        'flush_runtime', 'flush_group'.
+     * @return bool True if the feature is supported, false otherwise.
+     */
+    function wp_cache_supports( $feature ) {
         return false;
     }

trunk/src/wp-includes/cache.php

@@ -286 +286 @@
  *
  * Before calling this function, always check for group flushing support using the
- * `wp_cache_supports_group_flush()` function.
+ * `wp_cache_supports( 'flush_group' )` function.
  *
  * @since 6.1.0
@@ -303 +303 @@
 
 /**
- * Determines whether the object cache implementation supports flushing individual cache groups.
+ * Determines whether the object cache implementation supports a particular feature.
  *
  * @since 6.1.0
  *
- * @see WP_Object_Cache::flush_group()
- *
- * @return bool True if group flushing is supported, false otherwise.
- */
-function wp_cache_supports_group_flush() {
-    return true;
+ * @param string $feature Name of the feature to check for. Possible values include:
+ *                        'add_multiple', 'set_multiple', 'get_multiple', 'delete_multiple',
+ *                        'flush_runtime', 'flush_group'.
+ * @return bool True if the feature is supported, false otherwise.
+ */
+function wp_cache_supports( $feature ) {
+    switch ( $feature ) {
+        case 'add_multiple':
+        case 'set_multiple':
+        case 'get_multiple':
+        case 'delete_multiple':
+        case 'flush_runtime':
+        case 'flush_group':
+            return true;
+
+        default:
+            return false;
+    }
 }
 

trunk/tests/phpunit/includes/object-cache.php

@@ -314 +314 @@
 
 /**
- * Whether the object cache implementation supports flushing individual cache groups.
+ * Determines whether the object cache implementation supports a particular feature.
  *
  * @since 6.1.0
  *
- * @return bool True if group flushing is supported, false otherwise.
- */
-function wp_cache_supports_group_flush() {
+ * @param string $feature Name of the feature to check for. Possible values include:
+ *                        'add_multiple', 'set_multiple', 'get_multiple', 'delete_multiple',
+ *                        'flush_runtime', 'flush_group'.
+ * @return bool True if the feature is supported, false otherwise.
+ */
+function wp_cache_supports( $feature ) {
     return false;
 }

trunk/tests/phpunit/tests/pluggable.php

@@ -327 +327 @@
                     'wp_cache_flush_runtime'             => array(),
                     'wp_cache_flush_group'               => array( 'group' ),
-                    'wp_cache_supports_group_flush'      => array(),
+                    'wp_cache_supports'                  => array( 'feature' ),
                     'wp_cache_close'                     => array(),
                     'wp_cache_add_global_groups'         => array( 'groups' ),