Changeset 52708 for trunk/src/wp-includes/cache-compat.php

Timestamp:

02/11/2022 07:19:57 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve @return tags for wp_cache_*_multiple() functions:

• wp_cache_add_multiple()
• wp_cache_set_multiple()
• wp_cache_get_multiple()
• wp_cache_delete_multiple()

This aims to provide more details about the returned value types.

Follow-up to [52700], [52702], [52703].

See #54729, #54574.

File:

• trunk/src/wp-includes/cache-compat.php (modified) (4 diffs)

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

@@ -24 +24 @@
      * @param int    $expire Optional. When to expire the cache contents, in seconds.
      *                       Default 0 (no expiration).
-     * @return array Array of return values.
+     * @return bool[] Array of return values, grouped by key. Each value is either
+     *                true on success, or false if cache key and group already exist.
      */
     function wp_cache_add_multiple( array $data, $group = '', $expire = 0 ) {
@@ -54 +55 @@
      * @param int    $expire Optional. When to expire the cache contents, in seconds.
      *                       Default 0 (no expiration).
-     * @return array Array of return values.
+     * @return bool[] Array of return values, grouped by key. Each value is either
+     *                true on success, or false on failure.
      */
     function wp_cache_set_multiple( array $data, $group = '', $expire = 0 ) {
@@ -82 +84 @@
      * @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.
+     * @return array Array of return values, grouped by key. Each value is either
+     *               the cache contents on success, or false on failure.
      */
     function wp_cache_get_multiple( $keys, $group = '', $force = false ) {
@@ -108 +111 @@
      * @param array  $keys  Array of keys under which the cache to deleted.
      * @param string $group Optional. Where the cache contents are grouped. Default empty.
-     * @return array Array of return values.
+     * @return bool[] Array of return values, grouped by key. Each value is either
+     *                true on success, or false if the contents were not deleted.
      */
     function wp_cache_delete_multiple( array $keys, $group = '' ) {