Changeset 47944 for trunk/src/wp-includes/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/cache.php (modified) (2 diffs)

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 ) {