Function Forum_driver_none->member_group_query
Definitions
sources/forum/none.php
- Get an array of members who are in at least one of the given array of usergroups.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $groups | array | No | No | required parameter | N/A | N/A | The array of usergroups |
| $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 (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 array of members (null: no members)
- Type: ?array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get an array of members who are in at least one of the given array of usergroups.
*
* @param array $groups The array of usergroups
* @param ?integer $max Return up to this many entries for primary members and this many entries for secondary 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 array of members (null: no members)
*/
public function member_group_query(array $groups, ?int $max = null, int $start = 0) : ?array
* Get an array of members who are in at least one of the given array of usergroups.
*
* @param array $groups The array of usergroups
* @param ?integer $max Return up to this many entries for primary members and this many entries for secondary 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 array of members (null: no members)
*/
public function member_group_query(array $groups, ?int $max = null, int $start = 0) : ?array