WP_Rewrite::add_rule( string $regex, string|array $query, string $after = 'bottom' )
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.
Parameters
-
$regexstring Required -
Regular expression to match request against.
-
$querystring|array Required -
The corresponding query vars for this rewrite rule.
-
$afterstring Optional -
Priority of the new rule. Accepts
'top'or'bottom'. Default'bottom'.Default:
'bottom'
Source
File: wp-includes/class-wp-rewrite.php.
View all references
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
| Version | Description |
|---|---|
| 4.4.0 | Array support was added to the $query parameter. |
| 2.1.0 | Introduced. |