wp_cache_add( int|string $key, mixed $data, string $group = '', int $expire = 0 ): bool
- Since
- 2.0.0
- Source
wp-includes/cache.php:41
Compatibility
- WordPress
- since 2.0.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
$keyint|string- The cache key to use for retrieval later.
$datamixed- The data to add to the cache.
$groupstringoptional- The group to add the cache to. Enables the same key to be used across groups. Default empty.Default:
'' $expireintoptional- When the cache data should expire, in seconds.
Default 0 (no expiration).Default:0
Return value
bool- True on success, false if cache key and group already exist.
Performance profile
How much work a call to wp_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
- Trivial
- Scaling
- Constant
- Instructions
- 13
- Plugin surface
- None
- Called by
- 23
Only touches the object cache, via wp_cache_add().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 13.
Nothing here hands control to plugin code.
23 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- cacheobject cache
wp_cache_add()this function does it
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_cache_add() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 13 | ->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: 13 instructions, 13 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.
Used by · 23
- WP_Comment::get_instance()Retrieves a WP_Comment instance.
- WP_Comment_Query::get_comments()Get a list of comments matching the query vars.
- WP_Network::get_instance()Retrieves a network from the database by its ID.
- WP_Network_Query::get_networks()Gets a list of networks matching the query vars.
- WP_Post::get_instance()Retrieve WP_Post instance.
- WP_Query::get_posts()Retrieves an array of posts based on query variables.
- WP_Site::get_instance()Retrieves a site from the database by its ID.
- WP_Site_Query::get_sites()Retrieves a list of sites matching the query vars.
- WP_Term::get_instance()Retrieve WP_Term instance.
- WP_Term_Query::get_terms()Retrieves the query results.
- WP_Theme::cache_add()Adds theme data to cache.
- WP_User_Query::query()Executes the query, with the current variables.
Show all 23
- get_all_page_ids()Gets a list of page IDs.
- get_bookmark()Retrieves bookmark data.
- get_inline_data()Adds hidden fields with the data for use in the inline editor for posts and pages.
- get_option()Retrieves an option value based on an option name.
- get_terms_to_edit()Gets comma-separated list of terms available to edit for the given post ID.
- get_the_terms()Retrieves the terms of the taxonomy that are attached to the post.
- ms_load_current_site_and_network()Identifies the network and site of a requested domain and path and populates the corresponding network and site global objects as part of the multisite bootstrap process.
- update_user_caches()Updates all user caches.
- wp_cache_add_multiple()Adds multiple values to the cache in one call, if the cache keys don't already exist.
- wp_load_alloptions()Loads and caches all autoloaded options, if available or all options.
- wp_mime_type_icon()Retrieves the icon for a MIME type or attachment.
Source code
function wp_cache_add( $key, $data, $group = '', $expire = 0 ) { global $wp_object_cache; return $wp_object_cache->add( $key, $data, $group, (int) $expire );}Changelog
Introduced in 2.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/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.