WP_REST_Controller::prepare_response_for_collection() WordPress Method
The WP_REST_Controller::prepare_response_for_collection() method is used to prepare a response for a collection of items. This is typically used to add pagination headers to the response.
WP_REST_Controller::prepare_response_for_collection( WP_REST_Response $response ) #
Prepares a response for insertion into a collection.
Parameters
- $response
(WP_REST_Response)(Required)Response object.
Return
(array|mixed) Response data, ready for insertion into collection data.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-controller.php
public function prepare_response_for_collection( $response ) {
if ( ! ( $response instanceof WP_REST_Response ) ) {
return $response;
}
$data = (array) $response->get_data();
$server = rest_get_server();
$links = $server::get_compact_response_links( $response );
if ( ! empty( $links ) ) {
$data['_links'] = $links;
}
return $data;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |