WP_Object_Cache::set( int|string $key, mixed $data, string $group = 'default', int $expire = 0 ): bool
- Since
- 2.0.0, 6.1.0
- Source
wp-includes/class-wp-object-cache.php:301
Sets the data contents into the cache.
Description
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.
Parameters
$keyint|string- What to call the contents in the cache.
$datamixed- The contents to store in the cache.
$groupstringoptional- Where to group the cache contents. Default 'default'.Default:
'default' $expireintoptional- Not used.Default:
0
Return
bool- True if contents were set, false if key is invalid.
Uses · 1
- WP_Object_Cache::is_valid_key()Serves as a utility function to determine whether a key is valid.
Used by · 3
- WP_Object_Cache::add()Adds data to the cache if it doesn't already exist.
- WP_Object_Cache::replace()Replaces the contents in the cache, if contents already exist.
- WP_Object_Cache::set_multiple()Sets multiple values to the cache in one call.
Source
public function set( $key, $data, $group = 'default', $expire = 0 ) { if ( ! $this->is_valid_key( $key ) ) { return false; } if ( empty( $group ) ) { $group = 'default'; } if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) { $key = $this->blog_prefix . $key; } if ( is_object( $data ) ) { $data = clone $data; } $this->cache[ $group ][ $key ] = $data; return true; }History
Introduced in 2.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
6.1.0
Returns false if cache key is invalid.from the docblock
2.0.0
Introduced.from the docblock
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/class-wp-object-cache.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.