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
- $name
-
(Required) Name of the endpoint.
- $places
-
(Required) Endpoint mask describing the places the endpoint should be added.<br> Accepts a mask of:<br>
EP_ALL
<br>EP_NONE
<br>EP_ALL_ARCHIVES
<br>EP_ATTACHMENT
<br>EP_AUTHORS
<br>EP_CATEGORIES
<br>EP_COMMENTS
<br>EP_DATE
<br>EP_DAY
<br>EP_MONTH
<br>EP_PAGES
<br>EP_PERMALINK
<br>EP_ROOT
<br>EP_SEARCH
<br>EP_TAGS
<br>EP_YEAR
- $query_var
-
(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 value: true
Source
File: wp-includes/class-wp-rewrite.php
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 === func_get_arg( 2 ) ) {
$query_var = $name;
}
$this->endpoints[] = array( $places, $name, $query_var );
if ( $query_var ) {
$wp->add_query_var( $query_var );
}
}
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. |