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 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 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'
Source Source
File: wp-includes/rewrite.php
function add_rewrite_rule( $regex, $query, $after = 'bottom' ) {
global $wp_rewrite;
$wp_rewrite->add_rule( $regex, $query, $after );
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 4.4.0 | Array support was added to the $query parameter. |
| 2.1.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
Things that were in WP Codex site and did not get migrated for whatever reason.
NOTE: When using $matches[] to retrieve the values of a matched URL, capture group data starts at 1, not 0.
IMPORTANT: Do not forget to flush and regenerate the rewrite rules database after modifying rules. From WordPress Administration Screens, Select Settings -> Permalinks and just click Save Changes without any changes.
Feedback
When adding multiple rules, note that (as of 4.9.8) rules are applied in the order added, regardless of whether they’re at the top or the bottom E.g.:
add_rewrite_rule('^animals/(.*)', 'index.php?pagename=display-animal&animal=matches[1]', 'top'); add_rewrite_rule('^animals/mammals/(.*)', 'index.php?pagename=display-mammal&mammal-name=matches[1]', 'top');The second rule will never match, because the first rule always matches before the second one is processed. — By jbeninger —
A quick example: processing rules to make a subscribers page, hoping it helps.
add_action('init', function() { $page_id = 2; // update 2 (sample page) to your custom page ID where you can get the subscriber(s) data later $page_data = get_post( $page_id ); if( ! is_object($page_data) ) { // post not there return; } add_rewrite_rule( $page_data->post_name . '/subscriber/([^/]+)/?$', 'index.php?pagename=' . $page_data->post_name . '&my_subscribers=1&my_subscriber=$matches[1]', 'top' ); });Expand full source codeCollapse full source code
Now in your page template ( if you have one, or while filtering this custom page’s content ), you can get the displayed subscriber slug by calling
get_query_var('my_subscriber'), but first, pass'my_subscriber'to the query variables:add_filter('query_vars', function($vars) { $vars[] = "my_subscriber"; return $vars; });Example to add rewrite rule query as optional,hope it helps.
function custom_rewrite_rule() { add_rewrite_rule('^nutrition/?([^/]*)/?','index.php?page_id=12&food=$matches[1]','top'); } add_action('init', 'custom_rewrite_rule', 10, 0);The main things here is to add ? in the start of your regex. Like
?([^/]*)Now, you can set default value for optional query where you will use the query.
$food = $wp_query->get( 'food' ); if( isset($food) && !empty($food) ) { $nutrition = $food; }else{ $nutrition = 'strawberry'; //default value }Now you will get the same result for
http://example.com/nutrition/strawberryorhttp://example.com/nutrition/