Function __global->reset_notifications

Definitions

sources/notifications.php

  • Reset notification settings to the default for a member on a notification code+category.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$notification_code ID_TEXT No No required parameter N/A N/A The notification code to use
$notification_category SHORT_TEXT No No required parameter N/A N/A The category within the notification code
$member_id ?MEMBER No No Null N/A N/A The member being de-signed up (null: current member)

Preview

Code (PHP)

/**
 * Reset notification settings to the default for a member on a notification code+category.
 *
 * @param  ID_TEXT $notification_code The notification code to use
 * @param  SHORT_TEXT $notification_category The category within the notification code
 * @param  ?MEMBER $member_id The member being de-signed up (null: current member)
 */
function reset_notifications(string $notification_code, string $notification_category, ?int $member_id = null)