BP_REST_Members_Endpoint::get_items( WP_REST_Request $request )
Retrieve users.
Description Description
Parameters Parameters
- $request
-
(Required) Full details about the request.
Return Return
(WP_REST_Response)
Source Source
File: bp-members/classes/class-bp-rest-members-endpoint.php
public function get_items( $request ) {
$args = array(
'type' => $request['type'],
'user_id' => $request['user_id'],
'user_ids' => $request['user_ids'],
'xprofile_query' => $request['xprofile'],
'include' => $request['include'],
'exclude' => $request['exclude'],
'member_type' => $request['member_type'],
'search_terms' => $request['search'],
'per_page' => $request['per_page'],
'page' => $request['page'],
);
if ( empty( $request['user_ids'] ) ) {
$args['user_ids'] = false;
}
if ( empty( $request['exclude'] ) ) {
$args['exclude'] = false;
}
if ( empty( $request['include'] ) ) {
$args['include'] = false;
}
if ( empty( $request['xprofile'] ) ) {
$args['xprofile_query'] = false;
}
if ( empty( $request['member_type'] ) ) {
$args['member_type'] = '';
}
/**
* Filter the query arguments for the request.
*
* @since 5.0.0
*
* @param array $args Key value array of query var to query value.
* @param WP_REST_Request $request The request sent to the API.
*/
$args = apply_filters( 'bp_rest_members_get_items_query_args', $args, $request );
// Actually, query it.
$member_query = new BP_User_Query( $args );
$members = array_values( $member_query->results );
$retval = array();
foreach ( $members as $member ) {
$retval[] = $this->prepare_response_for_collection(
$this->prepare_item_for_response( $member, $request )
);
}
$response = rest_ensure_response( $retval );
$response = bp_rest_response_add_total_headers( $response, $member_query->total_users, $args['per_page'] );
/**
* Fires after a list of members is fetched via the REST API.
*
* @since 5.0.0
*
* @param array $members Fetched members.
* @param WP_REST_Response $response The response data.
* @param WP_REST_Request $request The request sent to the API.
*/
do_action( 'bp_rest_members_get_items', $members, $response, $request );
return $response;
}
Changelog Changelog
| Version | Description |
|---|---|
| 5.0.0 | Introduced. |