Function __global->_get_notification_ob_for_code

Definitions

sources/notifications.php

  • Find the notification object for a particular notification code.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

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_hook ?string No No Null N/A N/A Notification hook $notification_code exists in (null: auto-detect)

Returns

  • Notification object (null: could not find)
  • Type: ?object
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find the notification object for a particular notification code.
 *
 * @param  ID_TEXT $notification_code The notification code to use
 * @param  ?string $notification_hook Notification hook $notification_code exists in (null: auto-detect)
 * @return ?object Notification object (null: could not find)
 */
function _get_notification_ob_for_code(string $notification_code, ?string $notification_hook = null) : ?object