wp_cache_add() WordPress Function
The wp_cache_add() function allows you to add data to the WordPress object cache. This is useful for caching data that is expensive to generate, such as results from a database query. The function takes two arguments: the key to use for the cached data, and the data to be cached. The function returns true if the data was successfully cached, or false if there was an error.
wp_cache_add( int|string $key, mixed $data, string $group = '', int $expire ) #
Adds data to the cache, if the cache key doesn’t already exist.
Description
See also
Parameters
- $key
(int|string)(Required)The cache key to use for retrieval later.
- $data
(mixed)(Required)The data to add to the cache.
- $group
(string)(Optional) The group to add the cache to. Enables the same key to be used across groups.
Default value: ''
- $expire
(int)(Optional) When the cache data should expire, in seconds. Default 0 (no expiration).
Return
(bool) True on success, false if cache key and group already exist.
Source
File: wp-includes/cache.php
function wp_cache_add( $key, $data, $group = '', $expire = 0 ) {
global $wp_object_cache;
return $wp_object_cache->add( $key, $data, $group, (int) $expire );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |