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

Description

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

mixed|false

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

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

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	}

History

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