Wire::error() method

Record an non-fatal error message in the system-wide notices.

  • This method automatically identifies the error as coming from this class.
  • You should still make fatal errors throw a WireException (or class derived from it).

Example

$this->error("This is the notice text"); 
$this->error("This notice is also logged", true);
$this->error("This notice is only shown in debug mode", Notice::debug);
$this->error("This notice allows <em>markup</em>", Notice::allowMarkup);
$this->error("Notice using multiple flags", Notice::debug | Notice::logOnly);

Usage

// basic usage
$wire->error($text);

// usage with all arguments
$wire->error($text, $flags = 0);

Arguments

NameType(s)Description
textstring, array, Wire

Text to include in the notice

flags (optional)int, bool, string

Optional flags to alter default behavior:

  • Notice::admin (constant): Show notice only if user is in the admin.
  • Notice::allowMarkdown (constant): Allow basic markdown and bracket markup (see $sanitizer->entitiesMarkdown()).
  • Notice::allowMarkup (constant): Indicates notice should allow the use of HTML markup tags.
  • Notice::debug (constant): Indicates notice should only be shown when debug mode is active.
  • Notice::log (constant): Indicates notice should also be logged.
  • Notice::logOnly (constant): Indicates notice should only be logged.
  • Notice::login (constant): Show notice only if it will be seen by a logged-in user.
  • Notice::noGroup (constant): Indicates notice should not group with others of the same type (where supported).
  • Notice::prepend (constant): Indicates notice should prepend rather than append.
  • Notice::superuser (constant): Show notice only if current user is a superuser.
  • true (boolean): Shortcut for the Notice::log constant.
  • In 3.0.149+ you may also specify a space-separated string of flag names, i.e. "admin log noGroup".

Return value

$this

Object instance it was called from (method supports fluent interface).

See Also


Wire methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull