Filters the way that speculation rules are configured.
Description
The Speculation Rules API is a web API that allows to automatically prefetch or prerender certain URLs on the page, which can lead to near-instant page load times. This is also referred to as speculative loading.
There are two aspects to the configuration:
- The “mode” (whether to “prefetch” or “prerender” URLs).
- The “eagerness” (whether to speculatively load URLs in an “eager”, “moderate”, or “conservative” way).
By default, the speculation rules configuration is decided by WordPress Core (“auto”). This filter can be used to force a certain configuration, which could for instance load URLs more or less eagerly.
For logged-in users or for sites that are not configured to use pretty permalinks, the default value is null, indicating that speculative loading is entirely disabled.
See also
Parameters
- string>|null $config Associative array with
'mode'and'eagerness'keys, ornull. The default value for both of the keys is'auto'. Other possible values for'mode'are'prefetch'and'prerender'. Other possible values for'eagerness'are'eager','moderate', and'conservative'. The valuenullis used to disable speculative loading entirely.
Source
$config = apply_filters( 'wp_speculation_rules_configuration', $config );
Changelog
| Version | Description |
|---|---|
| 6.8.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.