wppaste
WordPress

WP_Rewrite::add_endpoint( string $name, int $places, string|bool $query_var = true )

Since
2.1.0, 3.9.0, 4.3.0
Source
wp-includes/class-wp-rewrite.php:1752
Adds an endpoint, like /trackback/.

Compatibility

WordPress
since 4.3.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$namestring
Name of the endpoint.
$placesint
Endpoint mask describing the places the endpoint should be added.
Accepts a mask of:
- EP_ALL
- EP_NONE
- EP_ALL_ARCHIVES
- EP_ATTACHMENT
- EP_AUTHORS
- EP_CATEGORIES
- EP_COMMENTS
- EP_DATE
- EP_DAY
- EP_MONTH
- EP_PAGES
- EP_PERMALINK
- EP_ROOT
- EP_SEARCH
- EP_TAGS
- EP_YEAR
$query_varstring|booloptional
Name of the corresponding query variable. Pass false to skip registering a query_var for this endpoint. Defaults to the value of $name.Default: true

Performance profile

How much work a call to WP_Rewrite::add_endpoint() 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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
15–20

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

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 one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
always15–17none
always18–20->add_query_var()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 20 instructions, 15–20 executed per call, 3 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Source code

View on Trac View on GitHub 

	public function add_endpoint( $name, $places, $query_var = true ) {		global $wp; 		// For backward compatibility, if null has explicitly been passed as `$query_var`, assume `true`.		if ( true === $query_var || null === $query_var ) {			$query_var = $name;		}		$this->endpoints[] = array( $places, $name, $query_var ); 		if ( $query_var ) {			$wp->add_query_var( $query_var );		}	}

Changelog

Introduced in 2.1.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.

4.3.0
Added support for skipping query var registration by passing false to $query_var.from the docblock
3.9.0
$query_var parameter added.from the docblock
2.1.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 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.