WP_Rewrite::init()

Description

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_Rewrite::init() 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

42–46

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What it touches

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

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 · 1 distinct outcome

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

Uses · 3

• get_option()Retrieves an option value based on an option name.
• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.
• WP_Rewrite::using_index_permalinks()Determines whether permalinks are being used and rewrite module is not enabled.

Used by · 4

• WP_Rewrite::__construct()Constructor - Calls init(), which runs setup.
• WP_Rewrite::set_category_base()Sets the category base for the category permalink.
• WP_Rewrite::set_permalink_structure()Sets the main permalink structure for the site.
• WP_Rewrite::set_tag_base()Sets the tag base for the tag permalink.

Source code

View on Trac ↗View on GitHub ↗

1919	public function init() {1920		$this->extra_rules         = array();1921		$this->non_wp_rules        = array();1922		$this->endpoints           = array();1923		$this->permalink_structure = get_option( 'permalink_structure' );1924		$this->front               = substr( $this->permalink_structure, 0, strpos( $this->permalink_structure, '%' ) );1925		$this->root                = '';1926 1927		if ( $this->using_index_permalinks() ) {1928			$this->root = $this->index . '/';1929		}1930 1931		unset( $this->author_structure );1932		unset( $this->date_structure );1933		unset( $this->page_structure );1934		unset( $this->search_structure );1935		unset( $this->feed_structure );1936		unset( $this->comment_feed_structure );1937 1938		$this->use_trailing_slashes = str_ends_with( $this->permalink_structure, '/' );1939 1940		// Enable generic rules for pages if permalink structure doesn't begin with a wildcard.1941		if ( preg_match( '/^[^%]*%(?:postname|category|tag|author)%/', $this->permalink_structure ) ) {1942			$this->use_verbose_page_rules = true;1943		} else {1944			$this->use_verbose_page_rules = false;1945		}1946	}

Changelog

Introduced in 1.5.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 6.7.7 tag, from src/wp-includes/class-wp-rewrite.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.