Changeset 34010 for trunk/src/wp-includes/cache.php

Timestamp:

09/10/2015 06:23:45 PM (9 years ago)

Author:

wonderboymusic

Message:

Clarify wp-includes/cache.php docs with some more precise language.

Props danielbachhuber.
Fixes #33734.

File:

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

trunk/src/wp-includes/cache.php

@@ -16 +16 @@
  * @global WP_Object_Cache $wp_object_cache
  *
- * @param int|string $key The cache key to use for retrieval later
- * @param mixed $data The data to add to the cache store
- * @param string $group The group to add the cache to
- * @param int $expire When the cache data should be expired
- * @return bool False if cache key and group already exist, true on success
+ * @param int|string $key The cache key to use for retrieval later.
+ * @param mixed $data The data to add to the cache.
+ * @param string $group The group to add the cache to. Enables the same key to be used across groups.
+ * @param int $expire When the cache data should expire, in seconds. Default is 0 (no expiry).
+ * @return bool False if cache key and group already exist, true on success.
  */
 function wp_cache_add( $key, $data, $group = '', $expire = 0 ) {
@@ -69 +69 @@
  * @global WP_Object_Cache $wp_object_cache
  *
- * @param int|string $key What the contents in the cache are called
- * @param string $group Where the cache contents are grouped
- * @return bool True on successful removal, false on failure
+ * @param int|string $key What the contents in the cache are called.
+ * @param string $group Where the cache contents are grouped.
+ * @return bool True on successful removal, false on failure.
  */
 function wp_cache_delete($key, $group = '') {
@@ -101 +101 @@
  * @global WP_Object_Cache $wp_object_cache
  *
- * @param int|string $key What the contents in the cache are called
- * @param string $group Where the cache contents are grouped
- * @param bool $force Whether to force an update of the local cache from the persistent cache (default is false)
+ * @param int|string $key The key under which the cache contents are stored.
+ * @param string $group Where the cache contents are grouped.
+ * @param bool $force Whether to force an update of the local cache from the persistent cache (default is false).
  * @param bool &$found Whether key was found in the cache. Disambiguates a return of false, a storable value.
  * @return bool|mixed False on failure to retrieve contents or the cache
@@ -121 +121 @@
  * @global WP_Object_Cache $wp_object_cache
  *
- * @param int|string $key The cache key to increment
+ * @param int|string $key The key for the cache contents that should be incremented.
  * @param int $offset The amount by which to increment the item's value. Default is 1.
  * @param string $group The group the key is in.
@@ -150 +150 @@
  * @global WP_Object_Cache $wp_object_cache
  *
- * @param int|string $key What to call the contents in the cache
- * @param mixed $data The contents to store in the cache
- * @param string $group Where to group the cache contents
- * @param int $expire When to expire the cache contents
- * @return bool False if not exists, true if contents were replaced
+ * @param int|string $key The key for the cache data that should be replaced.
+ * @param mixed $data The new data to store in the cache.
+ * @param string $group The group for the cache data that should be replaced.
+ * @param int $expire When to expire the cache contents, in seconds. Defaults to 0 (no expiry).
+ * @return bool False if original value does not exist, true if contents were replaced
  */
 function wp_cache_replace( $key, $data, $group = '', $expire = 0 ) {
@@ -165 +165 @@
  * Saves the data to the cache.
  *
- * @since 2.0.0
- *
- * @global WP_Object_Cache $wp_object_cache
- *
- * @param int|string $key What to call the contents in the cache
- * @param mixed $data The contents to store in the cache
- * @param string $group Where to group the cache contents
- * @param int $expire When to expire the cache contents
+ * Differs from wp_cache_add() and wp_cache_replace() in that it will always write data.
+ *
+ * @since 2.0.0
+ *
+ * @global WP_Object_Cache $wp_object_cache
+ *
+ * @param int|string $key The cache key to use for retrieval later.
+ * @param mixed $data The contents to store in the cache.
+ * @param string $group Where to group the cache contents. Enables the same key to be used across groups.
+ * @param int $expire When to expire the cache contents, in seconds. Defaults to 0 (no expiry).
  * @return bool False on failure, true on success
  */