On this page
WP_Rewrite::add_endpoint( string $name, int $places, string|bool $query_var = true )
Adds an endpoint, like /trackback/.
Description
See also
- add_rewrite_endpoint() : for full documentation.
Parameters
$namestring Required-
Name of the endpoint.
$placesint Required-
Endpoint mask describing the places the endpoint should be added.
Accepts a mask of:
EP_ALLEP_NONEEP_ALL_ARCHIVESEP_ATTACHMENTEP_AUTHORSEP_CATEGORIESEP_COMMENTSEP_DATEEP_DAYEP_MONTHEP_PAGESEP_PERMALINKEP_ROOTEP_SEARCHEP_TAGSEP_YEAR
$query_varstring|bool Optional-
Name of the corresponding query variable. Pass
falseto skip registering a query_var for this endpoint. Defaults to the value of$name.Default:
true
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 );
}
}
Related
Uses
| Uses | Description |
|---|---|
| WP::add_query_var() wp-includes/class-wp.php | Adds a query variable to the list of public query variables. |
Used By
| Used By | Description |
|---|---|
| add_rewrite_endpoint() wp-includes/rewrite.php | Adds an endpoint, like /trackback/. |
Changelog
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rewrite/add_endpoint