BP_REST_Group_Membership_Endpoint::get_items( WP_REST_Request $request )
Retrieve group members.
Parameters Parameters
- $request
-
(WP_REST_Request) (Required) Full details about the request.
Return Return
(WP_REST_Response)
Source 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->get_param( '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. * * @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_group_members_get_items_query_args', $args, $request ); // Get our members. $members = groups_get_group_members( $args ); $retval = array(); 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. * * @since 5.0.0 * * @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. */ do_action( 'bp_rest_group_members_get_items', $members, $group, $response, $request ); return $response; }
Expand full source code Collapse full source code View on Trac
Changelog Changelog
Version | Description |
---|---|
5.0.0 | Introduced. |