WP_REST_Server::get_response_links() – Method

WP_REST_Server::get_response_links( WP_REST_Response $response ): array

Retrieves links from a response.

Description

Extracts the links from a response into a structured hash, suitable for direct output.

Parameters

$responseWP_REST_Responserequired: Response to extract links from.

Return

array Map of link relation to list of link hashes.

Source

public static function get_response_links( $response ) {
	$links = $response->get_links();

	if ( empty( $links ) ) {
		return array();
	}

	// Convert links to part of the data.
	$data = array();
	foreach ( $links as $rel => $items ) {
		$data[ $rel ] = array();

		foreach ( $items as $item ) {
			$attributes         = $item['attributes'];
			$attributes['href'] = $item['href'];
			$data[ $rel ][]     = $attributes;
		}
	}

	return $data;
}

View all references View on Trac View on GitHub

Used by	Description
WP_REST_Server::get_compact_response_links()`wp-includes/rest-api/class-wp-rest-server.php`	Retrieves the CURIEs (compact URIs) used for relations.

Changelog

Version	Description
4.4.0	Introduced.

User Contributed Notes

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