| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
Object Cache API: WP_Object_Cache class
| File Size: | 564 lines (16 kb) |
| Included or required: | 1 time |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WP_Object_Cache:: (22 methods):
__construct()
__get()
__set()
__isset()
__unset()
_exists()
add()
add_multiple()
replace()
set()
set_multiple()
get()
get_multiple()
delete()
delete_multiple()
incr()
decr()
flush()
add_global_groups()
switch_to_blog()
reset()
stats()
Class: WP_Object_Cache - X-Ref
Core class that implements an object cache.| __construct() X-Ref |
| Sets up object properties; PHP 5 style constructor. since: 2.0.8 |
| __get( $name ) X-Ref |
| Makes private properties readable for backward compatibility. since: 4.0.0 param: string $name Property to get. return: mixed Property. |
| __set( $name, $value ) X-Ref |
| Makes private properties settable for backward compatibility. since: 4.0.0 param: string $name Property to set. param: mixed $value Property value. return: mixed Newly-set property. |
| __isset( $name ) X-Ref |
| Makes private properties checkable for backward compatibility. since: 4.0.0 param: string $name Property to check if set. return: bool Whether the property is set. |
| __unset( $name ) X-Ref |
| Makes private properties un-settable for backward compatibility. since: 4.0.0 param: string $name Property to unset. |
| _exists( $key, $group ) X-Ref |
| Serves as a utility function to determine whether a key exists in the cache. since: 3.4.0 param: int|string $key Cache key to check for existence. param: string $group Cache group for the key existence check. return: bool Whether the key exists in the cache for the given group. |
| add( $key, $data, $group = 'default', $expire = 0 ) X-Ref |
| Adds data to the cache if it doesn't already exist. since: 2.0.0 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 Optional. Where to group the cache contents. Default 'default'. param: int $expire Optional. When to expire the cache contents, in seconds. return: bool True on success, false if cache key and group already exist. |
| add_multiple( array $data, $group = '', $expire = 0 ) X-Ref |
| Adds multiple values to the cache in one call. since: 6.0.0 param: array $data Array of keys and values to be added. param: string $group Optional. Where the cache contents are grouped. Default empty. param: int $expire Optional. When to expire the cache contents, in seconds. return: bool[] Array of return values, grouped by key. Each value is either |
| replace( $key, $data, $group = 'default', $expire = 0 ) X-Ref |
| Replaces the contents in the cache, if contents already exist. since: 2.0.0 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 Optional. Where to group the cache contents. Default 'default'. param: int $expire Optional. When to expire the cache contents, in seconds. return: bool True if contents were replaced, false if original value does not exist. |
| set( $key, $data, $group = 'default', $expire = 0 ) X-Ref |
| Sets the data contents into the cache. The cache contents are 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. since: 2.0.0 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 Optional. Where to group the cache contents. Default 'default'. param: int $expire Optional. Not used. return: true Always returns true. |
| set_multiple( array $data, $group = '', $expire = 0 ) X-Ref |
| Sets multiple values to the cache in one call. since: 6.0.0 param: array $data Array of key and value 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. return: bool[] Array of return values, grouped by key. Each value is always 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. since: 2.0.0 param: int|string $key The key under which the cache contents are stored. param: string $group Optional. Where the cache contents are grouped. Default 'default'. param: bool $force Optional. Unused. Whether to force an update of the local cache param: bool $found Optional. Whether the key was found in the cache (passed by reference). return: mixed|false The cache contents on success, false on failure to retrieve contents. |
| get_multiple( $keys, $group = 'default', $force = false ) X-Ref |
| Retrieves multiple values from the cache in one call. since: 5.5.0 param: array $keys Array of keys under which the cache contents are stored. param: string $group Optional. Where the cache contents are grouped. Default 'default'. param: bool $force Optional. Whether to force an update of the local cache return: array Array of return values, grouped by key. Each value is either |
| delete( $key, $group = 'default', $deprecated = false ) X-Ref |
| Removes the contents of the cache key in the group. If the cache key does not exist in the group, then nothing will happen. since: 2.0.0 param: int|string $key What the contents in the cache are called. param: string $group Optional. Where the cache contents are grouped. Default 'default'. param: bool $deprecated Optional. Unused. Default false. return: bool True on success, false if the contents were not deleted. |
| delete_multiple( array $keys, $group = '' ) X-Ref |
| Deletes multiple values from the cache in one call. since: 6.0.0 param: array $keys Array of keys to be deleted. param: string $group Optional. Where the cache contents are grouped. Default empty. return: bool[] Array of return values, grouped by key. Each value is either |
| incr( $key, $offset = 1, $group = 'default' ) X-Ref |
| Increments numeric cache item's value. since: 3.3.0 param: int|string $key The cache key to increment. 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 'default'. return: int|false The item's new value on success, false on failure. |
| decr( $key, $offset = 1, $group = 'default' ) X-Ref |
| Decrements numeric cache item's value. since: 3.3.0 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 'default'. return: int|false The item's new value on success, false on failure. |
| flush() X-Ref |
| Clears the object cache of all data. since: 2.0.0 return: true Always returns true. |
| add_global_groups( $groups ) X-Ref |
| Sets the list of global cache groups. since: 3.0.0 param: string|string[] $groups List of groups that are global. |
| 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. since: 3.5.0 param: int $blog_id Blog ID. |
| reset() X-Ref |
| Resets cache keys. since: 3.0.0 |
| 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. since: 2.0.0 |
| Generated: Tue Apr 23 01:00:02 2024 | Cross-referenced by PHPXref 0.7.1 |