add_rewrite_tag( string $tag, string $regex, string $query = '' )

Add a new rewrite tag (like %postname%).

Description

The $query parameter is optional. If it is omitted you must ensure that you call this on, or before, the ‘init’ hook. This is because $query defaults to "$tag=", and for this to work a new query var has to be added.

Parameters

$tag

(Required) Name of the new rewrite tag.

$regex

(Required) Regular expression to substitute the tag for in rewrite rules.

$query

(Optional) String to append to the rewritten query. Must end in '='.

Default value: ''

Source

File: wp-includes/rewrite.php

function add_rewrite_tag( $tag, $regex, $query = '' ) {
	// validate the tag's name
	if ( strlen( $tag ) < 3 || $tag[0] != '%' || $tag[ strlen($tag) - 1 ] != '%' )
		return;

	global $wp_rewrite, $wp;

	if ( empty( $query ) ) {
		$qv = trim( $tag, '%' );
		$wp->add_query_var( $qv );
		$query = $qv . '=';
	}

	$wp_rewrite->add_rewrite_tag( $tag, $regex, $query );
}

Expand Source Code View on GitHub

Uses

Uses
Uses	Description
wp-includes/class-wp-rewrite.php: WP_Rewrite::add_rewrite_tag()	Adds or updates existing rewrite tags (e.g. %postname%).
wp-includes/class-wp.php: WP::add_query_var()	Add name to list of public query variables.

Used By

Used By
Used By	Description
wp-includes/class-wp-post-type.php: WP_Post_Type::add_rewrite_rules()	Adds the necessary rewrite rules for the post type.
wp-includes/class-wp-taxonomy.php: WP_Taxonomy::add_rewrite_rules()	Adds the necessary rewrite rules for the taxonomy.

Changelog

Changelog
Version	Description
WP-2.1.0	Introduced.