mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-06-28 14:20:15 +00:00
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. git-svn-id: https://develop.svn.wordpress.org/trunk@47944 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
@@ -270,12 +270,12 @@ class WP_Object_Cache {
|
||||
*
|
||||
* @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.
|
||||
*/
|
||||
public function get( $key, $group = 'default', $force = false, &$found = null ) {
|
||||
@@ -303,14 +303,14 @@ class WP_Object_Cache {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves multiple values from the cache.
|
||||
* Retrieves multiple values from the cache in one call.
|
||||
*
|
||||
* @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.
|
||||
* @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.
|
||||
*/
|
||||
public function get_multiple( $keys, $group = 'default', $force = false ) {
|
||||
|
||||
Reference in New Issue
Block a user