WP_REST_Response::add_links() WordPress Method
The add_links() method is used to add links to the WP_REST_Response object. This is useful for linking to related resources, such as the author of a post.
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
- $links
(array)(Required)Map of link relation to list of links.
Source
File: wp-includes/rest-api/class-wp-rest-response.php
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 );
}
}
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |