Display error messages and notices

From Joomla! Documentation

Revision as of 23:00, 29 November 2022 by Cmb (talk | contribs) (Several markup changes. URL corrections.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎español • ‎français

Errors, warnings, alerts and notices can be displayed from any component, module, plugin or template using the methods outlined below. 

// Get a handle to the Joomla! application object
$application = JFactory::getApplication();

// Add a message to the message queue
$application->enqueueMessage(JText::_('SOME_ERROR_OCCURRED'), 'error');

/** Alternatively you may use chaining */
JFactory::getApplication()->enqueueMessage(JText::_('SOME_ERROR_OCCURRED'), 'error');

The second argument to the enqueueMessage function is the type of the message. The default is message, but error results in a different style for the message. The message will be displayed in place of a special jdoc:include statement in your template. Place the following in your template at the location where you want messages to appear. 

<jdoc:include type="message" />

Message[edit]

Message 

JFactory::getApplication()->enqueueMessage('Message');

Notice[edit]

Notice 

JError::raiseNotice( 100, 'Notice' );

Warning[edit]

Warning 

JError::raiseWarning( 100, 'Warning' );

Error[edit]

Error 

JError::raiseError( 4711, 'A severe error occurred' );

Joomla! 3.x is Bootstrapped[edit]

Since Joomla! Joomla 3.x uses Bootstrapped templates, the messages will use the standard Bootstrap CSS styles for Alerts.

See: https://getbootstrap.com/2.3.2/components.html#alerts

The general syntax remains: 

JFactory::getApplication()->enqueueMessage('Your Message', 'type');

Where type can be one of

  • 'message' (or empty) - green
  • 'notice' - blue
  • 'warning' - yellow
  • 'error' - red

See Also[edit]

Retrieved from "https://docs.joomla.org/index.php?title=Display_error_messages_and_notices&oldid=995764"