Function Forum_driver_vb3->is_banned
Definitions
sources/forum/vb3.php
- Find out if the given member ID is banned.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: bool
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $member_id | MEMBER | No | No | required parameter | N/A | N/A | The member ID |
| &$reasoned_ban | ?ID_TEXT | Yes | No | Null | N/A | N/A | Ban reasoning returned by reference (null: none) |
Returns
- Whether the member is banned
- Type: boolean
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find out if the given member ID is banned.
*
* @param MEMBER $member_id The member ID
* @param ?ID_TEXT $reasoned_ban Ban reasoning returned by reference (null: none)
* @return boolean Whether the member is banned
*/
public function is_banned(int $member_id, ?string &$reasoned_ban = null) : bool
* Find out if the given member ID is banned.
*
* @param MEMBER $member_id The member ID
* @param ?ID_TEXT $reasoned_ban Ban reasoning returned by reference (null: none)
* @return boolean Whether the member is banned
*/
public function is_banned(int $member_id, ?string &$reasoned_ban = null) : bool