| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
Object Cache API
| File Size: | 370 lines (12 kb) |
| Included or required: | 1 time |
| Referenced: | 0 times |
| Includes or requires: | 1 file wp-includes/class-wp-object-cache.php |
| wp_cache_init() X-Ref |
| Sets up Object Cache Global and assigns it. since: 2.0.0 |
| wp_cache_add( $key, $data, $group = '', $expire = 0 ) X-Ref |
| Adds data to the cache, if the cache key doesn't already exist. return: bool True on success, false if cache key and group already exist. param: int|string $key The cache key to use for retrieval later. param: mixed $data The data to add to the cache. param: string $group Optional. The group to add the cache to. Enables the same key param: int $expire Optional. When the cache data should expire, in seconds. since: 2.0.0 |
| wp_cache_add_multiple( array $data, $group = '', $expire = 0 ) X-Ref |
| Adds multiple values to the cache in one call. return: bool[] Array of return values, grouped by key. Each value is either param: array $data Array of keys and values to be set. param: string $group Optional. Where the cache contents are grouped. Default empty. param: int $expire Optional. When to expire the cache contents, in seconds. since: 6.0.0 |
| wp_cache_replace( $key, $data, $group = '', $expire = 0 ) X-Ref |
| Replaces the contents of the cache with new data. return: bool True if contents were replaced, false if original value does not exist. param: int|string $key The key for the cache data that should be replaced. param: mixed $data The new data to store in the cache. param: string $group Optional. The group for the cache data that should be replaced. param: int $expire Optional. When to expire the cache contents, in seconds. since: 2.0.0 |
| wp_cache_set( $key, $data, $group = '', $expire = 0 ) X-Ref |
| Saves the data to the cache. Differs from wp_cache_add() and wp_cache_replace() in that it will always write data. return: bool True on success, false on failure. param: int|string $key The cache key to use for retrieval later. param: mixed $data The contents to store in the cache. param: string $group Optional. Where to group the cache contents. Enables the same key param: int $expire Optional. When to expire the cache contents, in seconds. since: 2.0.0 |
| wp_cache_set_multiple( array $data, $group = '', $expire = 0 ) X-Ref |
| Sets multiple values to the cache in one call. return: bool[] Array of return values, grouped by key. Each value is either param: array $data Array of keys and values to be set. param: string $group Optional. Where the cache contents are grouped. Default empty. param: int $expire Optional. When to expire the cache contents, in seconds. since: 6.0.0 |
| wp_cache_get( $key, $group = '', $force = false, &$found = null ) X-Ref |
| Retrieves the cache contents from the cache by key and group. return: mixed|false The cache contents on success, false on failure to retrieve contents. param: int|string $key The key under which the cache contents are stored. param: string $group Optional. Where the cache contents are grouped. Default empty. param: bool $force Optional. Whether to force an update of the local cache param: bool $found Optional. Whether the key was found in the cache (passed by reference). since: 2.0.0 |
| wp_cache_get_multiple( $keys, $group = '', $force = false ) X-Ref |
| Retrieves multiple values from the cache in one call. return: array Array of return values, grouped by key. Each value is either param: array $keys Array of keys under which the cache contents are stored. param: string $group Optional. Where the cache contents are grouped. Default empty. param: bool $force Optional. Whether to force an update of the local cache since: 5.5.0 |
| wp_cache_delete( $key, $group = '' ) X-Ref |
| Removes the cache contents matching key and group. return: bool True on successful removal, false on failure. param: int|string $key What the contents in the cache are called. param: string $group Optional. Where the cache contents are grouped. Default empty. since: 2.0.0 |
| wp_cache_delete_multiple( array $keys, $group = '' ) X-Ref |
| Deletes multiple values from the cache in one call. return: bool[] Array of return values, grouped by key. Each value is either param: array $keys Array of keys under which the cache to deleted. param: string $group Optional. Where the cache contents are grouped. Default empty. since: 6.0.0 |
| wp_cache_incr( $key, $offset = 1, $group = '' ) X-Ref |
| Increments numeric cache item's value. return: int|false The item's new value on success, false on failure. param: int|string $key The key for the cache contents that should be incremented. param: int $offset Optional. The amount by which to increment the item's value. param: string $group Optional. The group the key is in. Default empty. since: 3.3.0 |
| wp_cache_decr( $key, $offset = 1, $group = '' ) X-Ref |
| Decrements numeric cache item's value. return: int|false The item's new value on success, false on failure. param: int|string $key The cache key to decrement. param: int $offset Optional. The amount by which to decrement the item's value. param: string $group Optional. The group the key is in. Default empty. since: 3.3.0 |
| wp_cache_flush() X-Ref |
| Removes all cache items. return: bool True on success, false on failure. since: 2.0.0 |
| wp_cache_flush_runtime() X-Ref |
| Removes all cache items from the in-memory runtime cache. return: bool True on success, false on failure. since: 6.0.0 |
| 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: true Always returns true. since: 2.0.0 |
| wp_cache_add_global_groups( $groups ) X-Ref |
| Adds a group or set of groups to the list of global groups. param: string|string[] $groups A group or an array of groups to add. since: 2.6.0 |
| 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|string[] $groups A group or an array of groups to add. since: 2.6.0 |
| wp_cache_switch_to_blog( $blog_id ) X-Ref |
| Switches the internal blog ID. This changes the blog id used to create keys in blog specific groups. param: int $blog_id Site ID. since: 3.5.0 |
| wp_cache_reset() X-Ref |
| Resets internal cache keys and structures. If the cache back end uses global blog or site IDs as part of its cache keys, this function instructs the back end 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 penalty for using it is high. since: 3.0.0 |
| Generated: Thu Nov 21 01:00:03 2024 | Cross-referenced by PHPXref 0.7.1 |