BP_REST_Attachments_Group_Cover_Endpoint::prepare_item_for_response( string $cover_url, WP_REST_Request $request )
Prepares group cover to return as an object.
Parameters Parameters
- $cover_url
-
(string) (Required) Group cover url.
- $request
-
(WP_REST_Request) (Required) Full details about the request.
Return Return
(WP_REST_Response)
Source Source
File: bp-groups/classes/class-bp-rest-attachments-group-cover-endpoint.php
public function prepare_item_for_response( $cover_url, $request ) { $data = array( 'image' => $cover_url, ); $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; $data = $this->add_additional_fields_to_object( $data, $request ); $data = $this->filter_response_by_context( $data, $context ); $response = rest_ensure_response( $data ); /** * Filter a group cover value returned from the API. * * @since 6.0.0 * * @param WP_REST_Response $response Response. * @param WP_REST_Request $request Request used to generate the response. * @param string $cover_url Group cover url. */ return apply_filters( 'bp_rest_attachments_group_cover_prepare_value', $response, $request, $cover_url ); }
Expand full source code Collapse full source code View on Trac
Changelog Changelog
Version | Description |
---|---|
6.0.0 | Introduced. |