Function __global->notification_locked_down

Definitions

sources/notifications.php

  • Find whether a notification is locked-down (i.e. cannot be set).
  • 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 The notification code to check

Returns

  • Lock-down status (null: not locked down)
  • Type: ?BINARY
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find whether a notification is locked-down (i.e. cannot be set).
 *
 * @param  ID_TEXT $notification_code The notification code to check
 * @return ?BINARY Lock-down status (null: not locked down)
 */

function notification_locked_down(string $notification_code) : ?int