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

Timestamp:

02/11/2022 05:42:51 PM (3 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:

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

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

@@ -39 +39 @@
 if ( ! function_exists( 'wp_cache_delete_multiple' ) ) :
     /**
-     * Delete multiple values from the cache in one call.
+     * Deletes multiple values from the cache in one call.
      *
      * Compat function to mimic wp_cache_delete_multiple().
@@ -66 +66 @@
 if ( ! function_exists( 'wp_cache_add_multiple' ) ) :
     /**
-     * Add multiple values to the cache in one call, if the cache keys doesn't already exist.
+     * Adds multiple values to the cache in one call, if the cache keys don't already exist.
      *
      * Compat function to mimic wp_cache_add_multiple().
@@ -75 +75 @@
      * @see wp_cache_add_multiple()
      *
-     * @param array  $data  Array of key and value to be added.
-     * @param string $group Optional. Where the cache contents are grouped. Default empty.
-     * @param int    $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
+     * @param array  $data   Array of keys and values to be added.
+     * @param string $group  Optional. Where the cache contents are grouped. Default empty.
+     * @param int    $expire Optional. When to expire the cache contents, in seconds.
+     *                       Default 0 (no expiration).
      * @return array Array of return values.
      */
@@ -93 +94 @@
 if ( ! function_exists( 'wp_cache_set_multiple' ) ) :
     /**
-     * Set multiple values to the cache in one call.
+     * Sets multiple values to the cache in one call.
      *
      * Differs from wp_cache_add_multiple() in that it will always write data.
@@ -104 +105 @@
      * @see wp_cache_set_multiple()
      *
-     * @param array  $data  Array of key and value to be set.
-     * @param string $group Optional. Where the cache contents are grouped. Default empty.
-     * @param int    $expire Optional. When to expire the cache contents, in seconds. Default 0 (no expiration).
+     * @param array  $data   Array of keys and values to be set.
+     * @param string $group  Optional. Where the cache contents are grouped. Default empty.
+     * @param int    $expire Optional. When to expire the cache contents, in seconds.
+     *                       Default 0 (no expiration).
      * @return array Array of return values.
      */