Contents

Code Reference Classes BP_REST_Document_Endpoint BP_REST_Document_Endpoint::get_items()

BP_REST_Document_Endpoint::get_items( WP_REST_Request $request )

Retrieve documents.

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

235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
public function get_items( $request ) {
    $args = array(
        'page'        => $request['page'],
        'per_page'    => $request['per_page'],
        'sort'        => strtoupper( $request['order'] ),
        'order_by'    => $request['orderby'],
        'count_total' => $request['count_total'],
        'scope'       => '',
    );
 
    if ( ! empty( $request['search'] ) ) {
        $args['search_terms'] = $request['search'];
    }
 
    if ( ! empty( $request['max'] ) ) {
        $args['max'] = $request['max'];
    }
 
    if ( ! empty( $request['scope'] ) ) {
        $args['scope'] = $request['scope'];
    }
 
    if ( ! empty( $request['user_id'] ) ) {
        $args['user_id'] = $request['user_id'];
    }
 
    if ( ! empty( $request['folder_id'] ) ) {
        $args['folder_id'] = $request['folder_id'];
    }
 
    if ( ! empty( $request['group_id'] ) ) {
        $args['group_id'] = $request['group_id'];
    }
 
    if ( ! empty( $request['activity_id'] ) ) {
        $args['activity_id'] = $request['activity_id'];
    }
 
    if ( ! empty( $request['privacy'] ) ) {
        $args['privacy'] = $request['privacy'];
    }
 
    if ( ! empty( $request['exclude'] ) ) {
        $args['exclude'] = $request['exclude'];
    }
 
    if ( ! empty( $request['include'] ) ) {
        $args['include'] = $request['include'];
    }
 
    $args['scope'] = $this->bp_rest_document_default_scope( $args['scope'], $args );
 
    /**
     * Filter the query arguments for the request.
     *
     * @param array           $args    Key value array of query var to query value.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    $args = apply_filters( 'bp_rest_document_get_items_query_args', $args, $request );
 
    $documents = $this->assemble_response_data( $args );
 
    $retval = array();
    foreach ( $documents['documents'] as $document ) {
        $retval[] = $this->prepare_response_for_collection(
            $this->prepare_item_for_response( $document, $request )
        );
    }
 
    $response = rest_ensure_response( $retval );
    $response = bp_rest_response_add_total_headers( $response, $documents['total'], $args['per_page'] );
 
    /**
     * Fires after a list of documents is fetched via the REST API.
     *
     * @since 0.1.0
     *
     * @param WP_REST_Response $response  The response data.
     * @param WP_REST_Request  $request   The request sent to the API.
     *
     * @param array            $documents Fetched documents.
     */
    do_action( 'bp_rest_document_get_items', $documents, $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::bp_rest_document_default_scope()

Get default scope for the document.
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_items_query_args

Filter the query arguments for the request.
bp-document/classes/class-bp-rest-document-endpoint.php: bp_rest_document_get_items

Fires after a list of documents is fetched via the REST API.
bp-core/bp-core-rest-api.php: bp_rest_response_add_total_headers()

Set headers to let the Client Script be aware of the pagination.
Show 1 more use Hide more uses

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.