WP_REST_Response::add_links() – Method

WP_REST_Response::add_links( array $links )

Adds multiple links to the response.

Description

Link data should be an associative array with link relation as the key.
The value can either be an associative array of link attributes (including href with the URL for the response), or a list of these associative arrays.

Parameters

$linksarrayrequired: Map of link relation to list of links.

Source

public function add_links( $links ) {
	foreach ( $links as $rel => $set ) {
		// If it's a single link, wrap with an array for consistent handling.
		if ( isset( $set['href'] ) ) {
			$set = array( $set );
		}

		foreach ( $set as $attributes ) {
			$this->add_link( $rel, $attributes['href'], $attributes );
		}
	}
}

View all references View on Trac View on GitHub

Uses	Description
WP_REST_Response::add_link()`wp-includes/rest-api/class-wp-rest-response.php`	Adds a link to the response.

Changelog

Version	Description
4.4.0	Introduced.

User Contributed Notes

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