Function __global->relay_error_notification

Definitions

sources/failure.php

  • Relay an error message, if appropriate, to e-mail listeners (sometimes core developers, and site staff).Caution! You should always log the error being relayed to the error log first before calling this.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$text string No No required parameter N/A N/A A error message (in HTML)
$developers boolean No No True N/A N/A Also send to core developers
$notification_category ID_TEXT No No error_occurred N/A N/A The error_occurred notification category

Preview

Code (PHP)

/**
 * Relay an error message, if appropriate, to e-mail listeners (sometimes core developers, and site staff).Caution! You should always log the error being relayed to the error log first before calling this.
 *
 * @param  string $text A error message (in HTML)
 * @param  boolean $developers Also send to core developers
 * @param  ID_TEXT $notification_category The error_occurred notification category
 */
function relay_error_notification(string $text, bool $developers = true, string $notification_category = 'error_occurred')