BP_Groups_Group::get_membership_requests( int $group_id, int|null $limit = null, int|null $page = null )
Get outstanding membership requests for a group.
Description Description
Parameters Parameters
- $group_id
-
(Required) ID of the group.
- $limit
-
(Optional) Max number of results to return. Default: null (no limit).
Default value: null
- $page
-
(Optional) Page offset of results returned. Default: null (no limit).
Default value: null
Return Return
(array)
- 'requests'
(array) The requested page of located requests. - 'total'
(int) Total number of requests outstanding for the group.
Source Source
File: bp-groups/classes/class-bp-groups-group.php
public static function get_membership_requests( $group_id, $limit = null, $page = null ) {
$args = array(
'item_id' => $group_id
);
if ( $limit ) {
$args['per_page'] = $limit;
}
if ( $page ) {
$args['page'] = $page;
}
$requests = groups_get_requests( $args );
$total = count( groups_get_membership_requested_user_ids( $group_id ) );
return array( 'requests' => $requests, 'total' => $total );
}
Changelog Changelog
| Version | Description |
|---|---|
| 1.6.0 | Introduced. |