Function __global->_notification_setting_available
Definitions
sources/notifications.php
- Find whether a particular kind of notification is available.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: bool
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $setting | integer | No | No | required parameter | N/A | N/A | The notification setting |
| $member_id | ?MEMBER | No | No | Null | N/A | N/A | Member to check for (null: just check globally) |
| $allowed_setting | ?integer | No | No | Null | N/A | N/A | Limit to a particular $allowed_setting (restriction from a particular notification code) (null: none) |
Returns
- Whether it is available
- Type: boolean
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find whether a particular kind of notification is available.
*
* @param integer $setting The notification setting
* @param ?MEMBER $member_id Member to check for (null: just check globally)
* @param ?integer $allowed_setting Limit to a particular $allowed_setting (restriction from a particular notification code) (null: none)
* @return boolean Whether it is available
*/
function _notification_setting_available(int $setting, ?int $member_id = null, ?int $allowed_setting = null) : bool
* Find whether a particular kind of notification is available.
*
* @param integer $setting The notification setting
* @param ?MEMBER $member_id Member to check for (null: just check globally)
* @param ?integer $allowed_setting Limit to a particular $allowed_setting (restriction from a particular notification code) (null: none)
* @return boolean Whether it is available
*/
function _notification_setting_available(int $setting, ?int $member_id = null, ?int $allowed_setting = null) : bool
