X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/177fd6fefd2e3d5a0ea6591c71d660cabdb3c1a4..refs/tags/wordpress-2.6.2:/wp-includes/cache.php

diff --git a/wp-includes/cache.php b/wp-includes/cache.php
index bb6cafa3..cfdab824 100644
--- a/wp-includes/cache.php
+++ b/wp-includes/cache.php
@@ -2,12 +2,14 @@
 /**
  * Object Cache API
  *
+ * @link http://codex.wordpress.org/Function_Reference/WP_Cache
+ *
  * @package WordPress
  * @subpackage Cache
  */
 
 /**
- * wp_cache_add() - Adds data to the cache, if the cache key doesn't aleady exist
+ * Adds data to the cache, if the cache key doesn't aleady exist.
  *
  * @since 2.0
  * @uses $wp_object_cache Object Cache Class
@@ -26,11 +28,12 @@ function wp_cache_add($key, $data, $flag = '', $expire = 0) {
 }
 
 /**
- * wp_cache_close() - Closes the cache
+ * Closes the cache.
  *
- * This function has ceased to do anything since WordPress 2.5.
- * The functionality was removed along with the rest of the
- * persistant cache.
+ * This function has ceased to do anything since WordPress 2.5. The
+ * functionality was removed along with the rest of the persistant cache. This
+ * does not mean that plugins can't implement this function when they need to
+ * make sure that the cache is cleaned up after WordPress no longer needs it.
  *
  * @since 2.0
  *
@@ -41,7 +44,7 @@ function wp_cache_close() {
 }
 
 /**
- * wp_cache_delete() - Removes the cache contents matching ID and flag
+ * Removes the cache contents matching ID and flag.
  *
  * @since 2.0
  * @uses $wp_object_cache Object Cache Class
@@ -58,7 +61,7 @@ function wp_cache_delete($id, $flag = '') {
 }
 
 /**
- * wp_cache_flush() - Removes all cache items
+ * Removes all cache items.
  *
  * @since 2.0
  * @uses $wp_object_cache Object Cache Class
@@ -73,7 +76,7 @@ function wp_cache_flush() {
 }
 
 /**
- * wp_cache_get() - Retrieves the cache contents from the cache by ID and flag
+ * Retrieves the cache contents from the cache by ID and flag.
  *
  * @since 2.0
  * @uses $wp_object_cache Object Cache Class
@@ -81,7 +84,8 @@ function wp_cache_flush() {
  *
  * @param int|string $id What the contents in the cache are called
  * @param string $flag Where the cache contents are grouped
- * @return bool|mixed False on failure to retrieve contents or the cache contents on success
+ * @return bool|mixed False on failure to retrieve contents or the cache
+ *		contents on success
  */
 function wp_cache_get($id, $flag = '') {
 	global $wp_object_cache;
@@ -90,7 +94,7 @@ function wp_cache_get($id, $flag = '') {
 }
 
 /**
- * wp_cache_init() - Sets up Object Cache Global and assigns it
+ * Sets up Object Cache Global and assigns it.
  *
  * @since 2.0
  * @global WP_Object_Cache $wp_object_cache WordPress Object Cache
@@ -100,7 +104,7 @@ function wp_cache_init() {
 }
 
 /**
- * wp_cache_replace() - Replaces the contents of the cache with new data
+ * Replaces the contents of the cache with new data.
  *
  * @since 2.0
  * @uses $wp_object_cache Object Cache Class
@@ -119,7 +123,7 @@ function wp_cache_replace($key, $data, $flag = '', $expire = 0) {
 }
 
 /**
- * wp_cache_set() - Saves the data to the cache
+ * Saves the data to the cache.
  *
  * @since 2.0
  * @uses $wp_object_cache Object Cache Class
@@ -137,17 +141,41 @@ function wp_cache_set($key, $data, $flag = '', $expire = 0) {
 	return $wp_object_cache->set($key, $data, $flag, $expire);
 }
 
+/**
+ * Adds a group or set of groups to the list of global groups.
+ *
+ * @since 2.6
+ *
+ * @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;
+}
+
+/**
+ * Adds a group or set of groups to the list of non-persistent groups.
+ *
+ * @since 2.6
+ *
+ * @param string|array $groups A group or an array of groups to add
+ */
+function wp_cache_add_non_persistent_groups( $groups ) {
+	// Default cache doesn't persist so nothing to do here.
+	return;
+}
+
 /**
  * WordPress Object Cache
  *
- * The WordPress Object Cache is used to save on trips to the database.
- * The Object Cache stores all of the cache data to memory and makes the
- * cache contents available by using a key, which is used to name and
- * later retrieve the cache contents.
+ * The WordPress Object Cache is used to save on trips to the database. The
+ * Object Cache stores all of the cache data to memory and makes the cache
+ * contents available by using a key, which is used to name and later retrieve
+ * the cache contents.
  *
- * The Object Cache can be replaced by other caching mechanisms by placing
- * files in the wp-content folder which is looked at in wp-settings. If
- * that file exists, then this file will not be included.
+ * The Object Cache can be replaced by other caching mechanisms by placing files
+ * in the wp-content folder which is looked at in wp-settings. If that file
+ * exists, then this file will not be included.
  *
  * @package WordPress
  * @subpackage Cache
@@ -173,15 +201,6 @@ class WP_Object_Cache {
 	 */
 	var $non_existant_objects = array ();
 
-	/**
-	 * Object caches that are global
-	 *
-	 * @var array
-	 * @access private
-	 * @since 2.0
-	 */
-	var $global_groups = array ('users', 'userlogins', 'usermeta');
-
 	/**
 	 * The amount of times the cache data was already stored in the cache.
 	 *
@@ -204,7 +223,8 @@ class WP_Object_Cache {
 	 * 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::set Sets the data after the checking the cache contents existance.
+	 * @uses WP_Object_Cache::set Sets the data after the checking the cache
+	 *		contents existance.
 	 *
 	 * @since 2.0
 	 *
@@ -227,18 +247,19 @@ class WP_Object_Cache {
 	/**
 	 * Remove the contents of the cache ID in the group
 	 *
-	 * If the cache ID 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 ID 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.
 	 *
-	 * On success the group and the id will be added to the
+	 * On success the group and the id will be added to the 
 	 * $non_existant_objects property in the class.
 	 *
 	 * @since 2.0
 	 *
 	 * @param int|string $id 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 ID in the group
+	 * @param bool $force Optional. Whether to force the unsetting of the cache
+	 *		ID in the group
 	 * @return bool False if the contents weren't deleted and true on success
 	 */
 	function delete($id, $group = 'default', $force = false) {
@@ -269,21 +290,22 @@ class WP_Object_Cache {
 	/**
 	 * Retrieves the cache contents, if it exists
 	 *
-	 * The contents will be first attempted to be retrieved by searching
-	 * by the ID in the cache group. If the cache is hit (success) then
-	 * the contents are returned.
+	 * The contents will be first attempted to be retrieved by searching by the
+	 * 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 cache group and ID exist in there the cache misses will not be
-	 * incremented. If not in the nonexistant objects property, then the
-	 * cache misses will be incremented and the cache group and ID will
-	 * be added to the nonexistant objects.
+	 * On failure, the $non_existant_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
+	 * misses will be incremented and the cache group and ID will be added to
+	 * the nonexistant objects.
 	 *
 	 * @since 2.0
 	 *
 	 * @param int|string $id What the contents in the cache are called
 	 * @param string $group Where the cache contents are grouped
-	 * @return bool|mixed False on failure to retrieve contents or the cache contents on success
+	 * @return bool|mixed False on failure to retrieve contents or the cache
+	 *		contents on success
 	 */
 	function get($id, $group = 'default') {
 		if (empty ($group))
@@ -327,15 +349,14 @@ class WP_Object_Cache {
 	/**
 	 * Sets the data contents into the cache
 	 *
-	 * The cache contents is grouped by the $group parameter followed
-	 * by the $id. This allows for duplicate ids in unique groups.
-	 * Therefore, naming of the group should be used with care and
-	 * should follow normal function naming guidelines outside of
-	 * core WordPress usage.
+	 * The cache contents is grouped by the $group parameter followed by the
+	 * $id. This allows for duplicate ids in unique groups. Therefore, naming of
+	 * the group should be used with care and should follow normal function
+	 * naming guidelines outside of core WordPress usage.
 	 *
-	 * The $expire parameter is not used, because the cache will
-	 * automatically expire for each time a page is accessed and PHP
-	 * finishes. The method is more for cache plugins which use files.
+	 * The $expire parameter is not used, because the cache will automatically
+	 * expire for each time a page is accessed and PHP finishes. The method is
+	 * more for cache plugins which use files.
 	 *
 	 * @since 2.0
 	 *
@@ -363,8 +384,8 @@ class WP_Object_Cache {
 	/**
 	 * Echos the stats of the caching.
 	 *
-	 * Gives the cache hits, and cache misses. Also prints every cached
-	 * group, key and the data.
+	 * Gives the cache hits, and cache misses. Also prints every cached group,
+	 * key and the data.
 	 *
 	 * @since 2.0
 	 */
@@ -402,7 +423,11 @@ class WP_Object_Cache {
 	 * @return null|WP_Object_Cache If cache is disabled, returns null.
 	 */
 	function __construct() {
-		register_shutdown_function(array(&$this, "__destruct")); /** @todo This should be moved to the PHP4 style constructor, PHP5 already calls __destruct() */
+		/**
+		 * @todo This should be moved to the PHP4 style constructor, PHP5
+		 * already calls __destruct()
+		 */
+		register_shutdown_function(array(&$this, "__destruct"));
 	}
 
 	/**