BP_REST_Document_Folder_Endpoint::get_items( WP_REST_Request $request )
Retrieve document folders.
Description
Parameters
- $request
-
(Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-document/classes/class-bp-rest-document-folder-endpoint.php
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'], ); if ( ! empty( $request['search'] ) ) { $args['search_terms'] = $request['search']; } if ( ! empty( $request['max'] ) ) { $args['max'] = $request['max']; } if ( ! empty( $request['user_id'] ) ) { $args['user_id'] = $request['user_id']; } if ( isset( $request['parent'] ) && null !== $request['parent'] ) { $args['parent'] = $request['parent']; } if ( ! empty( $request['group_id'] ) ) { $args['group_id'] = $request['group_id']; } if ( ! empty( $request['privacy'] ) ) { $args['privacy'] = $request['privacy']; } if ( ! empty( $request['exclude'] ) ) { $args['exclude'] = $request['exclude']; } if ( ! empty( $request['include'] ) ) { $args['in'] = $request['include']; } /** * 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_folder_get_items_query_args', $args, $request ); $folders = $this->assemble_response_data( $args ); $retval = array(); foreach ( $folders['folders'] as $folder ) { $retval[] = $this->prepare_response_for_collection( $this->document_endpoint->prepare_item_for_response( $folder, $request ) ); } $response = rest_ensure_response( $retval ); $response = bp_rest_response_add_total_headers( $response, $folders['total'], $args['per_page'] ); /** * Fires after a list of document's folder 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 $folders Fetched Folders. */ do_action( 'bp_rest_document_folder_get_items', $folders, $response, $request ); return $response; }
Changelog
Version | Description |
---|---|
0.1.0 | Introduced. |
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.