WP_Post_Type::add_rewrite_rules()

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Performance profile

How much work a call to WP_Post_Type::add_rewrite_rules() 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

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

9–138

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 163.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()one call below WP_Post_Type::add_rewrite_rules()
• cacheobject cachewp_cache_get()one call below WP_Post_Type::add_rewrite_rules()
• serializeserialisationmaybe_unserialize()one call below WP_Post_Type::add_rewrite_rules()

Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 36 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Post_Type::add_rewrite_rules() can have, taken from its control-flow graph on PHP 8.5.

Uses · 6

• is_post_type_viewable()Determines whether a post type is considered "viewable".
• is_admin()Determines whether the current request is for an administrative interface page.
• get_option()Retrieves an option value based on an option name.
• add_rewrite_tag()Adds a new rewrite tag (like %postname%).
• add_rewrite_rule()Adds a rewrite rule that transforms a URL structure to a set of query vars.
• add_permastruct()Adds a permalink structure.

Source code

View on Trac ↗View on GitHub ↗

711	public function add_rewrite_rules() {712		global $wp_rewrite, $wp;713 714		if ( false !== $this->query_var && $wp && is_post_type_viewable( $this ) ) {715			$wp->add_query_var( $this->query_var );716		}717 718		if ( false !== $this->rewrite && ( is_admin() || get_option( 'permalink_structure' ) ) ) {719			if ( $this->hierarchical ) {720				add_rewrite_tag( "%$this->name%", '(.+?)', $this->query_var ? "{$this->query_var}=" : "post_type=$this->name&pagename=" );721			} else {722				add_rewrite_tag( "%$this->name%", '([^/]+)', $this->query_var ? "{$this->query_var}=" : "post_type=$this->name&name=" );723			}724 725			if ( $this->has_archive ) {726				$archive_slug = true === $this->has_archive ? $this->rewrite['slug'] : $this->has_archive;727				if ( $this->rewrite['with_front'] ) {728					$archive_slug = substr( $wp_rewrite->front, 1 ) . $archive_slug;729				} else {730					$archive_slug = $wp_rewrite->root . $archive_slug;731				}732 733				add_rewrite_rule( "{$archive_slug}/?$", "index.php?post_type=$this->name", 'top' );734				if ( $this->rewrite['feeds'] && $wp_rewrite->feeds ) {735					$feeds = '(' . trim( implode( '|', $wp_rewrite->feeds ) ) . ')';736					add_rewrite_rule( "{$archive_slug}/feed/$feeds/?$", "index.php?post_type=$this->name" . '&feed=$matches[1]', 'top' );737					add_rewrite_rule( "{$archive_slug}/$feeds/?$", "index.php?post_type=$this->name" . '&feed=$matches[1]', 'top' );738				}739				if ( $this->rewrite['pages'] ) {740					add_rewrite_rule( "{$archive_slug}/{$wp_rewrite->pagination_base}/([0-9]{1,})/?$", "index.php?post_type=$this->name" . '&paged=$matches[1]', 'top' );741				}742			}743 744			$permastruct_args         = $this->rewrite;745			$permastruct_args['feed'] = $permastruct_args['feeds'];746			add_permastruct( $this->name, "{$this->rewrite['slug']}/%$this->name%", $permastruct_args );747		}748	}

Changelog

Introduced in 4.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-post-type.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.