Function __global->cns_get_group_members_raw
Definitions
sources/cns_groups2.php
- Get a list of members in a group (or more full details if $non_validated is true).
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $group_id | GROUP | No | No | required parameter | N/A | N/A | The ID of the group |
| $include_primaries | boolean | No | No | True | N/A | N/A | Whether to include those in the as a primary member |
| $non_validated | boolean | No | No | False | N/A | N/A | Whether to include those applied to join the group, but not validated in (also causes it to return maps that contain this info) |
| $include_secondaries | boolean | No | No | True | N/A | N/A | Whether to include those in the as a secondary member |
| $include_not_validated_members | boolean | No | No | True | N/A | N/A | Whether to include those members who are not validated as site members at all yet (parameter currently ignored) |
| $max | ?integer | No | No | Null | N/A | N/A | Return up to this many entries for primary members and this many entries for secondary members and all LDAP members (null: no limit, only use no limit if querying very restricted usergroups!) |
| $start | integer | No | No | 0 | N/A | N/A | Return primary members after this offset and secondary members after this offset |
Returns
- The list
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get a list of members in a group (or more full details if $non_validated is true).
*
* @param GROUP $group_id The ID of the group
* @param boolean $include_primaries Whether to include those in the as a primary member
* @param boolean $non_validated Whether to include those applied to join the group, but not validated in (also causes it to return maps that contain this info)
* @param boolean $include_secondaries Whether to include those in the as a secondary member
* @param boolean $include_not_validated_members Whether to include those members who are not validated as site members at all yet (parameter currently ignored)
* @param ?integer $max Return up to this many entries for primary members and this many entries for secondary members and all LDAP members (null: no limit, only use no limit if querying very restricted usergroups!)
* @param integer $start Return primary members after this offset and secondary members after this offset
* @return array The list
*/
function cns_get_group_members_raw(int $group_id, bool $include_primaries = true, bool $non_validated = false, bool $include_secondaries = true, bool $include_not_validated_members = true, ?int $max = null, int $start = 0) : array
* Get a list of members in a group (or more full details if $non_validated is true).
*
* @param GROUP $group_id The ID of the group
* @param boolean $include_primaries Whether to include those in the as a primary member
* @param boolean $non_validated Whether to include those applied to join the group, but not validated in (also causes it to return maps that contain this info)
* @param boolean $include_secondaries Whether to include those in the as a secondary member
* @param boolean $include_not_validated_members Whether to include those members who are not validated as site members at all yet (parameter currently ignored)
* @param ?integer $max Return up to this many entries for primary members and this many entries for secondary members and all LDAP members (null: no limit, only use no limit if querying very restricted usergroups!)
* @param integer $start Return primary members after this offset and secondary members after this offset
* @return array The list
*/
function cns_get_group_members_raw(int $group_id, bool $include_primaries = true, bool $non_validated = false, bool $include_secondaries = true, bool $include_not_validated_members = true, ?int $max = null, int $start = 0) : array
