[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> cache-compat.php (summary)

Object Cache API functions missing from 3rd party object caches.

File Size: 143 lines (4 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 5 functions

  wp_cache_add_multiple()
  wp_cache_set_multiple()
  wp_cache_get_multiple()
  wp_cache_delete_multiple()
  wp_cache_flush_runtime()

Functions
Functions that are not part of a class:

wp_cache_add_multiple( array $data, $group = '', $expire = 0 )   X-Ref
Adds multiple values to the cache in one call, if the cache keys don't already exist.

Compat function to mimic wp_cache_add_multiple().

return: bool[] Array of return values, grouped by key. Each value is either
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.

wp_cache_set_multiple( array $data, $group = '', $expire = 0 )   X-Ref
Sets multiple values to the cache in one call.

Differs from wp_cache_add_multiple() in that it will always write data.

Compat function to mimic wp_cache_set_multiple().

return: bool[] Array of return values, grouped by key. Each value is either
since: 6.0.0
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.

wp_cache_get_multiple( $keys, $group = '', $force = false )   X-Ref
Retrieves multiple values from the cache in one call.

Compat function to mimic wp_cache_get_multiple().

return: array Array of return values, grouped by key. Each value is either
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 empty.
param: bool   $force Optional. Whether to force an update of the local cache

wp_cache_delete_multiple( array $keys, $group = '' )   X-Ref
Deletes multiple values from the cache in one call.

Compat function to mimic wp_cache_delete_multiple().

return: bool[] Array of return values, grouped by key. Each value is either
since: 6.0.0
param: array  $keys  Array of keys under which the cache to deleted.
param: string $group Optional. Where the cache contents are grouped. Default empty.

wp_cache_flush_runtime()   X-Ref
Removes all cache items from the in-memory runtime cache.

Compat function to mimic wp_cache_flush_runtime().

return: bool True on success, false on failure.
since: 6.0.0



Generated: Sun Jun 26 01:00:03 2022 Cross-referenced by PHPXref 0.7.1