WP_Object_Cache::replace( int|string $key, mixed $data, string $group = 'default', int $expire = 0 ): bool
- Since
- 2.0.0
- Source
wp-includes/class-wp-object-cache.php:259
Compatibility
- WordPress
- since 2.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
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- When to expire the cache contents, in seconds.
Default 0 (no expiration).Default:0
Return value
bool- True if contents were replaced, false if original value does not exist.
Performance profile
How much work a call to WP_Object_Cache::replace() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Constant
- Instructions
- 9–33
- Plugin surface
- None
- Called by
- 0
Reaches the database via WP_Object_Cache::replace().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 35.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- sqldatabase query
WP_Object_Cache::replace()this function does it
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Object_Cache::replace() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!->is_valid_key() | 9 | ->is_valid_key() |
->is_valid_key() && !->_exists() | 19–26 | ->is_valid_key(), ->_exists() |
->is_valid_key() && ->_exists() | 26–33 | ->is_valid_key(), ->_exists(), ->set() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 35 instructions, 9–33 executed per call, 5 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 3
- WP_Object_Cache::is_valid_key()Serves as a utility function to determine whether a key is valid.
- WP_Object_Cache::_exists()Serves as a utility function to determine whether a key exists in the cache.
- WP_Object_Cache::set()Sets the data contents into the cache.
Source code
public function replace( $key, $data, $group = 'default', $expire = 0 ) { if ( ! $this->is_valid_key( $key ) ) { return false; } if ( empty( $group ) ) { $group = 'default'; } $id = $key; if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) { $id = $this->blog_prefix . $key; } if ( ! $this->_exists( $id, $group ) ) { return false; } return $this->set( $key, $data, $group, (int) $expire ); }Changelog
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 6.9.7 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.