BP_REST_Group_Membership_Endpoint::get_items( WP_REST_Request $request )
Retrieve group members.
Description
Parameters
- $request
-
(Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-groups/classes/class-bp-rest-group-membership-endpoint.php
public function get_items( $request ) { $group = $this->groups_endpoint->get_group_object( $request['group_id'] ); $args = array( 'group_id' => $group->id, 'group_role' => $request['roles'], 'type' => $request['status'], 'per_page' => $request['per_page'], 'page' => $request['page'], 'search_terms' => $request['search'], 'exclude' => $request['exclude'], 'exclude_admins_mods' => (bool) $request['exclude_admins'], 'exclude_banned' => (bool) $request['exclude_banned'], ); if ( empty( $args['exclude'] ) ) { $args['exclude'] = false; } if ( is_null( $args['search_terms'] ) ) { $args['search_terms'] = false; } /** * 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_group_members_get_items_query_args', $args, $request ); $retval = array(); if ( ! empty( $request['scope'] ) ) { $group_potential_invites = $this->bp_rest_get_group_potential_invites( $group, $request ); if ( is_wp_error( $group_potential_invites ) ) { return $group_potential_invites; } else { $args['user_ids'] = $group_potential_invites; unset( $args['search_terms'] ); unset( $args['include'] ); unset( $args['exclude'] ); } $args['type'] = 'alphabetical'; // 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->members_endpoint->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'] ); } else { // Get our members. $members = groups_get_group_members( $args ); foreach ( $members['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, $members['count'], $args['per_page'] ); } /** * Fires after a list of group members are fetched via the REST API. * * @param array $members Fetched group members. * @param BP_Groups_Group $group The group object. * @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_group_members_get_items', $members, $group, $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.