Table of Contents

enqueueMessage

API Package Subpackage Class Method Reference Last reviewed Doc status
API Home Package Joomla.Framework Subpackage Application Class JApplication Method enqueueMessage Reference enqueueMessage() Never Work in Progress

Enqueues a message into the system message queue. The system messages are displayed when the page is rendered. The messages are rendered using <dt> and <dd> tags. The $type parameter is applied to the class of these tags. The messages are included in the template using <jdoc:include type=”message” />.

Syntax

void enqueueMessage ( $msg, $type )

$msg string the message to enqueue.
$type string the message type. This parameter is optional and if omitted defaults to ‘message’.

Examples

Example

global $mainframe;

$mainframe->enqueueMessage( 'This is a test!' );

might result in:

Result

<dl id="system-message" class="message fade">
<dt class="message">Message</dt>
<dd class="message">
	<ul>

		<li>This is a test!</li>
	</ul>
</dd>
</dl>

being rendered onto the page.