Function Hook_Notification->get_default_auto_setting
Definitions
sources/notifications.php
- Find the setting that members have for a notification code if they have done some action triggering automatic setting (e.g. posted within a topic).
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: int
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $notification_code | ID_TEXT | No | No | required parameter | N/A | N/A | Notification code |
| $category | ?SHORT_TEXT | No | No | Null | N/A | N/A | The category within the notification code (null: none) |
Returns
- Automatic setting
- Type: integer
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find the setting that members have for a notification code if they have done some action triggering automatic setting (e.g. posted within a topic).
*
* @param ID_TEXT $notification_code Notification code
* @param ?SHORT_TEXT $category The category within the notification code (null: none)
* @return integer Automatic setting
*/
public function get_default_auto_setting(string $notification_code, ?string $category = null) : int
* Find the setting that members have for a notification code if they have done some action triggering automatic setting (e.g. posted within a topic).
*
* @param ID_TEXT $notification_code Notification code
* @param ?SHORT_TEXT $category The category within the notification code (null: none)
* @return integer Automatic setting
*/
public function get_default_auto_setting(string $notification_code, ?string $category = null) : int
