WP_Rewrite::add_rule( string $regex, string|array $query, string $after = 'bottom' )
- Since
- 2.1.0, 4.4.0
- Source
wp-includes/class-wp-rewrite.php:1684
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 WP_Rewrite::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
- Scaling
- Constant
- Instructions
- 18–26
- Plugin surface
- None
- Called by
- 0
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 48.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Rewrite::add_rule() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_array($query) && $front !== false | 18 | add_query_arg(), ->add_external_rule() |
!is_array($query) && $front !== false | 19–20 | ->add_external_rule() |
is_array($query) && $front === false | 24 | add_query_arg() |
!is_array($query) && $front === false | 25–26 | none |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 48 | 18–26 | 4 | |
| 8.5 | 48 | 18–26 | 4 | |
| 8.4 | 48 | 18–26 | 4 | 10 fewer instructions than PHP 8.3 |
| 8.3 | 58 | 18–35 | 4 | |
| 8.2 | 58 | 18–35 | 4 | |
| 8.1 | 58 | 18–35 | 4 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 60 | 18–36 | 4 |
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
- add_query_arg()Retrieves a modified URL query string.
- str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
- WP_Rewrite::add_external_rule()Adds a rewrite rule that doesn't correspond to index.php.
Source code
public function add_rule( $regex, $query, $after = 'bottom' ) { if ( is_array( $query ) ) { $external = false; $query = add_query_arg( $query, 'index.php' ); } else { $index = ! str_contains( $query, '?' ) ? strlen( $query ) : strpos( $query, '?' ); $front = substr( $query, 0, $index ); $external = $front !== $this->index; } // "external" = it doesn't correspond to index.php. if ( $external ) { $this->add_external_rule( $regex, $query ); } else { if ( 'bottom' === $after ) { $this->extra_rules = array_merge( $this->extra_rules, array( $regex => $query ) ); } else { $this->extra_rules_top = array_merge( $this->extra_rules_top, array( $regex => $query ) ); } } }Changelog
Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$query parameter.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 tag, from
src/wp-includes/class-wp-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.