wppaste
WordPress

WP_Theme::cache_add( string $key, array|string $data ): bool

Since
3.4.0
Source
wp-includes/class-wp-theme.php:813
Adds theme data to cache.

Description

Cache entries keyed by the theme and the type of data.

Compatibility

WordPress
since 3.4.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

$keystring
Type of data to store (theme, screenshot, headers, post_templates)
$dataarray|string
Data to store

Return value

bool
Return value from wp_cache_add()

Performance profile

How much work a call to WP_Theme::cache_add() 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
Light

Only touches the object cache, via wp_cache_add().

Scaling
Constant

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

Instructions
14

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
4

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

What it touches

  • cacheobject cachewp_cache_add()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_Theme::cache_add() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always14wp_cache_add()

Across PHP versions

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

Uses · 1

  • wp_cache_add()Adds data to the cache, if the cache key doesn't already exist.

Used by · 4

Source code

View on Trac View on GitHub 

	private function cache_add( $key, $data ) {		return wp_cache_add( $key . '-' . $this->cache_hash, $data, 'themes', self::$cache_expiration );	}

Changelog

Introduced in 3.4.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 6.8.8 tag, from src/wp-includes/class-wp-theme.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.