WP_REST_Response

17class WP_REST_Response extends WP_HTTP_Response {18 19	/**20	 * Links related to the response.21	 *22	 * @since 4.4.023	 * @var array24	 */25	protected $links = array();26 27	/**28	 * The route that was to create the response.29	 *30	 * @since 4.4.031	 * @var string32	 */33	protected $matched_route = '';34 35	/**36	 * The handler that was used to create the response.37	 *38	 * @since 4.4.039	 * @var null|array40	 */41	protected $matched_handler = null;42 43	/**44	 * Adds a link to the response.45	 *46	 * @internal The $rel parameter is first, as this looks nicer when sending multiple.47	 *48	 * @since 4.4.049	 *50	 * @link https://tools.ietf.org/html/rfc598851	 * @link https://www.iana.org/assignments/link-relations/link-relations.xml52	 *53	 * @param string $rel        Link relation. Either an IANA registered type,54	 *                           or an absolute URL.55	 * @param string $href       Target URI for the link.56	 * @param array  $attributes Optional. Link parameters to send along with the URL. Default empty array.57	 */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	}73 74	/**75	 * Removes a link from the response.76	 *77	 * @since 4.4.078	 *79	 * @param string $rel  Link relation. Either an IANA registered type, or an absolute URL.80	 * @param string $href Optional. Only remove links for the relation matching the given href.81	 *                     Default null.82	 */83	public function remove_link( $rel, $href = null ) {84		if ( ! isset( $this->links[ $rel ] ) ) {85			return;86		}87 88		if ( $href ) {89			$this->links[ $rel ] = wp_list_filter( $this->links[ $rel ], array( 'href' => $href ), 'NOT' );90		} else {91			$this->links[ $rel ] = array();92		}93 94		if ( ! $this->links[ $rel ] ) {95			unset( $this->links[ $rel ] );96		}