wp_get_speculation_rules_default_configuration(): array<string,
- Since
- 7.1.0
- Source
wp-includes/speculative-loading.php:124
Description
WordPress Core defaults to a mode of 'prefetch' and an eagerness of 'conservative'. Hosting providers can override either default by way of the WP_SPECULATIVE_LOADING_DEFAULT_MODE and WP_SPECULATIVE_LOADING_DEFAULT_EAGERNESS constants or environment variables. This only changes what the 'auto' value resolves to, so a plugin which supplies an explicit mode or eagerness via the 'wp_speculation_rules_configuration' filter continues to take precedence.
Note that an eagerness of 'immediate' is not permitted as a default, since WordPress does not allow it for the document-level rules that it generates.
Compatibility
- WordPress
- since 7.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.
Return value
array<string,- string> Associative array with 'mode' and 'eagerness' keys.
Performance profile
How much work a call to wp_get_speculation_rules_default_configuration() 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
- 21–25
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
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 25.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
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_get_speculation_rules_default_configuration() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 21–25 | wp_get_speculative_loading_override(), ::WP_Speculation_Rules(), wp_get_speculative_loading_override(), ::WP_Speculation_Rules() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 25 instructions, 21–25 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.
Uses · 3
- wp_get_speculative_loading_override()Returns the value of a speculative loading override, as supplied by a constant or an environment variable.
- WP_Speculation_Rules::is_valid_mode()Checks whether the given speculation rules mode is valid.
- WP_Speculation_Rules::is_valid_eagerness()Checks whether the given speculation rules eagerness is valid.
Used by · 1
- wp_get_speculation_rules_configuration()Returns the speculation rules configuration.
Source code
function wp_get_speculation_rules_default_configuration(): array { $default_mode = 'prefetch'; $mode = wp_get_speculative_loading_override( 'WP_SPECULATIVE_LOADING_DEFAULT_MODE' ); if ( WP_Speculation_Rules::is_valid_mode( $mode ) ) { $default_mode = $mode; } $default_eagerness = 'conservative'; $eagerness = wp_get_speculative_loading_override( 'WP_SPECULATIVE_LOADING_DEFAULT_EAGERNESS' ); if ( WP_Speculation_Rules::is_valid_eagerness( $eagerness ) && // 'immediate' is a valid eagerness, but for safety WordPress does not allow it for document-level rules. 'immediate' !== $eagerness ) { $default_eagerness = $eagerness; } return array( 'mode' => $default_mode, 'eagerness' => $default_eagerness, );}Changelog
Introduced in 7.1.0.
Signature, return type and hooks compared across 1 parsed release.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/speculative-loading.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.