wppaste
WordPress

BaseDataCache::get_data( string $key, mixed $default = null ): array|mixed

Source
wp-includes/SimplePie/src/Cache/BaseDataCache.php:45
Fetches a value from the cache.

Description

Equivalent to \Psr\SimpleCache\CacheInterface::get()

public function get(string $key, mixed $default = null): mixed;

Compatibility

WordPress
core
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

$keystring
The unique key of this item in the cache.
$defaultmixedoptional
Default value to return if the key does not exist.Default: null

Return value

array|mixed
The value of the item from the cache, or $default in case of cache miss.

Performance profile

How much work a call to BaseDataCache::get_data() 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–17

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

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 one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
always9–11->load()
is_array($data) && $data16–17->load(), time()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 20 instructions, 9–17 executed per call, 3 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

View on Trac View on GitHub 

    public function get_data(string $key, $default = null)    {        $data = $this->cache->load();         if (!is_array($data)) {            return $default;        }         // ignore data if internal cache expiration time is not set        if (!array_key_exists('__cache_expiration_time', $data)) {            return $default;        }         // ignore data if internal cache expiration time is expired        if ($data['__cache_expiration_time'] < time()) {            return $default;        }         // remove internal cache expiration time        unset($data['__cache_expiration_time']);         return $data;    }

Changelog

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/SimplePie/src/Cache/BaseDataCache.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.