* Adds data to the cache, if the cache key doesn't already exist.
*
* @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::add()
+ *
+ * @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
*
* @since 2.0.0
*
- * @return bool Always returns True
+ * @return true Always returns True
*/
function wp_cache_close() {
return true;
* Decrement numeric cache item's value
*
* @since 3.3.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::decr()
+ *
+ * @global WP_Object_Cache $wp_object_cache
*
* @param int|string $key The cache key to increment
* @param int $offset The amount by which to decrement the item's value. Default is 1.
* Removes the cache contents matching key and group.
*
* @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::delete()
+ *
+ * @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
* Removes all cache items.
*
* @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::flush()
+ *
+ * @global WP_Object_Cache $wp_object_cache
*
* @return bool False on failure, true on success
*/
* Retrieves the cache contents from the cache by key and group.
*
* @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::get()
+ *
+ * @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 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
- * contents on success
+ * contents on success
*/
function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {
global $wp_object_cache;
* Increment numeric cache item's value
*
* @since 3.3.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::incr()
+ *
+ * @global WP_Object_Cache $wp_object_cache
*
* @param int|string $key The cache key to increment
* @param int $offset The amount by which to increment the item's value. Default is 1.
* Sets up Object Cache Global and assigns it.
*
* @since 2.0.0
- * @global WP_Object_Cache $wp_object_cache WordPress Object Cache
+ *
+ * @global WP_Object_Cache $wp_object_cache
*/
function wp_cache_init() {
$GLOBALS['wp_object_cache'] = new WP_Object_Cache();
* Replaces the contents of the cache with new data.
*
* @since 2.0.0
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::replace()
+ *
+ * @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
*
* @since 2.0.0
*
- * @uses $wp_object_cache Object Cache Class
- * @see WP_Object_Cache::set()
+ * @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
*
* @since 3.5.0
*
+ * @global WP_Object_Cache $wp_object_cache
+ *
* @param int $blog_id Blog ID
*/
function wp_cache_switch_to_blog( $blog_id ) {
global $wp_object_cache;
- return $wp_object_cache->switch_to_blog( $blog_id );
+ $wp_object_cache->switch_to_blog( $blog_id );
}
/**
*
* @since 2.6.0
*
+ * @global WP_Object_Cache $wp_object_cache
+ *
* @param string|array $groups A group or an array of groups to add
*/
function wp_cache_add_global_groups( $groups ) {
global $wp_object_cache;
- return $wp_object_cache->add_global_groups( $groups );
+ $wp_object_cache->add_global_groups( $groups );
}
/**
*
* @since 2.6.0
* @deprecated 3.5.0
+ *
+ * @global WP_Object_Cache $wp_object_cache
*/
function wp_cache_reset() {
_deprecated_function( __FUNCTION__, '3.5' );
global $wp_object_cache;
- return $wp_object_cache->reset();
+ $wp_object_cache->reset();
}
/**
*
* @since 2.0.0
*
- * @return bool Always returns true
+ * @return true Always returns true
*/
public function flush() {
- $this->cache = array ();
+ $this->cache = array();
return true;
}
* @param int|string $key What the contents in the cache are called
* @param string $group Where the cache contents are grouped
* @param string $force Whether to force a refetch rather than relying on the local cache (default is false)
- * @return bool|mixed False on failure to retrieve contents or the cache
- * contents on success
+ * @return false|mixed False on failure to retrieve contents or the cache
+ * contents on success
*/
public function get( $key, $group = 'default', $force = false, &$found = null ) {
if ( empty( $group ) )
* @param mixed $data The contents to store in the cache
* @param string $group Where to group the cache contents
* @param int $expire Not Used
- * @return bool Always returns true
+ * @return true Always returns true
*/
public function set( $key, $data, $group = 'default', $expire = 0 ) {
if ( empty( $group ) )
* Sets up object properties; PHP 5 style constructor
*
* @since 2.0.8
+ *
+ * @global int $blog_id
*/
public function __construct() {
global $blog_id;
*
* @since 2.0.8
*
- * @return bool True value. Won't be used by PHP
+ * @return true True value. Won't be used by PHP
*/
public function __destruct() {
return true;