Retrieves the cache contents, if it exists.
Description
The contents will be first attempted to be retrieved by searching by the key in the cache group. If the cache is hit (success) then the contents are returned.
On failure, the number of cache misses will be incremented.
Parameters
$keyint|stringrequired- 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 $foundbooloptional- Whether the key was found in the cache (passed by reference).
Disambiguates a return of false, a storable value.Default:
null
Source
public function get( $key, $group = 'default', $force = false, &$found = null ) {
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 ( $this->_exists( $key, $group ) ) {
$found = true;
$this->cache_hits += 1;
if ( is_object( $this->cache[ $group ][ $key ] ) ) {
return clone $this->cache[ $group ][ $key ];
} else {
return $this->cache[ $group ][ $key ];
}
}
$found = false;
$this->cache_misses += 1;
return false;
}
Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.