* @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 );
}
/**
* @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;
* @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()
*
* @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 );
}
/**
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 );
}
/**
}
/**
- * 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();
*
* @package WordPress
* @subpackage Cache
- * @since 2.0
+ * @since 2.0.0
*/
class WP_Object_Cache {
*/
var $global_groups = array();
+ /**
+ * The blog prefix to prepend to keys in non-global groups.
+ *
+ * @var int
+ * @access private
+ * @since 3.5.0
+ */
+ var $blog_prefix;
+
/**
* Adds data to the cache if it doesn't already exist.
*
* @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 = '' ) {
+ function add( $key, $data, $group = 'default', $expire = 0 ) {
if ( wp_suspend_cache_addition() )
return false;
if ( empty( $group ) )
$group = 'default';
- if ( $this->_exists($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 );
}
/**
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 );
}
/**
* @return false|int False on failure, the item's new value on success.
*/
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;
/**
* 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) {
+ function delete( $key, $group = 'default', $deprecated = false ) {
if ( empty( $group ) )
$group = 'default';
- if ( ! $force && ! $this->_exists( $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] );
if ( empty( $group ) )
$group = 'default';
+ 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 ( empty( $group ) )
$group = 'default';
+ if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+ $key = $this->blog_prefix . $key;
+
if ( ! $this->_exists( $key, $group ) )
return false;
* @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 = '') {
+ function replace( $key, $data, $group = 'default', $expire = 0 ) {
if ( empty( $group ) )
$group = 'default';
- if ( ! $this->_exists( $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() {
+ _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 ] );
}
}
* @param int $expire Not Used
* @return bool Always returns true
*/
- function set($key, $data, $group = 'default', $expire = '') {
+ function set( $key, $data, $group = 'default', $expire = 0 ) {
if ( empty( $group ) )
$group = 'default';
- if ( is_object($data) )
+ if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+ $key = $this->blog_prefix . $key;
+
+ if ( is_object( $data ) )
$data = clone $data;
$this->cache[$group][$key] = $data;
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
+ */
+ 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.
- * @access private
+ *
+ * @since 3.4.0
+ *
+ * @access protected
*/
- protected function _exists($key, $group) {
- return isset( $this->cache[$group] ) && is_array( $this->cache[$group] ) && array_key_exists( $key, $this->cache[$group] );
+ protected function _exists( $key, $group ) {
+ return isset( $this->cache[ $group ] ) && ( isset( $this->cache[ $group ][ $key ] ) || array_key_exists( $key, $this->cache[ $group ] ) );
}
/**
* @return null|WP_Object_Cache If cache is disabled, returns null.
*/
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' ) );
}
/**
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff