5 * @link http://codex.wordpress.org/Function_Reference/WP_Cache
12 * Adds data to the cache, if the cache key doesn't aleady exist.
15 * @uses $wp_object_cache Object Cache Class
16 * @see WP_Object_Cache::add()
18 * @param int|string $key The cache ID to use for retrieval later
19 * @param mixed $data The data to add to the cache store
20 * @param string $flag The group to add the cache to
21 * @param int $expire When the cache data should be expired
24 function wp_cache_add($key, $data, $flag = '', $expire = 0) {
25 global $wp_object_cache;
27 return $wp_object_cache->add($key, $data, $flag, $expire);
33 * This function has ceased to do anything since WordPress 2.5. The
34 * functionality was removed along with the rest of the persistant cache. This
35 * does not mean that plugins can't implement this function when they need to
36 * make sure that the cache is cleaned up after WordPress no longer needs it.
40 * @return bool Always returns True
42 function wp_cache_close() {
47 * Removes the cache contents matching ID and flag.
50 * @uses $wp_object_cache Object Cache Class
51 * @see WP_Object_Cache::delete()
53 * @param int|string $id What the contents in the cache are called
54 * @param string $flag Where the cache contents are grouped
55 * @return bool True on successful removal, false on failure
57 function wp_cache_delete($id, $flag = '') {
58 global $wp_object_cache;
60 return $wp_object_cache->delete($id, $flag);
64 * Removes all cache items.
67 * @uses $wp_object_cache Object Cache Class
68 * @see WP_Object_Cache::flush()
70 * @return bool Always returns true
72 function wp_cache_flush() {
73 global $wp_object_cache;
75 return $wp_object_cache->flush();
79 * Retrieves the cache contents from the cache by ID and flag.
82 * @uses $wp_object_cache Object Cache Class
83 * @see WP_Object_Cache::get()
85 * @param int|string $id What the contents in the cache are called
86 * @param string $flag Where the cache contents are grouped
87 * @return bool|mixed False on failure to retrieve contents or the cache
90 function wp_cache_get($id, $flag = '') {
91 global $wp_object_cache;
93 return $wp_object_cache->get($id, $flag);
97 * Sets up Object Cache Global and assigns it.
100 * @global WP_Object_Cache $wp_object_cache WordPress Object Cache
102 function wp_cache_init() {
103 $GLOBALS['wp_object_cache'] =& new WP_Object_Cache();
107 * Replaces the contents of the cache with new data.
110 * @uses $wp_object_cache Object Cache Class
111 * @see WP_Object_Cache::replace()
113 * @param int|string $id What to call the contents in the cache
114 * @param mixed $data The contents to store in the cache
115 * @param string $flag Where to group the cache contents
116 * @param int $expire When to expire the cache contents
117 * @return bool False if cache ID and group already exists, true on success
119 function wp_cache_replace($key, $data, $flag = '', $expire = 0) {
120 global $wp_object_cache;
122 return $wp_object_cache->replace($key, $data, $flag, $expire);
126 * Saves the data to the cache.
129 * @uses $wp_object_cache Object Cache Class
130 * @see WP_Object_Cache::set()
132 * @param int|string $id What to call the contents in the cache
133 * @param mixed $data The contents to store in the cache
134 * @param string $flag Where to group the cache contents
135 * @param int $expire When to expire the cache contents
136 * @return bool False if cache ID and group already exists, true on success
138 function wp_cache_set($key, $data, $flag = '', $expire = 0) {
139 global $wp_object_cache;
141 return $wp_object_cache->set($key, $data, $flag, $expire);
145 * Adds a group or set of groups to the list of global groups.
149 * @param string|array $groups A group or an array of groups to add
151 function wp_cache_add_global_groups( $groups ) {
152 // Default cache doesn't persist so nothing to do here.
157 * Adds a group or set of groups to the list of non-persistent groups.
161 * @param string|array $groups A group or an array of groups to add
163 function wp_cache_add_non_persistent_groups( $groups ) {
164 // Default cache doesn't persist so nothing to do here.
169 * WordPress Object Cache
171 * The WordPress Object Cache is used to save on trips to the database. The
172 * Object Cache stores all of the cache data to memory and makes the cache
173 * contents available by using a key, which is used to name and later retrieve
174 * the cache contents.
176 * The Object Cache can be replaced by other caching mechanisms by placing files
177 * in the wp-content folder which is looked at in wp-settings. If that file
178 * exists, then this file will not be included.
184 class WP_Object_Cache {
187 * Holds the cached objects
193 var $cache = array ();
196 * Cache objects that do not exist in the cache
202 var $non_existant_objects = array ();
205 * The amount of times the cache data was already stored in the cache.
214 * Amount of times the cache did not have the request in cache
220 var $cache_misses = 0;
223 * Adds data to the cache if it doesn't already exist.
225 * @uses WP_Object_Cache::get Checks to see if the cache already has data.
226 * @uses WP_Object_Cache::set Sets the data after the checking the cache
227 * contents existance.
231 * @param int|string $id What to call the contents in the cache
232 * @param mixed $data The contents to store in the cache
233 * @param string $group Where to group the cache contents
234 * @param int $expire When to expire the cache contents
235 * @return bool False if cache ID and group already exists, true on success
237 function add($id, $data, $group = 'default', $expire = '') {
241 if (false !== $this->get($id, $group, false))
244 return $this->set($id, $data, $group, $expire);
248 * Remove the contents of the cache ID in the group
250 * If the cache ID does not exist in the group and $force parameter is set
251 * to false, then nothing will happen. The $force parameter is set to false
254 * On success the group and the id will be added to the
255 * $non_existant_objects property in the class.
259 * @param int|string $id What the contents in the cache are called
260 * @param string $group Where the cache contents are grouped
261 * @param bool $force Optional. Whether to force the unsetting of the cache
263 * @return bool False if the contents weren't deleted and true on success
265 function delete($id, $group = 'default', $force = false) {
269 if (!$force && false === $this->get($id, $group, false))
272 unset ($this->cache[$group][$id]);
273 $this->non_existant_objects[$group][$id] = true;
278 * Clears the object cache of all data
282 * @return bool Always returns true
285 $this->cache = array ();
291 * Retrieves the cache contents, if it exists
293 * The contents will be first attempted to be retrieved by searching by the
294 * ID in the cache group. If the cache is hit (success) then the contents
297 * On failure, the $non_existant_objects property is checked and if the
298 * cache group and ID exist in there the cache misses will not be
299 * incremented. If not in the nonexistant objects property, then the cache
300 * misses will be incremented and the cache group and ID will be added to
301 * the nonexistant objects.
305 * @param int|string $id What the contents in the cache are called
306 * @param string $group Where the cache contents are grouped
307 * @return bool|mixed False on failure to retrieve contents or the cache
308 * contents on success
310 function get($id, $group = 'default') {
314 if (isset ($this->cache[$group][$id])) {
315 $this->cache_hits += 1;
316 if ( is_object($this->cache[$group][$id]) )
317 return wp_clone($this->cache[$group][$id]);
319 return $this->cache[$group][$id];
322 if ( isset ($this->non_existant_objects[$group][$id]) )
325 $this->non_existant_objects[$group][$id] = true;
326 $this->cache_misses += 1;
331 * Replace the contents in the cache, if contents already exist
334 * @see WP_Object_Cache::set()
336 * @param int|string $id What to call the contents in the cache
337 * @param mixed $data The contents to store in the cache
338 * @param string $group Where to group the cache contents
339 * @param int $expire When to expire the cache contents
340 * @return bool False if not exists, true if contents were replaced
342 function replace($id, $data, $group = 'default', $expire = '') {
346 if (false === $this->get($id, $group, false))
349 return $this->set($id, $data, $group, $expire);
353 * Sets the data contents into the cache
355 * The cache contents is grouped by the $group parameter followed by the
356 * $id. This allows for duplicate ids in unique groups. Therefore, naming of
357 * the group should be used with care and should follow normal function
358 * naming guidelines outside of core WordPress usage.
360 * The $expire parameter is not used, because the cache will automatically
361 * expire for each time a page is accessed and PHP finishes. The method is
362 * more for cache plugins which use files.
366 * @param int|string $id What to call the contents in the cache
367 * @param mixed $data The contents to store in the cache
368 * @param string $group Where to group the cache contents
369 * @param int $expire Not Used
370 * @return bool Always returns true
372 function set($id, $data, $group = 'default', $expire = '') {
379 if ( is_object($data) )
380 $data = wp_clone($data);
382 $this->cache[$group][$id] = $data;
384 if(isset($this->non_existant_objects[$group][$id]))
385 unset ($this->non_existant_objects[$group][$id]);
391 * Echos the stats of the caching.
393 * Gives the cache hits, and cache misses. Also prints every cached group,
400 echo "<strong>Cache Hits:</strong> {$this->cache_hits}<br />";
401 echo "<strong>Cache Misses:</strong> {$this->cache_misses}<br />";
404 foreach ($this->cache as $group => $cache) {
406 echo "<strong>Group:</strong> $group<br />";
407 echo "<strong>Cache:</strong>";
415 * PHP4 constructor; Calls PHP 5 style constructor
419 * @return WP_Object_Cache
421 function WP_Object_Cache() {
422 return $this->__construct();
426 * Sets up object properties; PHP 5 style constructor
429 * @return null|WP_Object_Cache If cache is disabled, returns null.
431 function __construct() {
433 * @todo This should be moved to the PHP4 style constructor, PHP5
434 * already calls __destruct()
436 register_shutdown_function(array(&$this, "__destruct"));
440 * Will save the object cache before object is completely destroyed.
442 * Called upon object destruction, which should be when PHP ends.
446 * @return bool True value. Won't be used by PHP
448 function __destruct() {