Changeset 47938

Timestamp:

06/09/2020 07:45:27 PM (4 years ago)

Author:

whyisjake

Message:

Cache API: Introduce wp_cache_get_multi().

Many caching backend have support for multiple gets in a single request. This brings that support to core, with a compatability fallback that will loop over requests if needed.

Fixes: #20875.
Props: nacin, tollmanz, wonderboymusic, ryan, jeremyfelt, spacedmonkey, boonebgorges, dd32, rmccue, ocean90, jipmoors, johnjamesjacoby, tillkruess, donmhico, davidbaumwald, SergeyBiryukov, whyisjake.

Location:

trunk

Files:

• src/wp-includes/cache.php (modified) (1 diff)
• src/wp-includes/class-wp-object-cache.php (modified) (1 diff)
• src/wp-includes/load.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.php

@@ -128 +128 @@
 
 /**
+ * Gets multiple values from cache in one call.
+ *
+ * @since 5.5.0
+ * @see WP_Object_Cache::get_multiple()
+ *
+ * @param array       $keys   Array of keys to get from group.
+ * @param string      $group  Optional. Where the cache contents are grouped. Default empty.
+ * @param bool        $force  Optional. Whether to force an update of the local cache from the persistent
+ *                            cache. Default false.
+ * @return array|bool Array of values.
+ */
+function wp_cache_get_multiple( $keys, $group = '', $force = false ) {
+    global $wp_object_cache;
+
+    return $wp_object_cache->get_multiple( $keys, $group, $force );
+}
+
+/**
  * Increment numeric cache item's value
  *

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

@@ -304 +304 @@
 
     /**
+     * Retrieves multiple values from the cache.
+     *
+     * @since  5.5.0
+     *
+     * @param array $keys        Array of keys to fetch.
+     * @param bool  $force       Optional. Unused. Whether to force a refetch rather than relying on the local
+     *                           cache. Default false.
+     *
+     * @return array Array of values organized into groups.
+     */
+    public function get_multiple( $keys, $group = 'default', $force = false ) {
+        $values = array();
+
+        foreach ( $keys as $key ) {
+            $values[ $key ] = $this->get( $key, $group, $force );
+        }
+
+        return $values;
+    }
+
+    /**
      * Increments numeric cache item's value.
      *

trunk/src/wp-includes/load.php

@@ -629 +629 @@
     }
 
+    require_once( ABSPATH . WPINC . '/cache-compat.php' );
+
     /*
      * If cache supports reset, reset instead of init if already

trunk/tests/phpunit/tests/cache.php

@@ -316 +316 @@
         $this->assertFalse( wp_cache_get( $fake_key ) );
     }
+
+    /**
+     * @ticket 20875
+     */
+    public function test_get_multiple() {
+        wp_cache_set( 'foo1', 'bar', 'group1' );
+        wp_cache_set( 'foo2', 'bar', 'group1' );
+        wp_cache_set( 'foo1', 'bar', 'group2' );
+
+        $found = wp_cache_get_multiple( array( 'foo1', 'foo2', 'foo3', ), 'group1' );
+
+        $expected = array(
+            'foo1' => 'bar',
+            'foo2' => 'bar',
+            'foo3' => false,
+        );
+
+        $this->assertSame( $expected, $found );
+    }
 }

trunk/tests/phpunit/tests/pluggable.php

@@ -291 +291 @@
                         'found' => null,
                     ),
+                    'wp_cache_get_multiple'              => array(
+                        'keys',
+                        'group' => '',
+                        'force' => false,
+                    ),
                     'wp_cache_incr'                      => array(
                         'key',