WordPress 4.2.4-scripts
[autoinstalls/wordpress.git] / wp-includes / cache.php
index f285be3a9093da1e0d9d70ccba0264eca613c00e..d75c82c669864cb597c1b191437d18db23aa26d4 100644 (file)
@@ -2,7 +2,7 @@
 /**
  * Object Cache API
  *
- * @link http://codex.wordpress.org/Function_Reference/WP_Cache
+ * @link https://codex.wordpress.org/Function_Reference/WP_Cache
  *
  * @package WordPress
  * @subpackage Cache
  * @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 unknown
+ * @return bool False if cache key and group already exist, true on success
  */
-function wp_cache_add($key, $data, $group = '', $expire = 0) {
+function wp_cache_add( $key, $data, $group = '', $expire = 0 ) {
        global $wp_object_cache;
 
-       return $wp_object_cache->add($key, $data, $group, $expire);
+       return $wp_object_cache->add( $key, $data, $group, (int) $expire );
 }
 
 /**
@@ -51,7 +51,7 @@ function wp_cache_close() {
  * @see WP_Object_Cache::decr()
  *
  * @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.
+ * @param int $offset The amount by which to decrement the item's value. Default is 1.
  * @param string $group The group the key is in.
  * @return false|int False on failure, the item's new value on success.
  */
@@ -85,7 +85,7 @@ function wp_cache_delete($key, $group = '') {
  * @uses $wp_object_cache Object Cache Class
  * @see WP_Object_Cache::flush()
  *
- * @return bool Always returns true
+ * @return bool False on failure, true on success
  */
 function wp_cache_flush() {
        global $wp_object_cache;
@@ -103,13 +103,14 @@ function wp_cache_flush() {
  * @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
  */
-function wp_cache_get( $key, $group = '', $force = false ) {
+function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {
        global $wp_object_cache;
 
-       return $wp_object_cache->get( $key, $group, $force );
+       return $wp_object_cache->get( $key, $group, $force, $found );
 }
 
 /**
@@ -120,7 +121,7 @@ function wp_cache_get( $key, $group = '', $force = false ) {
  * @see WP_Object_Cache::incr()
  *
  * @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.
+ * @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.
  * @return false|int False on failure, the item's new value on success.
  */
@@ -151,18 +152,19 @@ function wp_cache_init() {
  * @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 cache key and group already exist, true on success
+ * @return bool False if not exists, true if contents were replaced
  */
-function wp_cache_replace($key, $data, $group = '', $expire = 0) {
+function wp_cache_replace( $key, $data, $group = '', $expire = 0 ) {
        global $wp_object_cache;
 
-       return $wp_object_cache->replace($key, $data, $group, $expire);
+       return $wp_object_cache->replace( $key, $data, $group, (int) $expire );
 }
 
 /**
  * Saves the data to the cache.
  *
- * @since 2.0
+ * @since 2.0.0
+ *
  * @uses $wp_object_cache Object Cache Class
  * @see WP_Object_Cache::set()
  *
@@ -170,12 +172,27 @@ function wp_cache_replace($key, $data, $group = '', $expire = 0) {
  * @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 cache key and group already exist, true on success
+ * @return bool False on failure, true on success
+ */
+function wp_cache_set( $key, $data, $group = '', $expire = 0 ) {
+       global $wp_object_cache;
+
+       return $wp_object_cache->set( $key, $data, $group, (int) $expire );
+}
+
+/**
+ * Switch the interal blog id.
+ *
+ * This changes the blog id used to create keys in blog specific groups.
+ *
+ * @since 3.5.0
+ *
+ * @param int $blog_id Blog ID
  */
-function wp_cache_set($key, $data, $group = '', $expire = 0) {
+function wp_cache_switch_to_blog( $blog_id ) {
        global $wp_object_cache;
 
-       return $wp_object_cache->set($key, $data, $group, $expire);
+       return $wp_object_cache->switch_to_blog( $blog_id );
 }
 
 /**
@@ -188,7 +205,7 @@ function wp_cache_set($key, $data, $group = '', $expire = 0) {
 function wp_cache_add_global_groups( $groups ) {
        global $wp_object_cache;
 
-       return $wp_object_cache->add_global_groups($groups);
+       return $wp_object_cache->add_global_groups( $groups );
 }
 
 /**
@@ -200,16 +217,26 @@ function wp_cache_add_global_groups( $groups ) {
  */
 function wp_cache_add_non_persistent_groups( $groups ) {
        // Default cache doesn't persist so nothing to do here.
-       return;
 }
 
 /**
- * Reset internal cache keys and structures.  If the cache backend uses global blog or site IDs as part of its cache keys,
- * this function instructs the backend to reset those keys and perform any cleanup since blog or site IDs have changed since cache init.
+ * Reset internal cache keys and structures. If the cache backend uses global
+ * blog or site IDs as part of its cache keys, this function instructs the
+ * backend to reset those keys and perform any cleanup since blog or site IDs
+ * have changed since cache init.
+ *
+ * This function is deprecated. Use wp_cache_switch_to_blog() instead of this
+ * function when preparing the cache for a blog switch. For clearing the cache
+ * during unit tests, consider using wp_cache_init(). wp_cache_init() is not
+ * recommended outside of unit tests as the performance penality for using it is
+ * high.
  *
  * @since 2.6.0
+ * @deprecated 3.5.0
  */
 function wp_cache_reset() {
+       _deprecated_function( __FUNCTION__, '3.5' );
+
        global $wp_object_cache;
 
        return $wp_object_cache->reset();
@@ -229,7 +256,7 @@ function wp_cache_reset() {
  *
  * @package WordPress
  * @subpackage Cache
- * @since 2.0
+ * @since 2.0.0
  */
 class WP_Object_Cache {
 
@@ -240,7 +267,7 @@ class WP_Object_Cache {
         * @access private
         * @since 2.0.0
         */
-       var $cache = array ();
+       private $cache = array();
 
        /**
         * The amount of times the cache data was already stored in the cache.
@@ -249,7 +276,7 @@ class WP_Object_Cache {
         * @access private
         * @var int
         */
-       var $cache_hits = 0;
+       private $cache_hits = 0;
 
        /**
         * Amount of times the cache did not have the request in cache
@@ -258,7 +285,7 @@ class WP_Object_Cache {
         * @access public
         * @since 2.0.0
         */
-       var $cache_misses = 0;
+       public $cache_misses = 0;
 
        /**
         * List of global groups
@@ -267,12 +294,82 @@ class WP_Object_Cache {
         * @access protected
         * @since 3.0.0
         */
-       var $global_groups = array();
+       protected $global_groups = array();
+
+       /**
+        * The blog prefix to prepend to keys in non-global groups.
+        *
+        * @var int
+        * @access private
+        * @since 3.5.0
+        */
+       private $blog_prefix;
+
+       /**
+        * Holds the value of `is_multisite()`
+        *
+        * @var bool
+        * @access private
+        * @since 3.5.0
+        */
+       private $multisite;
+
+       /**
+        * Make private properties readable for backwards compatibility.
+        *
+        * @since 4.0.0
+        * @access public
+        *
+        * @param string $name Property to get.
+        * @return mixed Property.
+        */
+       public function __get( $name ) {
+               return $this->$name;
+       }
+
+       /**
+        * Make private properties settable for backwards compatibility.
+        *
+        * @since 4.0.0
+        * @access public
+        *
+        * @param string $name  Property to set.
+        * @param mixed  $value Property value.
+        * @return mixed Newly-set property.
+        */
+       public function __set( $name, $value ) {
+               return $this->$name = $value;
+       }
+
+       /**
+        * Make private properties checkable for backwards compatibility.
+        *
+        * @since 4.0.0
+        * @access public
+        *
+        * @param string $name Property to check if set.
+        * @return bool Whether the property is set.
+        */
+       public function __isset( $name ) {
+               return isset( $this->$name );
+       }
+
+       /**
+        * Make private properties un-settable for backwards compatibility.
+        *
+        * @since 4.0.0
+        * @access public
+        *
+        * @param string $name Property to unset.
+        */
+       public function __unset( $name ) {
+               unset( $this->$name );
+       }
 
        /**
         * Adds data to the cache if it doesn't already exist.
         *
-        * @uses WP_Object_Cache::get Checks to see if the cache already has data.
+        * @uses WP_Object_Cache::_exists Checks to see if the cache already has data.
         * @uses WP_Object_Cache::set Sets the data after the checking the cache
         *              contents existence.
         *
@@ -284,17 +381,21 @@ class WP_Object_Cache {
         * @param int $expire When to expire the cache contents
         * @return bool False if cache key and group already exist, true on success
         */
-       function add( $key, $data, $group = 'default', $expire = '' ) {
+       public function add( $key, $data, $group = 'default', $expire = 0 ) {
                if ( wp_suspend_cache_addition() )
                        return false;
 
-               if ( empty ($group) )
+               if ( empty( $group ) )
                        $group = 'default';
 
-               if (false !== $this->get($key, $group))
+               $id = $key;
+               if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $id = $this->blog_prefix . $key;
+
+               if ( $this->_exists( $id, $group ) )
                        return false;
 
-               return $this->set($key, $data, $group, $expire);
+               return $this->set( $key, $data, $group, (int) $expire );
        }
 
        /**
@@ -304,11 +405,11 @@ class WP_Object_Cache {
         *
         * @param array $groups List of groups that are global.
         */
-       function add_global_groups( $groups ) {
+       public function add_global_groups( $groups ) {
                $groups = (array) $groups;
 
-               $this->global_groups = array_merge($this->global_groups, $groups);
-               $this->global_groups = array_unique($this->global_groups);
+               $groups = array_fill_keys( $groups, true );
+               $this->global_groups = array_merge( $this->global_groups, $groups );
        }
 
        /**
@@ -317,12 +418,18 @@ class WP_Object_Cache {
         * @since 3.3.0
         *
         * @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.
+        * @param int $offset The amount by which to decrement the item's value. Default is 1.
         * @param string $group The group the key is in.
         * @return false|int False on failure, the item's new value on success.
         */
-       function decr( $key, $offset = 1, $group = 'default' ) {
-               if ( ! isset( $this->cache[ $group ][ $key ] ) )
+       public function decr( $key, $offset = 1, $group = 'default' ) {
+               if ( empty( $group ) )
+                       $group = 'default';
+
+               if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $key = $this->blog_prefix . $key;
+
+               if ( ! $this->_exists( $key, $group ) )
                        return false;
 
                if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
@@ -341,26 +448,27 @@ class WP_Object_Cache {
        /**
         * Remove the contents of the cache key in the group
         *
-        * If the cache key does not exist in the group and $force parameter is set
-        * to false, then nothing will happen. The $force parameter is set to false
-        * by default.
+        * If the cache key does not exist in the group, then nothing will happen.
         *
         * @since 2.0.0
         *
         * @param int|string $key What the contents in the cache are called
         * @param string $group Where the cache contents are grouped
-        * @param bool $force Optional. Whether to force the unsetting of the cache
-        *              key in the group
+        * @param bool $deprecated Deprecated.
+        *
         * @return bool False if the contents weren't deleted and true on success
         */
-       function delete($key, $group = 'default', $force = false) {
-               if (empty ($group))
+       public function delete( $key, $group = 'default', $deprecated = false ) {
+               if ( empty( $group ) )
                        $group = 'default';
 
-               if (!$force && false === $this->get($key, $group))
+               if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $key = $this->blog_prefix . $key;
+
+               if ( ! $this->_exists( $key, $group ) )
                        return false;
 
-               unset ($this->cache[$group][$key]);
+               unset( $this->cache[$group][$key] );
                return true;
        }
 
@@ -371,7 +479,7 @@ class WP_Object_Cache {
         *
         * @return bool Always returns true
         */
-       function flush() {
+       public function flush() {
                $this->cache = array ();
 
                return true;
@@ -394,11 +502,15 @@ class WP_Object_Cache {
         * @return bool|mixed False on failure to retrieve contents or the cache
         *              contents on success
         */
-       function get( $key, $group = 'default', $force = false) {
-               if ( empty ($group) )
+       public function get( $key, $group = 'default', $force = false, &$found = null ) {
+               if ( empty( $group ) )
                        $group = 'default';
 
-               if ( isset ($this->cache[$group][$key]) ) {
+               if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $key = $this->blog_prefix . $key;
+
+               if ( $this->_exists( $key, $group ) ) {
+                       $found = true;
                        $this->cache_hits += 1;
                        if ( is_object($this->cache[$group][$key]) )
                                return clone $this->cache[$group][$key];
@@ -406,6 +518,7 @@ class WP_Object_Cache {
                                return $this->cache[$group][$key];
                }
 
+               $found = false;
                $this->cache_misses += 1;
                return false;
        }
@@ -416,12 +529,18 @@ class WP_Object_Cache {
         * @since 3.3.0
         *
         * @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.
+        * @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.
         * @return false|int False on failure, the item's new value on success.
         */
-       function incr( $key, $offset = 1, $group = 'default' ) {
-               if ( ! isset( $this->cache[ $group ][ $key ] ) )
+       public function incr( $key, $offset = 1, $group = 'default' ) {
+               if ( empty( $group ) )
+                       $group = 'default';
+
+               if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $key = $this->blog_prefix . $key;
+
+               if ( ! $this->_exists( $key, $group ) )
                        return false;
 
                if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
@@ -449,26 +568,33 @@ class WP_Object_Cache {
         * @param int $expire When to expire the cache contents
         * @return bool False if not exists, true if contents were replaced
         */
-       function replace($key, $data, $group = 'default', $expire = '') {
-               if (empty ($group))
+       public function replace( $key, $data, $group = 'default', $expire = 0 ) {
+               if ( empty( $group ) )
                        $group = 'default';
 
-               if ( false === $this->get($key, $group) )
+               $id = $key;
+               if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $id = $this->blog_prefix . $key;
+
+               if ( ! $this->_exists( $id, $group ) )
                        return false;
 
-               return $this->set($key, $data, $group, $expire);
+               return $this->set( $key, $data, $group, (int) $expire );
        }
 
        /**
         * Reset keys
         *
         * @since 3.0.0
+        * @deprecated 3.5.0
         */
-       function reset() {
+       public function reset() {
+               _deprecated_function( __FUNCTION__, '3.5', 'switch_to_blog()' );
+
                // Clear out non-global caches since the blog ID has changed.
-               foreach ( array_keys($this->cache) as $group ) {
-                       if ( !in_array($group, $this->global_groups) )
-                               unset($this->cache[$group]);
+               foreach ( array_keys( $this->cache ) as $group ) {
+                       if ( ! isset( $this->global_groups[ $group ] ) )
+                               unset( $this->cache[ $group ] );
                }
        }
 
@@ -492,14 +618,14 @@ class WP_Object_Cache {
         * @param int $expire Not Used
         * @return bool Always returns true
         */
-       function set($key, $data, $group = 'default', $expire = '') {
-               if ( empty ($group) )
+       public function set( $key, $data, $group = 'default', $expire = 0 ) {
+               if ( empty( $group ) )
                        $group = 'default';
 
-               if ( NULL === $data )
-                       $data = '';
+               if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $key = $this->blog_prefix . $key;
 
-               if ( is_object($data) )
+               if ( is_object( $data ) )
                        $data = clone $data;
 
                $this->cache[$group][$key] = $data;
@@ -514,7 +640,7 @@ class WP_Object_Cache {
         *
         * @since 2.0.0
         */
-       function stats() {
+       public function stats() {
                echo "<p>";
                echo "<strong>Cache Hits:</strong> {$this->cache_hits}<br />";
                echo "<strong>Cache Misses:</strong> {$this->cache_misses}<br />";
@@ -526,18 +652,51 @@ class WP_Object_Cache {
                echo '</ul>';
        }
 
+       /**
+        * Switch the interal blog id.
+        *
+        * This changes the blog id used to create keys in blog specific groups.
+        *
+        * @since 3.5.0
+        *
+        * @param int $blog_id Blog ID
+        */
+       public function switch_to_blog( $blog_id ) {
+               $blog_id = (int) $blog_id;
+               $this->blog_prefix = $this->multisite ? $blog_id . ':' : '';
+       }
+
+       /**
+        * Utility function to determine whether a key exists in the cache.
+        *
+        * @since 3.4.0
+        *
+        * @access protected
+        * @param string $key
+        * @param string $group
+        * @return bool
+        */
+       protected function _exists( $key, $group ) {
+               return isset( $this->cache[ $group ] ) && ( isset( $this->cache[ $group ][ $key ] ) || array_key_exists( $key, $this->cache[ $group ] ) );
+       }
+
        /**
         * Sets up object properties; PHP 5 style constructor
         *
         * @since 2.0.8
-        * @return null|WP_Object_Cache If cache is disabled, returns null.
         */
-       function __construct() {
+       public function __construct() {
+               global $blog_id;
+
+               $this->multisite = is_multisite();
+               $this->blog_prefix =  $this->multisite ? $blog_id . ':' : '';
+
+
                /**
                 * @todo This should be moved to the PHP4 style constructor, PHP5
                 * already calls __destruct()
                 */
-               register_shutdown_function(array(&$this, "__destruct"));
+               register_shutdown_function( array( $this, '__destruct' ) );
        }
 
        /**
@@ -549,8 +708,7 @@ class WP_Object_Cache {
         *
         * @return bool True value. Won't be used by PHP
         */
-       function __destruct() {
+       public function __destruct() {
                return true;
        }
 }
-?>