* @param string|array $groups A group or an array of groups to add
*/
function wp_cache_add_global_groups( $groups ) {
- // Default cache doesn't persist so nothing to do here.
- return;
+ global $wp_object_cache;
+
+ return $wp_object_cache->add_global_groups($groups);
}
/**
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.
+ *
+ * @since 2.6.0
+ *
+ * @param string|array $groups A group or an array of groups to add
+ */
+function wp_cache_reset() {
+ global $wp_object_cache;
+
+ return $wp_object_cache->reset();
+}
+
/**
* WordPress Object Cache
*
* @access private
* @since 2.0.0
*/
- var $non_existant_objects = array ();
+ var $non_existent_objects = array ();
/**
* The amount of times the cache data was already stored in the cache.
*/
var $cache_misses = 0;
+ /**
+ * List of global groups
+ *
+ * @var array
+ * @access protected
+ * @since 3.0.0
+ */
+ var $global_groups = array();
+
/**
* 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 ID and group already exists, true on success
*/
- function add($id, $data, $group = 'default', $expire = '') {
- if (empty ($group))
+ function add( $id, $data, $group = 'default', $expire = '' ) {
+ if ( empty ($group) )
$group = 'default';
- if (false !== $this->get($id, $group, false))
+ if (false !== $this->get($id, $group))
return false;
return $this->set($id, $data, $group, $expire);
}
+ /**
+ * Sets the list of global groups.
+ *
+ * @since 3.0.0
+ *
+ * @param array $groups List of groups that are global.
+ */
+ 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);
+ }
+
/**
* Remove the contents of the cache ID in the group
*
* by default.
*
* On success the group and the id will be added to the
- * $non_existant_objects property in the class.
+ * $non_existent_objects property in the class.
*
* @since 2.0.0
*
if (empty ($group))
$group = 'default';
- if (!$force && false === $this->get($id, $group, false))
+ if (!$force && false === $this->get($id, $group))
return false;
unset ($this->cache[$group][$id]);
- $this->non_existant_objects[$group][$id] = true;
+ $this->non_existent_objects[$group][$id] = true;
return true;
}
* ID in the cache group. If the cache is hit (success) then the contents
* are returned.
*
- * On failure, the $non_existant_objects property is checked and if the
+ * On failure, the $non_existent_objects property is checked and if the
* cache group and ID exist in there the cache misses will not be
- * incremented. If not in the nonexistant objects property, then the cache
+ * incremented. If not in the nonexistent objects property, then the cache
* misses will be incremented and the cache group and ID will be added to
- * the nonexistant objects.
+ * the nonexistent objects.
*
* @since 2.0.0
*
* contents on success
*/
function get($id, $group = 'default') {
- if (empty ($group))
+ if ( empty ($group) )
$group = 'default';
- if (isset ($this->cache[$group][$id])) {
+ if ( isset ($this->cache[$group][$id]) ) {
$this->cache_hits += 1;
if ( is_object($this->cache[$group][$id]) )
return wp_clone($this->cache[$group][$id]);
return $this->cache[$group][$id];
}
- if ( isset ($this->non_existant_objects[$group][$id]) )
+ if ( isset ($this->non_existent_objects[$group][$id]) )
return false;
- $this->non_existant_objects[$group][$id] = true;
+ $this->non_existent_objects[$group][$id] = true;
$this->cache_misses += 1;
return false;
}
if (empty ($group))
$group = 'default';
- if (false === $this->get($id, $group, false))
+ if ( false === $this->get($id, $group) )
return false;
return $this->set($id, $data, $group, $expire);
}
+ /**
+ * Reset keys
+ *
+ * @since 3.0.0
+ */
+ function reset() {
+ // 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]);
+ }
+ }
+
/**
* Sets the data contents into the cache
*
* @return bool Always returns true
*/
function set($id, $data, $group = 'default', $expire = '') {
- if (empty ($group))
+ if ( empty ($group) )
$group = 'default';
- if (NULL === $data)
+ if ( NULL === $data )
$data = '';
if ( is_object($data) )
$this->cache[$group][$id] = $data;
- if(isset($this->non_existant_objects[$group][$id]))
- unset ($this->non_existant_objects[$group][$id]);
+ if ( isset($this->non_existent_objects[$group][$id]) )
+ unset ($this->non_existent_objects[$group][$id]);
return true;
}
/**
- * Echos the stats of the caching.
+ * Echoes the stats of the caching.
*
* Gives the cache hits, and cache misses. Also prints every cached group,
* key and the data.