Changeset 47944

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.

Location:

trunk/src/wp-includes

Files:

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

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

@@ -11 +11 @@
 if ( ! function_exists( 'wp_cache_get_multiple' ) ) :
     /**
-     * Compat function to mimic wp_cache_get_multiple.
-     * Retrieves multiple values from the cache.
+     * Retrieves multiple values from the cache in one call.
+     *
+     * Compat function to mimic wp_cache_get_multiple().
      *
      * @ignore
@@ -19 +20 @@
      * @see wp_cache_get_multiple()
      *
-     * @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.
-     *
+     * @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.
      */
-    function wp_cache_get_multiple( $keys, $group = 'default', $force = false ) {
+    function wp_cache_get_multiple( $keys, $group = '', $force = false ) {
         $values = array();
 

trunk/src/wp-includes/cache.php

@@ -114 +114 @@
  * @param int|string  $key    The key 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.
+ * @param bool        $force  Optional. 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 bool|mixed False on failure to retrieve contents or the cache
- *                    contents on success
+ * @return mixed|false The cache contents on success, false on failure to retrieve contents.
  */
 function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {
@@ -128 +127 @@
 
 /**
- * Gets multiple values from cache in one call.
+ * Retrieves multiple values from the 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.
+ * @global WP_Object_Cache $wp_object_cache Object cache global instance.
+ *
+ * @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.
  */
 function wp_cache_get_multiple( $keys, $group = '', $force = false ) {

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.
      */