Table of Contents

triggerEvent

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

Calls all handlers associated with an event group. Any handlers that have been registered with the specified event using the JApplication->registerEvent method are invoked with the specified arguments (if any).

Syntax

array triggerEvent ( $event, $args )

$event string is a string containing the name of the event to trigger.
$args array is an array containing the arguments to pass to the handler. This parameter is optional and if omitted defaults to null.

Examples

The core Joomla! code invokes this method in the following manner to trigger the onBeforeDisplay event:

Example

$mainframe->triggerEvent( 'onBeforeDisplay' );