WP_Speculation_Rules

Properties · 4

$rules_by_modearray<string,private

Stored rules, as a map of $mode => $rules pairs.

$mode_allowlistarray<string,private static

The allowed speculation rules modes as a map, used for validation.

$eagerness_allowlistarray<string,private static

The allowed speculation rules eagerness levels as a map, used for validation.

$source_allowlistarray<string,private static

The allowed speculation rules sources as a map, used for validation.

Methods · 7

• add_rule()Adds a speculation rule to the speculation rules to consider.
• has_rule()Checks whether a speculation rule for the given mode and ID already exists.
• jsonSerialize()Returns the speculation rules data ready to be JSON-encoded.
• is_valid_id()Checks whether the given ID is valid.
• is_valid_mode()Checks whether the given speculation rules mode is valid.
• is_valid_eagerness()Checks whether the given speculation rules eagerness is valid.
• is_valid_source()Checks whether the given speculation rules source is valid.

Source

View on Trac ↗View on GitHub ↗

16final class WP_Speculation_Rules implements JsonSerializable {17 18	/**19	 * Stored rules, as a map of `$mode => $rules` pairs.20	 *21	 * Every `$rules` value is a map of `$id => $rule` pairs.22	 *23	 * @since 6.8.024	 * @var array<string, array<string, mixed>>25	 */26	private $rules_by_mode = array();27 28	/**29	 * The allowed speculation rules modes as a map, used for validation.30	 *31	 * @since 6.8.032	 * @var array<string, bool>33	 */34	private static $mode_allowlist = array(35		'prefetch'  => true,36		'prerender' => true,37	);38 39	/**40	 * The allowed speculation rules eagerness levels as a map, used for validation.41	 *42	 * @since 6.8.043	 * @var array<string, bool>44	 */45	private static $eagerness_allowlist = array(46		'immediate'    => true,47		'eager'        => true,48		'moderate'     => true,49		'conservative' => true,50	);51 52	/**53	 * The allowed speculation rules sources as a map, used for validation.54	 *55	 * @since 6.8.056	 * @var array<string, bool>57	 */58	private static $source_allowlist = array(59		'list'     => true,60		'document' => true,61	);62 63	/**64	 * Adds a speculation rule to the speculation rules to consider.65	 *66	 * @since 6.8.067	 *68	 * @param string               $mode Speculative loading mode. Either 'prefetch' or 'prerender'.69	 * @param string               $id   Unique string identifier for the speculation rule.70	 * @param array<string, mixed> $rule Associative array of rule arguments.71	 * @return bool True on success, false if invalid parameters are provided.72	 */73	public function add_rule( string $mode, string $id, array $rule ): bool {74		if ( ! self::is_valid_mode( $mode ) ) {75			_doing_it_wrong(76				__METHOD__,77				sprintf(78					/* translators: %s: invalid mode value */79					__( 'The value "%s" is not a valid speculation rules mode.' ),80					esc_html( $mode )81				),82				'6.8.0'83			);84			return false;85		}86 87		if ( ! $this->is_valid_id( $id ) ) {88			_doing_it_wrong(89				__METHOD__,90				sprintf(91					/* translators: %s: invalid ID value */92					__( 'The value "%s" is not a valid ID for a speculation rule.' ),93					esc_html( $id )94				),95				'6.8.0'

History

Introduced in 6.8.0. Unchanged from 6.8.8 through 7.1.0.

1. 6.8.8
2. 6.9.7
3. 7.0.4
4. 7.1.0

Signature, return type and hooks compared across 4 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/class-wp-speculation-rules.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.