WP_Theme::set_pattern_cache( array $patterns )
- Since
- 6.4.0, 6.6.0
- Source
wp-includes/class-wp-theme.php:2033
Compatibility
- WordPress
- since 6.6.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
$patternsarray- Block patterns data to set in cache.
Performance profile
How much work a call to WP_Theme::set_pattern_cache() 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
- Moderate
- Scaling
- Constant
- Instructions
- 25–38
- Plugin surface
- 1 hook
- Called by
- 1
Reads stored settings via get_site_option(), cached per request but not free on a cold cache.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 38.
Third-party callbacks on 'wp_theme_files_cache_ttl' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly - transienttransient
set_site_transient()called directly - cacheobject cache
wp_cache_set()one call below WP_Theme::set_pattern_cache() - optionnetwork option
get_site_option()one call below WP_Theme::set_pattern_cache()
Further down the call graph this can also reach serialize and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
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 WP_Theme::set_pattern_cache() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!$cache_expiration | 25 | ->get(), apply_filters(), set_site_transient() |
$cache_expiration | 38 | ->get(), apply_filters(), __(), sprintf(), _doing_it_wrong(), set_site_transient() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 38 instructions, 25–38 executed per call, 1 branch. 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.
Hooks and filters fired · 1
One hook fires while WP_Theme::set_pattern_cache() runs, in this order:
- apply_filters( wp_theme_files_cache_ttl )filterline 2047 (+14 into the body)
Filters the cache expiration time for theme files.
Uses · 5
- apply_filters()Calls the callback functions that have been added to a filter hook.
- _doing_it_wrong()Marks something as being incorrectly called.
- __()Retrieves the translation of $text.
- set_site_transient()Sets/updates the value of a site transient.
- WP_Theme::get()Gets a raw, unformatted theme header.
Used by · 1
- WP_Theme::get_block_patterns()Gets block pattern data for a specified theme.
Source code
private function set_pattern_cache( array $patterns ) { $pattern_data = array( 'version' => $this->get( 'Version' ), 'patterns' => $patterns, ); /** * Filters the cache expiration time for theme files. * * @since 6.6.0 * * @param int $cache_expiration Cache expiration time in seconds. * @param string $cache_type Type of cache being set. */ $cache_expiration = (int) apply_filters( 'wp_theme_files_cache_ttl', self::$cache_expiration, 'theme_block_patterns' ); // We don't want to cache patterns infinitely. if ( $cache_expiration <= 0 ) { _doing_it_wrong( __METHOD__, sprintf( /* translators: %1$s: The filter name.*/ __( 'The %1$s filter must return an integer value greater than 0.' ), '<code>wp_theme_files_cache_ttl</code>' ), '6.6.0' ); $cache_expiration = self::$cache_expiration; } set_site_transient( 'wp_theme_files_patterns-' . $this->cache_hash, $pattern_data, $cache_expiration ); }Changelog
Introduced in 6.4.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 7.1.0 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.