WP_Speculation_Rules::add_rule( string $mode, string $id, array $rule ): bool

Compatibility

Present in 4 of the 5 tracked releases, added in 6.8.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$modestring

Speculative loading mode. Either 'prefetch' or 'prerender'.

$idstring

Unique string identifier for the speculation rule.

$rulearray

Return value

bool

True on success, false if invalid parameters are provided.

Performance profile

How much work a call to WP_Speculation_Rules::add_rule() 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

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

23–68

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 205.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()one call below WP_Speculation_Rules::add_rule()

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 14 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Speculation_Rules::add_rule() can have, taken from its control-flow graph on PHP 8.5.

Uses · 8

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• esc_html()Escaping for HTML blocks.
• WP_Speculation_Rules::is_valid_mode()Checks whether the given speculation rules mode is valid.
• WP_Speculation_Rules::is_valid_id()Checks whether the given ID is valid.
• WP_Speculation_Rules::has_rule()Checks whether a speculation rule for the given mode and ID already exists.
• WP_Speculation_Rules::is_valid_source()Checks whether the given speculation rules source is valid.
• WP_Speculation_Rules::is_valid_eagerness()Checks whether the given speculation rules eagerness is valid.

Source code

View on Trac ↗View on GitHub ↗

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'96			);97			return false;98		}99 100		if ( $this->has_rule( $mode, $id ) ) {101			_doing_it_wrong(102				__METHOD__,103				sprintf(104					/* translators: %s: invalid ID value */105					__( 'A speculation rule with ID "%s" already exists.' ),106					esc_html( $id )107				),108				'6.8.0'109			);110			return false;111		}112 113		/*114		 * Perform some basic speculation rule validation.115		 * Every rule must have either a 'where' key or a 'urls' key, but not both.116		 * The presence of a 'where' key implies a 'source' of 'document', while the presence of a 'urls' key implies117		 * a 'source' of 'list'.118		 */119		if (120			( ! isset( $rule['where'] ) && ! isset( $rule['urls'] ) ) ||121			( isset( $rule['where'] ) && isset( $rule['urls'] ) )122		) {123			_doing_it_wrong(124				__METHOD__,125				sprintf(126					/* translators: 1: allowed key, 2: alternative allowed key */127					__( 'A speculation rule must include either a "%1$s" key or a "%2$s" key, but not both.' ),128					'where',129					'urls'130				),131				'6.8.0'132			);133			return false;134		}135		if ( isset( $rule['source'] ) ) {136			if ( ! self::is_valid_source( $rule['source'] ) ) {137				_doing_it_wrong(138					__METHOD__,139					sprintf(140						/* translators: %s: invalid source value */141						__( 'The value "%s" is not a valid source for a speculation rule.' ),142						esc_html( $rule['source'] )143					),144					'6.8.0'145				);146				return false;147			}148 149			if ( 'list' === $rule['source'] && isset( $rule['where'] ) ) {150				_doing_it_wrong(151					__METHOD__,152					sprintf(

Changelog

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 7.1.0 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.