WordPress 4.3
[autoinstalls/wordpress.git] / wp-includes / cache.php
index d75c82c669864cb597c1b191437d18db23aa26d4..d89ac7416cc1bef5963c6f1360e8526bfb713beb 100644 (file)
@@ -12,8 +12,8 @@
  * 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
@@ -37,7 +37,7 @@ function wp_cache_add( $key, $data, $group = '', $expire = 0 ) {
  *
  * @since 2.0.0
  *
- * @return bool Always returns True
+ * @return true Always returns True
  */
 function wp_cache_close() {
        return true;
@@ -47,8 +47,8 @@ function wp_cache_close() {
  * 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.
@@ -65,8 +65,8 @@ function wp_cache_decr( $key, $offset = 1, $group = '' ) {
  * 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
@@ -82,8 +82,8 @@ function wp_cache_delete($key, $group = '') {
  * 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
  */
@@ -97,15 +97,15 @@ function wp_cache_flush() {
  * 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;
@@ -117,8 +117,8 @@ function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {
  * 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.
@@ -135,7 +135,8 @@ function wp_cache_incr( $key, $offset = 1, $group = '' ) {
  * 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();
@@ -145,8 +146,8 @@ function wp_cache_init() {
  * 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
@@ -165,8 +166,7 @@ function wp_cache_replace( $key, $data, $group = '', $expire = 0 ) {
  *
  * @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
@@ -187,12 +187,14 @@ function wp_cache_set( $key, $data, $group = '', $expire = 0 ) {
  *
  * @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 );
 }
 
 /**
@@ -200,12 +202,14 @@ function wp_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 );
 }
 
 /**
@@ -233,13 +237,15 @@ function wp_cache_add_non_persistent_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();
 }
 
 /**
@@ -477,10 +483,10 @@ class WP_Object_Cache {
         *
         * @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;
        }
@@ -499,8 +505,8 @@ class 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 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 ) )
@@ -616,7 +622,7 @@ class WP_Object_Cache {
         * @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 ) )
@@ -684,6 +690,8 @@ class WP_Object_Cache {
         * Sets up object properties; PHP 5 style constructor
         *
         * @since 2.0.8
+        *
+     * @global int $blog_id
         */
        public function __construct() {
                global $blog_id;
@@ -706,7 +714,7 @@ class WP_Object_Cache {
         *
         * @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;