System Events

Skip to end of metadata

Page restrictions apply
Added by Shaun McCormick, last edited by Bob Ray on Apr 21, 2012 (view change)

What are System Events?
The Model of a System Event

Service Types

Available Events
See Also

What are System Events?

System Events are the events in MODx that Plugins are registered to. They are 'fired' throughout the MODx code, allowing Plugins to interact with MODx code and add custom functionality without hacking core code.

The Model of a System Event

The system events table is found under {table_prefix}_system_eventnames, and has the following fields:

id - The unique ID of the event.
name - The name of the event. This is how they are referenced in code, via the modX.invokeEvent method.
service - What type of system event this event is.
groupname - Used for user interfaces, primarily for filtering, grouping and sorting of events. Not used explicitly in the modx model.

Service Types

The 'service' field in the System event is a number; the numbers reference different types of System Events. They are:

1 - Parser Service Events
2 - Manager Access Events
3 - Web Access Service Events
4 - Cache Service Events
5 - Template Service Events
6 - User Defined Events

3 is not fired in the 'mgr' context; 2 is not fired in any context but 'mgr'.

Available Events

This is not an exhaustive list as events are still being documented. Thank you for your patience. The TV, Template and Snippet events are still to be documented. For a complete list, please either view a Plugin in the manager and see the System Events tab, or view here. Note also that all WUsr (web-user) events have been removed.

Child Pages (106)

Hide Child Pages | Reorder Pages

Page: OnBeforeCacheUpdate
Page: OnBeforeChunkFormDelete
Page: OnBeforeChunkFormSave
Page: OnBeforeDocFormDelete
Page: OnBeforeDocFormSave
Page: OnBeforeManagerLogout
Page: OnBeforeSaveWebPageCache
Page: OnBeforeWebLogout
Page: OnCacheUpdate
Page: OnChunkFormDelete
Page: OnChunkFormPrerender
Page: OnChunkFormRender
Page: OnChunkFormSave
Page: OnDocFormDelete
Page: OnDocFormPrerender
Page: OnDocFormRender
Page: OnDocFormSave
Page: OnDocPublished
Page: OnDocUnPublished
Page: OnLoadWebPageCache
Page: OnManagerLogin
Page: OnManagerLogout
Page: OnSiteRefresh
Page: OnUserChangePassword
Page: OnWebLogin
Page: OnWebLogout
Page: OnWebPagePrerender
Page: OnManagerPageBeforeRender
Page: OnTemplateVarBeforeSave
Page: OnTemplateVarSave
Page: OnTemplateVarBeforeRemove
Page: OnTemplateVarRemove
Page: OnBeforeEmptyTrash
Page: OnBeforeManagerLogin
Page: OnBeforeManagerPageInit
Page: OnBeforePluginFormDelete
Page: OnBeforePluginFormSave
Page: OnBeforeSnipFormDelete
Page: OnBeforeSnipFormSave
Page: OnBeforeTempFormDelete
Page: OnBeforeTempFormSave
Page: OnBeforeTVFormDelete
Page: OnBeforeTVFormSave
Page: OnBeforeUserActivate
Page: OnBeforeUserFormDelete
Page: OnBeforeUserFormSave
Page: OnBeforeWebLogin
Page: OnCategoryBeforeRemove
Page: OnCategoryBeforeSave
Page: OnCategoryRemove
Page: OnCategorySave
Page: OnChunkBeforeRemove
Page: OnChunkBeforeSave
Page: OnChunkRemove
Page: OnChunkSave
Page: OnContextBeforeRemove
Page: OnContextBeforeSave
Page: OnContextFormPrerender
Page: OnContextFormRender
Page: OnContextRemove
Page: OnContextSave
Page: OnEmptyTrash
Page: OnFileManagerUpload
Page: OnHandleRequest
Page: OnInitCulture
Page: OnLoadWebDocument
Page: OnManagerAuthentication
Page: OnManagerLoginFormPrerender
Page: OnManagerLoginFormRender
Page: OnManagerPageAfterRender
Page: OnManagerPageInit
Page: OnPageNotFound
Page: OnPageUnauthorized
Page: OnParseDocument
Page: OnPluginBeforeRemove
Page: OnPluginBeforeSave
Page: OnPluginEventRemove
Page: OnPluginFormDelete
Page: OnPluginFormPrerender
Page: OnPluginFormRender
Page: OnPluginFormSave
Page: OnPluginRemove
Page: OnPluginSave
Page: OnPropertySetBeforeRemove
Page: OnPropertySetBeforeSave
Page: OnPropertySetRemove
Page: OnPropertySetSave
Page: OnResourceGroupBeforeRemove
Page: OnResourceGroupBeforeSave
Page: OnResourceGroupRemove
Page: OnResourceGroupSave
Page: OnRichTextBrowserInit
Page: OnRichTextEditorInit
Page: OnRichTextEditorRegister
Page: OnSiteSettingsRender
Page: OnUserActivate
Page: OnUserBeforeRemove
Page: OnUserBeforeSave
Page: OnUserFormDelete
Page: OnUserFormSave
Page: OnUserNotFound
Page: OnUserRemove
Page: OnUserSave
Page: OnWebAuthentication
Page: OnWebPageComplete
Page: OnWebPageInit