Changeset 52700

Timestamp:

02/11/2022 12:50:54 PM (3 years ago)

Author:

spacedmonkey

Message:

Cache: Add wp_cache_*_multiple functions.

Add new caching functions named wp_cache_add_multiple, wp_cache_set_multiple and wp_cache_delete_multiple. All of these functions allow for an array of data to be passed, so that multiple cache objects can be created / edited / deleted in a single function call. This follows on from [47938] where the wp_cache_get_multiple function was introduced and allowed for multiple cache objects to be received in one call.

Props: spacedmonkey, tillkruess, adamsilverstein, flixos90, mitogh, pbearne.
Fixes: #54574.

Location:

trunk

Files:

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

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

@@ -36 +36 @@
     }
 endif;
+
+if ( ! function_exists( 'wp_cache_delete_multiple' ) ) :
+    /**
+     * Delete multiple values from the cache in one call.
+     *
+     * Compat function to mimic wp_cache_delete_multiple().
+     *
+     * @ignore
+     * @since 6.0.0
+     *
+     * @see wp_cache_delete_multiple()
+     *
+     * @param array  $keys  Array of keys under which the cache to deleted.
+     * @param string $group Optional. Where the cache contents are grouped. Default empty.
+     * @return array Array of return values.
+     */
+    function wp_cache_delete_multiple( array $keys, $group = '' ) {
+        $values = array();
+
+        foreach ( $keys as $key ) {
+            $values[ $key ] = wp_cache_delete( $key, $group );
+        }
+
+        return $values;
+    }
+endif;
+
+
+if ( ! function_exists( 'wp_cache_add_multiple' ) ) :
+    /**
+     * Add multiple values to the cache in one call, if the cache keys doesn't already exist.
+     *
+     * Compat function to mimic wp_cache_add_multiple().
+     *
+     * @ignore
+     * @since 6.0.0
+     *
+     * @see wp_cache_add_multiple()
+     *
+     * @param array  $data  Array of key and value to be added.
+     * @param string $group Optional. Where the cache contents are grouped. Default empty.
+     * @param int    $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
+     * @return array Array of return values.
+     */
+    function wp_cache_add_multiple( array $data, $group = '', $expire = 0 ) {
+        $values = array();
+
+        foreach ( $data as $key => $value ) {
+            $values[ $key ] = wp_cache_add( $key, $value, $group, $expire );
+        }
+
+        return $values;
+    }
+endif;
+
+if ( ! function_exists( 'wp_cache_set_multiple' ) ) :
+    /**
+     * Set multiple values to the cache in one call.
+     *
+     * Differs from wp_cache_add_multiple() in that it will always write data.
+     *
+     * Compat function to mimic wp_cache_set_multiple().
+     *
+     * @ignore
+     * @since 6.0.0
+     *
+     * @see wp_cache_set_multiple()
+     *
+     * @param array  $data  Array of key and value to be set.
+     * @param string $group Optional. Where the cache contents are grouped. Default empty.
+     * @param int    $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
+     * @return array Array of return values.
+     */
+    function wp_cache_set_multiple( array $data, $group = '', $expire = 0 ) {
+        $values = array();
+
+        foreach ( $data as $key => $value ) {
+            $values[ $key ] = wp_cache_set( $key, $value, $group, $expire );
+        }
+
+        return $values;
+    }
+endif;

trunk/src/wp-includes/cache.php

@@ -146 +146 @@
 }
 
