WP_REST_Response

Hooks fired · 1

Every hook that fires from inside WP_REST_Response, in the order it appears in the class, grouped by the method that fires it.

Properties · 3

$linksarrayprotected

Links related to the response.

$matched_routestringprotected

The route that was to create the response.

$matched_handlernull|arrayprotected

The handler that was used to create the response.

Methods · 12

• add_link()Adds a link to the response.
• remove_link()Removes a link from the response.
• add_links()Adds multiple links to the response.
• get_links()Retrieves links for the response.
• link_header()Sets a single link header.
• get_matched_route()Retrieves the route that was used.
• set_matched_route()Sets the route (regex for path) that caused the response.
• get_matched_handler()Retrieves the handler that was used to generate the response.
• set_matched_handler()Sets the handler that was responsible for generating the response.
• is_error()Checks if the response is an error, i.e. >= 400 response code.
• as_error()Retrieves a WP_Error object from the response.
• get_curies()Retrieves the CURIEs (compact URIs) used for relations.

Source

View on Trac ↗View on GitHub ↗

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|null $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		}

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 6.9.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.