BP_Groups_Member::get_invites( int $user_id, int|bool $limit = false, int|bool $page = false, string|array|bool $exclude = false )
Get group objects for groups that a user is currently invited to.
Description Description
Parameters Parameters
- $user_id
-
(Required) ID of the invitee.
- $limit
-
(Optional) Max number of results to return. Default: false (no limit).
Default value: false
- $page
-
(Optional) Page offset of results to return. Default: false (no limit).
Default value: false
- $exclude
-
(Optional) Array or comma-separated list of group IDs to exclude from results.
Default value: false
Return Return
(array)
- 'groups'
(array) Array of groups returned by paginated query. - 'total'
(int) Count of groups matching query.
Source Source
File: bp-groups/classes/class-bp-groups-member.php
public static function get_invites( $user_id, $limit = false, $page = false, $exclude = false ) {
return groups_get_invites_for_user( $user_id, $limit, $page, $exclude );
}
Changelog Changelog
| Version | Description |
|---|---|
| 1.6.0 | Introduced. |