WP_REST_Response::add_link() WordPress Method

The WP_REST_Response::add_link() function adds a link to the response. The first parameter is the link relation type (e.g. 'canonical', 'alternate', etc.), the second parameter is the link URL, and the third parameter is an array of link attributes. The function returns the WP_REST_Response object, so it can be chained with other response methods. This function is useful for adding links to the response header, which can be used by the client to request additional information or perform actions. For example, a 'canonical' link can be used to indicate the preferred URL for a resource, or an 'edit' link can be used to provide a URL for editing the resource.

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

	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,
		);
	}