WordPress.org

Make WordPress Core


Ignore:
Timestamp:
06/10/2020 09:55:56 AM (18 months 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-object-cache.php

    r47938 r47944  
    271271     * @since 2.0.0
    272272     *
    273      * @param int|string $key    What the contents in the cache are called.
    274      * @param string     $group  Optional. Where the cache contents are grouped. Default 'default'.
    275      * @param bool       $force  Optional. Unused. Whether to force a refetch rather than relying on the local
    276      *                          cache. Default false.
    277      * @param bool       $found  Optional. Whether the key was found in the cache (passed by reference).
    278      *                           Disambiguates a return of false, a storable value. Default null.
     273     * @param int|string $key   The key under which the cache contents are stored.
     274     * @param string     $group Optional. Where the cache contents are grouped. Default 'default'.
     275     * @param bool       $force Optional. Unused. Whether to force an update of the local cache
     276     *                          from the persistent cache. Default false.
     277     * @param bool       $found Optional. Whether the key was found in the cache (passed by reference).
     278     *                          Disambiguates a return of false, a storable value. Default null.
    279279     * @return mixed|false The cache contents on success, false on failure to retrieve contents.
    280280     */
     
    304304
    305305    /**
    306      * Retrieves multiple values from the cache.
    307      *
    308      * @since  5.5.0
    309      *
    310      * @param array $keys        Array of keys to fetch.
    311      * @param bool  $force       Optional. Unused. Whether to force a refetch rather than relying on the local
    312      *                           cache. Default false.
    313      *
     306     * Retrieves multiple values from the cache in one call.
     307     *
     308     * @since 5.5.0
     309     *
     310     * @param array  $keys  Array of keys under which the cache contents are stored.
     311     * @param string $group Optional. Where the cache contents are grouped. Default empty.
     312     * @param bool   $force Optional. Whether to force an update of the local cache
     313     *                      from the persistent cache. Default false.
    314314     * @return array Array of values organized into groups.
    315315     */
Note: See TracChangeset for help on using the changeset viewer.