add_rewrite_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

$regex

(string) (Required) Regular expression to match request against.

$query

(string|array) (Required) The corresponding query vars for this rewrite rule.

$after

(string) (Optional) Priority of the new rule. Accepts 'top' or 'bottom'.

Default value: 'bottom'

More Information

add_rewrite_rule() allows you to specify additional rewrite rules for WordPress. It is most commonly used in conjunction with add_rewrite_tag() (which allows WordPress to recognize custom post/get variables).

Source

File: wp-includes/rewrite.php

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

	$wp_rewrite->add_rule( $regex, $query, $after );
}

Uses

Uses	Description
wp-includes/class-wp-rewrite.php: WP_Rewrite::add_rule()	Adds a rewrite rule that transforms a URL structure to a set of query vars.

Used By

Used By	Description
wp-includes/sitemaps/class-wp-sitemaps.php: WP_Sitemaps::register_rewrites()	Registers sitemap rewrite tags and routing rules.
wp-includes/class-wp-post-type.php: WP_Post_Type::add_rewrite_rules()	Adds the necessary rewrite rules for the post type.
wp-includes/rest-api.php: rest_api_register_rewrites()	Adds REST rewrite rules.

Changelog

Version	Description
4.4.0	Array support was added to the `$query` parameter.
2.1.0	Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_rewrite_rule