Make WordPress Core


Ignore:
Timestamp:
02/11/2022 05:42:51 PM (2 years ago)
Author:
SergeyBiryukov
Message:

Docs: Update DocBlocks for some object cache functions per the documentation standards.

Follow-up to [47060], [47938], [47944], [52700].

See #54729, #54574.

File:
1 edited

Legend:

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

    r52700 r52703  
    3939if ( ! function_exists( 'wp_cache_delete_multiple' ) ) :
    4040    /**
    41      * Delete multiple values from the cache in one call.
     41     * Deletes multiple values from the cache in one call.
    4242     *
    4343     * Compat function to mimic wp_cache_delete_multiple().
     
    6666if ( ! function_exists( 'wp_cache_add_multiple' ) ) :
    6767    /**
    68      * Add multiple values to the cache in one call, if the cache keys doesn't already exist.
     68     * Adds multiple values to the cache in one call, if the cache keys don't already exist.
    6969     *
    7070     * Compat function to mimic wp_cache_add_multiple().
     
    7575     * @see wp_cache_add_multiple()
    7676     *
    77      * @param array  $data  Array of key and value to be added.
    78      * @param string $group Optional. Where the cache contents are grouped. Default empty.
    79      * @param int    $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
     77     * @param array  $data   Array of keys and values to be added.
     78     * @param string $group  Optional. Where the cache contents are grouped. Default empty.
     79     * @param int    $expire Optional. When to expire the cache contents, in seconds.
     80     *                       Default 0 (no expiration).
    8081     * @return array Array of return values.
    8182     */
     
    9394if ( ! function_exists( 'wp_cache_set_multiple' ) ) :
    9495    /**
    95      * Set multiple values to the cache in one call.
     96     * Sets multiple values to the cache in one call.
    9697     *
    9798     * Differs from wp_cache_add_multiple() in that it will always write data.
     
    104105     * @see wp_cache_set_multiple()
    105106     *
    106      * @param array  $data  Array of key and value to be set.
    107      * @param string $group Optional. Where the cache contents are grouped. Default empty.
    108      * @param int    $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
     107     * @param array  $data   Array of keys and values to be set.
     108     * @param string $group  Optional. Where the cache contents are grouped. Default empty.
     109     * @param int    $expire Optional. When to expire the cache contents, in seconds.
     110     *                       Default 0 (no expiration).
    109111     * @return array Array of return values.
    110112     */
Note: See TracChangeset for help on using the changeset viewer.