Contents

Code Reference Classes BP_REST_Document_Endpoint BP_REST_Document_Endpoint::prepare_item_for_response()

BP_REST_Document_Endpoint::prepare_item_for_response( BP_Document $document, WP_REST_Request $request )

Prepares document data for return as an object.

Description

Parameters

$document

(Required) Document data.

$request

(Required) Full details about the request.

Return

(WP_REST_Response)

Source

File: bp-document/classes/class-bp-rest-document-endpoint.php

1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
public function prepare_item_for_response( $document, $request ) {
    $data = $this->document_get_prepare_response( $document, $request );
 
    $data = $this->add_additional_fields_to_object( $data, $request );
 
    $response = rest_ensure_response( $data );
 
    /**
     * Filter an document value returned from the API.
     *
     * @since 0.1.0
     *
     * @param WP_REST_Request  $request  Request used to generate the response.
     * @param BP_Document      $document The Document object.
     *
     * @param WP_REST_Response $response The response data.
     */
    return apply_filters( 'bp_rest_document_prepare_value', $response, $request, $document );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.
Used By
Used By Description
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::update_item()

Update a document.
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::delete_item()

Delete a single document.
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::get_items()

Retrieve documents.
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::get_item()

Retrieve a single document.
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::create_item()

Create documents.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.