modX.addEventListener

modX::addEventListener¶

Add a plugin to the eventMap within the current execution cycle.

Syntax¶

boolean addEventListener (string $event, integer $pluginId, [string $propertySetName = ''])

• $event (string) Name of the event. required
• $pluginId (integer) Plugin identifier to add to the event. required
• $propertySetName (string) The name of property set bound to the plugin

Example¶

Add a Plugin with ID 12 to the Event OnChunkFormPrerender:

$modx->addEventListener('OnChunkFormPrerender', 12);

The event name is not validated, so a listener registered for a misspelled or non-existent event fails silently.

See Also¶

• modX
• Plugins