| [ Index ] |
WordPress Cross Reference |
[Source view] [Print] [Project Stats]
Object Cache API
| File Size: | 653 lines (18 kb) |
| Included or required: | 1 time |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WP_Object_Cache:: (15 methods):
add()
add_global_groups()
decr()
delete()
flush()
get()
incr()
replace()
reset()
set()
stats()
switch_to_blog()
_exists()
__construct()
__destruct()
Class: WP_Object_Cache - X-Ref
WordPress Object Cache| add( $key, $data, $group = 'default', $expire = 0 ) X-Ref |
| Adds data to the cache if it doesn't already exist. param: int|string $key What to call the contents in the 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 |
| add_global_groups( $groups ) X-Ref |
| Sets the list of global groups. param: array $groups List of groups that are global. |
| decr( $key, $offset = 1, $group = 'default' ) X-Ref |
| Decrement numeric cache item's value param: int|string $key The cache key to increment param: int $offset The amount by which to decrement the item's value. Default is 1. param: string $group The group the key is in. return: false|int False on failure, the item's new value on success. |
| delete($key, $group = 'default', $force = false) X-Ref |
| 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. 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 return: bool False if the contents weren't deleted and true on success |
| flush() X-Ref |
| Clears the object cache of all data return: bool Always returns true |
| get( $key, $group = 'default', $force = false, &$found = null ) X-Ref |
| Retrieves the cache contents, if it exists The contents will be first attempted to be retrieved by searching by the key in the cache group. If the cache is hit (success) then the contents are returned. On failure, the number of cache misses will be incremented. param: int|string $key What the contents in the cache are called param: string $group Where the cache contents are grouped param: string $force Whether to force a refetch rather than relying on the local cache (default is false) return: bool|mixed False on failure to retrieve contents or the cache |
| incr( $key, $offset = 1, $group = 'default' ) X-Ref |
| Increment numeric cache item's value param: int|string $key The cache key to increment param: int $offset The amount by which to increment the item's value. Default is 1. param: string $group The group the key is in. return: false|int False on failure, the item's new value on success. |
| replace( $key, $data, $group = 'default', $expire = 0 ) X-Ref |
| Replace the contents in the cache, if contents already exist param: int|string $key What to call the contents in the 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 not exists, true if contents were replaced |
| reset() X-Ref |
| Reset keys |
| set( $key, $data, $group = 'default', $expire = 0 ) X-Ref |
| Sets the data contents into the cache The cache contents is grouped by the $group parameter followed by the $key. 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. param: int|string $key What to call the contents in the cache param: mixed $data The contents to store in the cache param: string $group Where to group the cache contents param: int $expire Not Used return: bool Always returns true |
| stats() X-Ref |
| Echoes the stats of the caching. Gives the cache hits, and cache misses. Also prints every cached group, key and the data. |
| switch_to_blog( $blog_id ) X-Ref |
| Switch the interal blog id. This changes the blog id used to create keys in blog specific groups. param: int $blog_id Blog ID |
| _exists( $key, $group ) X-Ref |
| Utility function to determine whether a key exists in the cache. |
| __construct() X-Ref |
| Sets up object properties; PHP 5 style constructor return: null|WP_Object_Cache If cache is disabled, returns null. |
| __destruct() X-Ref |
| Will save the object cache before object is completely destroyed. Called upon object destruction, which should be when PHP ends. return: bool True value. Won't be used by PHP |
| wp_cache_add( $key, $data, $group = '', $expire = 0 ) X-Ref |
| Adds data to the cache, if the cache key doesn't already exist. param: int|string $key The cache key to use for retrieval later 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: bool False if cache key and group already exist, true on success |
| wp_cache_close() X-Ref |
| Closes the cache. This function has ceased to do anything since WordPress 2.5. The functionality was removed along with the rest of the persistent 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. return: bool Always returns True |
| wp_cache_decr( $key, $offset = 1, $group = '' ) X-Ref |
| Decrement numeric cache item's value param: int|string $key The cache key to increment param: int $offset The amount by which to decrement the item's value. Default is 1. param: string $group The group the key is in. return: false|int False on failure, the item's new value on success. |
| wp_cache_delete($key, $group = '') X-Ref |
| Removes the cache contents matching key and group. param: int|string $key What the contents in the cache are called param: string $group Where the cache contents are grouped return: bool True on successful removal, false on failure |
| wp_cache_flush() X-Ref |
| Removes all cache items. return: bool False on failure, true on success |
| wp_cache_get( $key, $group = '', $force = false, &$found = null ) X-Ref |
| Retrieves the cache contents from the cache by key and group. param: int|string $key What the contents in the cache are called param: string $group Where the cache contents are grouped param: bool $force Whether to force an update of the local cache from the persistent cache (default is false) param: &bool $found Whether key was found in the cache. Disambiguates a return of false, a storable value. return: bool|mixed False on failure to retrieve contents or the cache |
| wp_cache_incr( $key, $offset = 1, $group = '' ) X-Ref |
| Increment numeric cache item's value param: int|string $key The cache key to increment param: int $offset The amount by which to increment the item's value. Default is 1. param: string $group The group the key is in. return: false|int False on failure, the item's new value on success. |
| wp_cache_init() X-Ref |
| Sets up Object Cache Global and assigns it. |
| wp_cache_replace( $key, $data, $group = '', $expire = 0 ) X-Ref |
| Replaces the contents of the cache with new data. param: int|string $key What to call the contents in the 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 not exists, true if contents were replaced |
| wp_cache_set( $key, $data, $group = '', $expire = 0 ) X-Ref |
| Saves the data to the cache. param: int|string $key What to call the contents in the 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 on failure, true on success |
| wp_cache_switch_to_blog( $blog_id ) X-Ref |
| Switch the interal blog id. This changes the blog id used to create keys in blog specific groups. param: int $blog_id Blog ID |
| wp_cache_add_global_groups( $groups ) X-Ref |
| Adds a group or set of groups to the list of global groups. param: string|array $groups A group or an array of groups to add |
| wp_cache_add_non_persistent_groups( $groups ) X-Ref |
| Adds a group or set of groups to the list of non-persistent groups. param: string|array $groups A group or an array of groups to add |
| wp_cache_reset() X-Ref |
| 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. |
| Generated: Tue Mar 25 01:41:18 2014 | WordPress honlapkészítés: online1.hu |