WP_Object_Cache::get( int|string $key, string $group = 'default', bool $force = false, bool|null $found = null ): mixed|false

Description

Compatibility

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 under which the cache contents are stored.

$groupstringoptional

Where the cache contents are grouped. Default 'default'.Default: 'default'

$forcebooloptional

Unused. Whether to force an update of the local cache from the persistent cache. Default false.Default: false

$foundbool|nulloptional

Whether the key was found in the cache (passed by reference).
Disambiguates a return of false, a storable value. Default null.Default: null

Return value

mixed|false

The cache contents on success, false on failure to retrieve contents.

Performance profile

How much work a call to WP_Object_Cache::get() 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

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

9–37

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 46.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Object_Cache::get() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• 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.

Used by · 1

• WP_Object_Cache::get_multiple()Retrieves multiple values from the cache in one call.

Source code

View on Trac ↗View on GitHub ↗

362	public function get( $key, $group = 'default', $force = false, &$found = null ) {363		if ( ! $this->is_valid_key( $key ) ) {364			return false;365		}366 367		if ( empty( $group ) ) {368			$group = 'default';369		}370 371		if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) ) {372			$key = $this->blog_prefix . $key;373		}374 375		if ( $this->_exists( $key, $group ) ) {376			$found             = true;377			$this->cache_hits += 1;378			if ( is_object( $this->cache[ $group ][ $key ] ) ) {379				return clone $this->cache[ $group ][ $key ];380			} else {381				return $this->cache[ $group ][ $key ];382			}383		}384 385		$found               = false;386		$this->cache_misses += 1;387		return false;388	}

Changelog

Introduced in 2.0.0. One change between 6.7.7 and 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/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.