Notices / $notices

Notices are most commonly added from within a Wire-derived class via the inherited message(), warning(), and error() methods. These are available on every module, Fieldtype, Inputfield, Process, and other Wire-derived class.

// In a module or any Wire subclass:

$this->message("Item was saved successfully");
$this->warning("Setting X is deprecated, use Y instead");
$this->error("Could not connect to the API");

Each method accepts an optional $flags argument — see the Notice flags section below.

// Also log the notice to messages.txt / errors.txt
$this->message("Item saved", Notice::log);
$this->error("Something failed", Notice::log);

// Only log, don't display
$this->message("Background task ran", Notice::logOnly);

// Only show in debug mode
$this->warning("Slow query detected", Notice::debug);

// Allow HTML markup in the notice text
$this->message("See the <a href='/docs/'>docs</a>", Notice::allowMarkup);

// Combine flags with bitmask OR or a space-separated string 3.0.149+
$this->message("Done", Notice::log | Notice::noGroup);
$this->message("Done", "log noGroup");

// Boolean true is a shortcut for Notice::log
$this->message("Item saved", true);

Notices can also be added directly to the $notices API variable from a template using the same methods, since $notices itself extends Wire:

$notices->message("Hello from a template");
$notices->error("Something went wrong");

Or by constructing a Notice object directly:

$notices->add(new NoticeMessage("Hello world"));
$notices->add(new NoticeError("Something failed", Notice::log | Notice::noGroup));

Passing arrays and objects

Notice methods accept arrays and objects in place of a string, which is useful for debugging. The value is formatted via Debug::toStr() and Notice::allowMarkup is set automatically.

// Display a formatted dump of any array or object
$this->message($someArray);
$this->message($somePage);

Pass a single-key associative array to add a label before the formatted value. The key becomes a bold "Label: value" prefix in the notice:

$this->message(['Returned pages' => $pages->find('template=blog')]);
$this->message(['Order data' => $orderArray]);

In debug mode ($config->debug = true), the label is used as the notice's class attribution (shown as the source) rather than a visible prefix.

$notices extends WireArray, so it can be iterated directly. Each item is a Notice object — specifically a NoticeMessage, NoticeWarning, or NoticeError instance.

foreach($notices as $notice) {
    // skip debug notices unless debug mode is on...
    if($notice->flags & Notice::debug && !$config->debug) continue;
    // ...or use if(!$notice->viewable()) continue;

    // entity-encode unless markup is allowed
    $text = ($notice->flags & Notice::allowMarkup)
        ? $notice->text
        : $sanitizer->entities($notice->text);

    if($notice instanceof NoticeError) {
        echo "<p class='error'>$text</p>";
    } else if($notice instanceof NoticeWarning) {
        echo "<p class='warning'>$text</p>";
    } else {
        echo "<p class='message'>$text</p>";
    }
}

$notices->hasErrors()

Returns true if any NoticeError items are present.

if($notices->hasErrors()) {
    echo "There were errors — please review.";
}

$notices->hasWarnings()

Returns true if any NoticeWarning items are present.

$notices->getVisible()

Returns a new Notices object containing only notices that are visible to the current user (respects login, admin, superuser, debug, and logOnly flags). Available 3.0.252.

$visible = $notices->getVisible();
foreach($visible as $notice) {
    echo $notice->text . "\n";
}

$notices->add($notice)

Add a NoticeMessage, NoticeWarning, or NoticeError object directly. Duplicate notices are collapsed by default and the retained notice's qty property is incremented. Use Notice::allowDuplicate to keep duplicate notices as separate items.

• Arguments: add(Notice $notice)
• Returns: $notices

$notices->add(new NoticeMessage("Saved"));
$notices->add(new NoticeWarning("Review this setting", "noGroup"));
$notices->add(new NoticeError("Something failed", Notice::allowDuplicate));

$notices->render()

Render notices as HTML using the admin theme's standard notice markup. Useful for displaying notices outside of the normal admin flow. Available 3.0.254.

• Returns: string — HTML output
• This is a hookable method (___render()).

echo $notices->render();

$notices->renderText()

Render notices as plain text. If outputting inside HTML (e.g. a <pre>), pass the result through $sanitizer->entities() first. For CLI the return value can be output directly. Available 3.0.254.

• Returns: string
• This is a hookable method (___renderText()).

$text = $notices->renderText();
echo '<pre>' . $sanitizer->entities($text) . '</pre>';

• Source files: wire/core/Notices/Notice.php and wire/core/Notices/Notices.php.
• The Notice::log flag writes to the log named after the notice type: NoticeMessage → messages.txt, NoticeWarning → warnings.txt, NoticeError → errors.txt.
• Notice::allowMarkdown automatically converts the text using $sanitizer->entitiesMarkdown() and then sets allowMarkup — the original allowMarkdown flag is removed before display.
• Duplicate notices (same type, text, and flags) are silently collapsed by default. Use Notice::allowDuplicate to prevent collapsing.
• An icon can be set by prefixing the message text with icon-{name} (space after): $this->message("icon-check Item saved") sets the icon to check.
• The $notices API variable is shared across all Wire objects in the request. Notices added by any module or class accumulate in the same collection.