[ Index ]

PHP Cross Reference of BackPress

title

Body

[close]

/includes/ -> functions.wp-object-cache.php (summary)

Object Cache API

File Size: 173 lines (5 kb)
Included or required: 2 times
Referenced: 0 times
Includes or requires: 0 files

Defines 10 functions

  wp_cache_add()
  wp_cache_close()
  wp_cache_delete()
  wp_cache_flush()
  wp_cache_get()
  wp_cache_init()
  wp_cache_replace()
  wp_cache_set()
  wp_cache_add_global_groups()
  wp_cache_add_non_persistent_groups()

Functions
Functions that are not part of a class:

wp_cache_add($key, $data, $flag = '', $expire = 0)   X-Ref
Adds data to the cache, if the cache key doesn't aleady exist.

since: 2.0.0
param: int|string $key The cache ID to use for retrieval later
param: mixed $data The data to add to the cache store
param: string $flag The group to add the cache to
param: int $expire When the cache data should be expired
return: unknown

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.

since: 2.0.0
return: bool Always returns True

wp_cache_delete($id, $flag = '')   X-Ref
Removes the cache contents matching ID and flag.

since: 2.0.0
param: int|string $id What the contents in the cache are called
param: string $flag Where the cache contents are grouped
return: bool True on successful removal, false on failure

wp_cache_flush( $group = null )   X-Ref
Removes all cache items.

since: 2.0.0
return: bool Always returns true

wp_cache_get($id, $flag = '')   X-Ref
Retrieves the cache contents from the cache by ID and flag.

since: 2.0.0
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

wp_cache_init()   X-Ref
Sets up Object Cache Global and assigns it.

since: 2.0.0

wp_cache_replace($key, $data, $flag = '', $expire = 0)   X-Ref
Replaces the contents of the cache with new data.

since: 2.0.0
param: int|string $id What to call the contents in the cache
param: mixed $data The contents to store in the cache
param: string $flag Where to group the cache contents
param: int $expire When to expire the cache contents
return: bool False if cache ID and group already exists, true on success

wp_cache_set($key, $data, $flag = '', $expire = 0)   X-Ref
Saves the data to the cache.

since: 2.0
param: int|string $id What to call the contents in the cache
param: mixed $data The contents to store in the cache
param: string $flag Where to group the cache contents
param: int $expire When to expire the cache contents
return: bool False if cache ID and group already exists, true on success

wp_cache_add_global_groups( $groups )   X-Ref
Adds a group or set of groups to the list of global groups.

since: 2.6.0
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.

since: 2.6.0
param: string|array $groups A group or an array of groups to add



Generated: Wed Dec 19 01:01:51 2018 Cross-referenced by PHPXref 0.7.1