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
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.
Cost profile
Measured from the compiled opcodes, not from a stopwatch. Every number here is identical on any machine that runs the same PHP version, and every function in core is ranked by these figures.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 9–28
- Plugin surface
- None
- Called by
- 3
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.4, depending on the branch taken. The body compiles to 29.
Nothing here hands control to plugin code.
3 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Object_Cache::set() can have, taken from its control-flow graph on PHP 8.4.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 9–28 | ->is_valid_key() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
7.4 | 29 | 9–28 | 5 | Compiles to the same instructions |
8.1 | 29 | 9–28 | 5 | Compiles to the same instructions |
8.2 | 29 | 9–28 | 5 | Compiles to the same instructions |
8.3 | 29 | 9–28 | 5 | Compiles to the same instructions |
8.4 | 29 | 9–28 | 5 | Compiles to the same instructions |
Oldest PHP that compiles this body: 7.4. An instruction is not a fixed amount of time, so a version with the same count is not necessarily the same speed; what the count rules out is a difference in the work itself.
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.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 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.