=== WP Cache Bucket ===
Contributors: voceplatforms, prettyboymp, csloisel
Tags: cache, caching, performance, optimization
Requires at least: 3.0
Tested up to: 3.5
Stable tag: 1.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Allows cache items to be tied to a single validation key so they can all be expired at once.

== Description ==

= Please Note: =
*This plugin does **not** do anything by itself. It is meant to be a helper class for theme and plugin developers.*

Cache bucket uses the built-in WordPress `wp_cache` but contains methods to associate multiple items with a single cache object or 'bucket' without having to stick all of them into a single cache key. This is helpful when you have multiple items that need to be updated when one item is modified.

Because the standard cache key used to identify the cached item is dependant on other variables when it's being accessed, there is no easy way to identify all of the related keys that need to expire, and Memcached doesn't provide a way to invalidate a group of data. WP Cache Bucket provides a wrapper around the cache that gives a 'bucket' interface, allowing us to easily expire an entire set of cached objects when one object changes.

= Usage: =
Use `wp_cache_bucket_add()` to add a cache bucket.  
Use `wp_cache_bucket_set()` to set a cache bucket.  
Use `wp_cache_bucket_get()` to get a cache bucket.  
Use `wp_cache_bucket_flush()` to destroy a cached bucket.  

== Installation ==

= As standard plugin: =
> See [Installing Plugins](http://codex.wordpress.org/Managing_Plugins#Installing_Plugins).

= As theme or plugin dependency: =
After dropping the plugin into the containing theme or plugin, add the following:

	if( ! class_exists( 'WP_Cache_Bucket' ) ) {
	    require_once( $path_to_wp_cache_bucket . '/wp-cache-bucket.php' );
	}

== Frequently Asked Questions ==

* **How is this different than WordPress Cache?**
  * *This plugin isn't much different from the built-in WordPress object cache methods, in fact it still uses them. The biggest advantage of this plugin is the ability to flush all data associated with a bucket.*
* **I installed/activated the plugin, now what?**
* **Where are the settings and options for this plugin?**
* **What does this plugin do?**
	* *This plugin doesn't do anything by itself. There isn't any user interface, any settings or options. All this plugin does is provide helper functions that extend WordPress functionality. If you aren't a theme or plugin developer, you probably don't want this plugin.*

== Changelog ==
= 1.1 =
* Updating readme
* Conversion to class

= 1.0 =
* Initial release