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

Adds an endpoint, like /trackback/.


Description

Top ↑

See also


Top ↑

Parameters

$name string Required
Name of the endpoint.
$places int Required
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_var string|bool Optional
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


Top ↑

Source

File: wp-includes/class-wp-rewrite.php. View all references

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 );
	}
}


Top ↑

Changelog

Changelog
Version Description
4.3.0 Added support for skipping query var registration by passing false to $query_var.
3.9.0 $query_var parameter added.
2.1.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.