+
+/**
+ * Delete multiple values from the cache in one call.
+ *
+ * @since 6.0.0
+ *
+ * @see WP_Object_Cache::delete_multiple()
+ * @global WP_Object_Cache $wp_object_cache Object cache global instance.
+ *
+ * @param array  $keys  Array of keys under which the cache to deleted.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @return array Array of return values organized into groups.
+ */
+function wp_cache_delete_multiple( array $keys, $group = '' ) {
+    global $wp_object_cache;
+
+    return $wp_object_cache->delete_multiple( $keys, $group );
+}
+
+/**
+ * Add multiple values to the cache in one call.
+ *
+ * @since 6.0.0
+ *
+ * @see WP_Object_Cache::add_multiple()
+ * @global WP_Object_Cache $wp_object_cache Object cache global instance.
+ *
+ * @param array  $data  Array of key and value to be set.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @param int    $expire Optional. When to expire the cache contents, in seconds.
+ *                           Default 0 (no expiration).
+ * @return array Array of return values.
+ */
+function wp_cache_add_multiple( array $data, $group = '', $expire = 0 ) {
+    global $wp_object_cache;
+
+    return $wp_object_cache->add_multiple( $data, $group, $expire );
+}
+
+/**
+ * Set multiple values to the cache in one call.
+ *
+ * @since 6.0.0
+ *
+ * @see WP_Object_Cache::set_multiple()
+ * @global WP_Object_Cache $wp_object_cache Object cache global instance.
+ *
+ * @param array  $data  Array of key and value to be set.
+ * @param string $group Optional. Where the cache contents are grouped. Default empty.
+ * @param int    $expire Optional. When to expire the cache contents, in seconds.
+ *                           Default 0 (no expiration).
+ * @return array Array of return values.
+ */
+function wp_cache_set_multiple( array $data, $group = '', $expire = 0 ) {
+    global $wp_object_cache;
+
+    return $wp_object_cache->set_multiple( $data, $group, $expire );
+}
+
 /**
  * Increment numeric cache item's value

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

@@ -325 +325 @@
 
     /**
+     * Delete multiple values from the cache in one call.
+     *
+     * @since 6.0.0
+     *
+     * @param array  $keys  Array of keys to be deleted.
+     * @param string $group Optional. Where the cache contents are grouped. Default empty.
+     * @return array Array of return values.
+     */
+    public function delete_multiple( array $keys, $group = '' ) {
+        $values = array();
+
+        foreach ( $keys as $key ) {
+            $values[ $key ] = $this->delete( $key, $group );
+        }
+
+        return $values;
+    }
+
+    /**
+     * Add multiple values to the cache in one call.
+     *
+     * @since 6.0.0
+     *
+     * @param array  $data   Array of key and value to be added.
+     * @param string $group  Optional. Where the cache contents are grouped. Default empty.
+     * @param int    $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
+     * @return array Array of return values.
+     */
+    public function add_multiple( array $data, $group = '', $expire = 0 ) {
+        $values = array();
+
+        foreach ( $data as $key => $value ) {
+            $values[ $key ] = $this->add( $key, $value, $group, $expire );
+        }
+
+        return $values;
+    }
+
+    /**
+     * Set multiple values to the cache in one call.
+     *
+     * @since 6.0.0
+     *
+     * @param array  $data   Array of key and value to be set.
+     * @param string $group  Optional. Where the cache contents are grouped. Default empty.
+     * @param int    $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
+     * @return array Array of return values.
+     */
+    public function set_multiple( array $data, $group = '', $expire = 0 ) {
+        $values = array();
+
+        foreach ( $data as $key => $value ) {
+            $values[ $key ] = $this->set( $key, $value, $group, $expire );
+        }
+
+        return $values;
+    }
+
+    /**
      * Increments numeric cache item's value.
      *

trunk/tests/phpunit/tests/cache.php

@@ -350 +350 @@
         $this->assertSame( $expected, $found );
     }
+
+    /**
+     * @ticket 54574
+     */
+    public function test_wp_cache_add_multiple() {
+        $found = wp_cache_add_multiple(
+            array(
+                'foo1' => 'bar',
+                'foo2' => 'bar',
+                'foo3' => 'bar',
+            ),
+            'group1'
+        );
+
+        $expected = array(
+            'foo1' => true,
+            'foo2' => true,
+            'foo3' => true,
+        );
+
+        $this->assertSame( $expected, $found );
+    }
+
+    /**
+     * @ticket 54574
+     */
+    public function test_wp_cache_set_multiple() {
+        wp_cache_set( 'foo1', 'bar', 'group1' );
+        wp_cache_set( 'foo2', 'bar', 'group1' );
+        wp_cache_set( 'foo3', 'bar', 'group2' );
+
+        $found = wp_cache_set_multiple(
+            array(
+                'foo1' => 'bar',
+                'foo2' => 'bar',
+                'foo3' => 'bar',
+            ),
+            'group1'
+        );
+
+        $expected = array(
+            'foo1' => true,
+            'foo2' => true,
+            'foo3' => true,
+        );
+
+        $this->assertSame( $expected, $found );
+    }
+
+    /**
+     * @ticket 54574
+     */
+    public function test_wp_cache_delete_multiple() {
+        wp_cache_set( 'foo1', 'bar', 'group1' );
+        wp_cache_set( 'foo2', 'bar', 'group1' );
+        wp_cache_set( 'foo3', 'bar', 'group2' );
+
+        $found = wp_cache_delete_multiple(
+            array( 'foo1', 'foo2', 'foo3' ),
+            'group1'
+        );
+
+        $expected = array(
+            'foo1' => true,
+            'foo2' => true,
+            'foo3' => false,
+        );
+
+        $this->assertSame( $expected, $found );
+    }
 }

trunk/tests/phpunit/tests/pluggable.php

@@ -296 +296 @@
                         'force' => false,
                     ),
+                    'wp_cache_set_multiple'              => array(
+                        'data',
+                        'group'  => '',
+                        'expire' => 0,
+                    ),
+                    'wp_cache_add_multiple'              => array(
+                        'data',
+                        'group'  => '',
+                        'expire' => 0,
+                    ),
+                    'wp_cache_delete_multiple'           => array(
+                        'keys',
+                        'group' => '',
+                    ),
                     'wp_cache_incr'                      => array(
                         'key',