Function Forum_driver_cns->_get_usergroup_list
Definitions
sources/forum/cns.php
- Get the forum usergroup list. This is useful to enumerate usergroups, or to find usergroup names.
- Visibility: protected
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $hide_hidden | boolean | False | N/A | N/A | Whether to obscure the name of hidden usergroups |
| $only_permissive | boolean | False | N/A | N/A | Whether to only grab permissive usergroups |
| $force_show_all | boolean | False | N/A | N/A | Do not limit things even if there are huge numbers of usergroups |
| $force_find | array | [] | N/A | N/A | Usergroups that must be included in the results |
| $for_member | ?MEMBER | Null | N/A | N/A | Always return usergroups of this member if otherwise there are too many to return in full (null: current member) |
| $skip_hidden | boolean | False | N/A | N/A | Whether to completely skip hidden usergroups |
Return
- The usergroup list, a map of usergroup ID to usergroup name
- Type: array
- Set: N/A
- Range: N/A