WC_REST_Reports_V1_Controller::prepare_item_for_response() public WC 1.0
Prepare a report object for serialization.
{} It's a method of the class: WC_REST_Reports_V1_Controller{}
Hooks from the method
Return
WP_REST_Response. $response Response data.
Usage
$WC_REST_Reports_V1_Controller = new WC_REST_Reports_V1_Controller(); $WC_REST_Reports_V1_Controller->prepare_item_for_response( $report, $request );
- $report(stdClass) (required)
- Report data.
- $request(WP_REST_Request) (required)
- Request object.
Code of WC_REST_Reports_V1_Controller::prepare_item_for_response() WC REST Reports V1 Controller::prepare item for response WC 5.0.0
public function prepare_item_for_response( $report, $request ) {
$data = array(
'slug' => $report->slug,
'description' => $report->description,
);
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
$data = $this->add_additional_fields_to_object( $data, $request );
$data = $this->filter_response_by_context( $data, $context );
// Wrap the data in a response object.
$response = rest_ensure_response( $data );
$response->add_links( array(
'self' => array(
'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ),
),
'collection' => array(
'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
),
) );
/**
* Filter a report returned from the API.
*
* Allows modification of the report data right before it is returned.
*
* @param WP_REST_Response $response The response object.
* @param object $report The original report object.
* @param WP_REST_Request $request Request used to generate the response.
*/
return apply_filters( 'woocommerce_rest_prepare_report', $response, $report, $request );
}