Changeset 47944 for trunk/src/wp-includes/class-wp-object-cache.php

Timestamp:

06/10/2020 09:55:56 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing documentation for the $group parameter of WP_Object_Cache::get_multiple().

Synchronize documentation between wp_cache_get_multiple(), its compat version, and the class method.

See #20875.

File:

• trunk/src/wp-includes/class-wp-object-cache.php (modified) (2 diffs)

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

@@ -271 +271 @@
      * @since 2.0.0
      *
-     * @param int|string $key    What the contents in the cache are called.
-     * @param string     $group  Optional. Where the cache contents are grouped. Default 'default'.
-     * @param bool       $force  Optional. Unused. Whether to force a refetch rather than relying on the local
-     *                           cache. Default false.
-     * @param bool       $found  Optional. Whether the key was found in the cache (passed by reference).
-     *                           Disambiguates a return of false, a storable value. Default null.
+     * @param int|string $key   The key under which the cache contents are stored.
+     * @param string     $group Optional. Where the cache contents are grouped. Default 'default'.
+     * @param bool       $force Optional. Unused. Whether to force an update of the local cache
+     *                          from the persistent cache. Default false.
+     * @param bool       $found Optional. Whether the key was found in the cache (passed by reference).
+     *                          Disambiguates a return of false, a storable value. Default null.
      * @return mixed|false The cache contents on success, false on failure to retrieve contents.
      */
@@ -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.
-     *
+     * Retrieves multiple values from the cache in one call.
+     *
+     * @since 5.5.0
+     *
+     * @param array  $keys  Array of keys under which the cache contents are stored.
+     * @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 Array of values organized into groups.
      */