WP_REST_Response::add_link( string $rel, string $href, array $attributes = array() )
- Since
- 4.4.0
- Source
wp-includes/rest-api/class-wp-rest-response.php:58
Adds a link to the response.
Parameters
$relstring- Link relation. Either an IANA registered type, or an absolute URL.
$hrefstring- Target URI for the link.
$attributesarrayoptional- Link parameters to send along with the URL. Default empty array.Default:
array()
Used by · 1
- WP_REST_Response::add_links()Adds multiple links to the response.
Source
public function add_link( $rel, $href, $attributes = array() ) { if ( empty( $this->links[ $rel ] ) ) { $this->links[ $rel ] = array(); } if ( isset( $attributes['href'] ) ) { // Remove the href attribute, as it's used for the main URL. unset( $attributes['href'] ); } $this->links[ $rel ][] = array( 'href' => $href, 'attributes' => $attributes, ); }History
Introduced in 4.4.0. Unchanged from 6.7.7 through 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/rest-api/class-wp-rest-response.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.