wppaste
WordPress

wp_cache_replace( int|string $key, mixed $data, string $group = '', int $expire = 0 ): bool

Since
2.0.0
Source
wp-includes/cache.php:84
Replaces the contents of the cache with new data.

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
The key for the cache data that should be replaced.
$datamixed
The new data to store in the cache.
$groupstringoptional
The group for the cache data that should be replaced.
Default empty.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_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
Trivial

Reaches the database via ->replace().

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
13

Executed per call on PHP 8.5. The body compiles to 13.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • cacheobject cachewp_cache_replace()this function does it
  • sqldatabase query->replace()called directly

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_cache_replace() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always13->replace()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 13 instructions, 13 executed per call, 0 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.

Source code

function wp_cache_replace( $key, $data, $group = '', $expire = 0 ) {	global $wp_object_cache; 	return $wp_object_cache->replace( $key, $data, $group, (int) $expire );}

Changelog

Introduced in 2.0.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/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.