BP_REST_Group_Invites_Endpoint::get_items( WP_REST_Request $request )
Retrieve group invitations.
Description
Parameters
- $request
-
(Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-groups/classes/class-bp-rest-group-invites-endpoint.php
public function get_items( $request ) {
$args = array(
'item_id' => $request['group_id'],
'user_id' => $request['user_id'],
'invite_sent' => $request['invite_sent'],
'per_page' => $request['per_page'],
'page' => $request['page'],
);
/**
* Inviter_id is a special case, because 0 can be meaningful for requests,
* but if it is zero for invitations, we can safely ignore it and should.
* So, only apply non-zero inviter_ids.
*/
if ( $request['inviter_id'] ) {
$args['inviter_id'] = $request['inviter_id'];
}
// If the query is not restricted by group, user or inviter, limit it to the current user, if not an admin.
if ( ! $args['item_id'] && ! $args['user_id'] && ! $args['inviter_id'] && ! bp_current_user_can( 'bp_moderate' ) ) {
$args['user_id'] = bp_loggedin_user_id();
}
/**
* 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_invites_get_items_query_args', $args, $request );
// Get invites.
$invites_data = groups_get_invites( $args );
$retval = array();
foreach ( $invites_data as $invitation ) {
if ( $invitation instanceof BP_Invitation ) {
$retval[] = $this->prepare_response_for_collection(
$this->prepare_item_for_response( $invitation, $request )
);
}
}
$response = rest_ensure_response( $retval );
$response = bp_rest_response_add_total_headers( $response, count( $invites_data ), $args['per_page'] );
/**
* Fires after a list of group invites are fetched via the REST API.
*
* @param array $invites_data Invited users from the group.
* @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_invites_get_items', $invites_data, $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.