WP_REST_Response::add_link( string $rel, string $href, array $attributes = array() )

Description

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

View on Trac ↗View on GitHub ↗

58	public function add_link( $rel, $href, $attributes = array() ) {59		if ( empty( $this->links[ $rel ] ) ) {60			$this->links[ $rel ] = array();61		}62 63		if ( isset( $attributes['href'] ) ) {64			// Remove the href attribute, as it's used for the main URL.65			unset( $attributes['href'] );66		}67 68		$this->links[ $rel ][] = array(69			'href'       => $href,70			'attributes' => $attributes,71		);72	}

History

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

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 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.