wppaste
WordPress

add_rewrite_rule( string $regex, string|array $query, string $after = 'bottom' )

Since
2.1.0, 4.4.0
Source
wp-includes/rewrite.php:140
Adds a rewrite rule that transforms a URL structure to a set of query vars.

Description

Any value in the $after parameter that isn't 'bottom' will result in the rule being placed at the top of the rewrite rules.

Compatibility

WordPress
since 4.4.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

$regexstring
Regular expression to match request against.
$querystring|array
The corresponding query vars for this rewrite rule.
$afterstringoptional
Priority of the new rule. Accepts 'top' or 'bottom'. Default 'bottom'.Default: 'bottom'

Performance profile

How much work a call to add_rewrite_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
10

Executed per call on PHP 8.5. The body compiles to 10.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
3

3 places 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 add_rewrite_rule() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always10->add_rule()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 10 instructions, 10 executed per call, 0 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.

Used by · 3

Source code

View on Trac View on GitHub 

function add_rewrite_rule( $regex, $query, $after = 'bottom' ) {	global $wp_rewrite; 	$wp_rewrite->add_rule( $regex, $query, $after );}

Changelog

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

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

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

4.4.0
Array support was added to the $query parameter.from the docblock
2.1.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/rewrite.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.