BP_REST_Document_Endpoint::get_item( WP_REST_Request $request )

Retrieve a single document.

Description

Parameters

$request: (Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

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

public function get_item( $request ) {
 
    $id = $request['id'];
 
    $documents = $this->assemble_response_data( array( 'document_ids' => array( $id ) ) );
 
    if ( empty( $documents['documents'] ) ) {
        return new WP_Error(
            'bp_rest_document_invalid_id',
            __( 'Invalid document ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    $retval = '';
    foreach ( $documents['documents'] as $document ) {
        $retval = $this->prepare_response_for_collection(
            $this->prepare_item_for_response( $document, $request )
        );
    }
 
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires after a document is fetched via the REST API.
     *
     * @param WP_REST_Response $response The response data.
     * @param WP_REST_Request  $request  The request sent to the API.
     *
     * @since 0.1.0
     */
    do_action( 'bp_rest_document_get_item', $response, $request );
 
    return $response;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
0.1.0	Introduced.

Uses

Uses
Uses	Description
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::assemble_response_data()	Get documents.
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::prepare_item_for_response()	Prepares document data for return as an object.
bp-document/classes/class-bp-rest-document-endpoint.php: bp_rest_document_get_item	Fires after a document is fetched via the REST API.

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.

Contents