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

Adds a link to the response.

Parameters Parameters


(string) (Required) Link relation. Either an IANA registered type, or an absolute URL.


(string) (Required) Target URI for the link.


(array) (Optional) Link parameters to send along with the URL.

Default value: array()

Top ↑

Source Source

File: wp-includes/rest-api/class-wp-rest-response.php

	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,

Top ↑

Changelog Changelog

Version Description
4.4.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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