Joomla! Documentation™

<translate> A plugin is a kind of Joomla! extension. Plugins provide functions which are associated with trigger events. Joomla provides a set of core plugin events, but any extension can fire (custom) events. When a particular event occurs, all plugin functions of the type associated with the event are executed in sequence. This is a powerful way of extending the functionality of Joomla. It also offers extension developers a way to allow other extensions to respond to their actions, making extensions extensible.</translate>

<translate> The Joomla! plugin architecture follows the Observer design pattern. The JPlugin class provides the means to register custom plugin code with core or custom events. The JEventDispatcher class is an event handler which calls all plugins registered for a particular event, when that event is triggered. In Joomla 4.x this has been moved to the \Joomla\Event\Dispatcher class in Joomla, and additionally follows the Mediator design pattern</translate>

<translate> See also: Component, Module, Template</translate>

Useful reference: Gallery 2: Embedding: Event-Based Loose-Coupled Integration

Recommended Reading

Developers

<translate> Plugin Development</translate>

{{Portal:Plugin_Development/Intro/<translate> en</translate>}}

<translate> Using Plugins</translate>

{{Portal:Plugin_Development/Using_Plugins/<translate> en</translate>}}

<translate> Reading list</translate>

{{Portal:Plugin_Development/Reading list/<translate> en</translate>}}

<translate> Tutorials</translate>

{{Portal:Plugin_Development/Tutorials/<translate> en</translate>}}

<translate> Plugin Development Articles Needed</translate>

{{Portal:Plugin_Development/Projects/<translate> en</translate>}}

For more developer information, see Plugin Development.

Events

<translate> Joomla! ships with a variety of core events, organised into groups. These are described in the following topics.</translate>

<translate>

Api Authentication

</translate>

• onUserAuthenticate

<translate>

Authentication

</translate>

• onUserAuthenticate

<translate>

Behaviour

</translate>

• onTableObjectCreate
• onTableBeforeReset
• onTableAfterReset
• onTableBeforeBind
• onTableAfterBind
• onTableBeforeLoad
• onTableAfterLoad
• onTableCheck
• onTableBeforeBind
• onTableAfterBind
• onTableBeforeStore
• onTableAfterStore
• onTableBeforeDelete
• onTableAfterDelete
• onTableBeforeCheckout
• onTableAfterCheckout
• onTableBeforeCheckin
• onTableAfterCheckin
• onTableBeforeHit
• onTableAfterHit
• onTableBeforeReorder
• onTableAfterReorder
• onTableBeforeMove
• onTableAfterMove
• onTableBeforePublish
• onTableAfterPublish
• onTableSetNewTags

<translate>

Captcha

</translate>

• onInit
• onDisplay
• onCheckAnswer
• onPrivacyCollectAdminCapabilities

<translate>

Content

</translate>

• onContentPrepare
• onContentAfterTitle ( <translate> and higher</translate>)
• onContentBeforeDisplay
• onContentAfterDisplay
• onContentBeforeSave
• onContentAfterSave
• onContentPrepareForm
• onContentPrepareData
• onContentBeforeDelete
• onContentAfterDelete
• onContentChangeState
• onContentSearch
• onContentSearchAreas
• onUserBeforeDataValidation (N.B. Whilst this event starts with user it's misleading - it applies to all actions and is renamed to a better name of onContentValidateData in )

<translate>

Editors

</translate>

• onInit
• onSave
• onSetContent
• onDisplay
• onGetContent
• onGetInsertMethod

<translate>

Editors-xtd

</translate>

• onDisplay

<translate>

Extensions

</translate>

• onExtensionAfterInstall
• onExtensionAfterUninstall
• onExtensionAfterUpdate
• onExtensionBeforeSave
• onExtensionAfterSave
• onExtensionAfterDelete

<translate>

Fields

</translate>

• onCustomFieldsPrepareDom

<translate>

Filesystem

</translate>

• onSetupProviders

<translate>

Finder

</translate>

• onFinderCategoryChangeState
• onFinderChangeState
• onFinderAfterDelete
• onFinderAfterDelete
• onFinderBeforeSave
• onFinderAfterSave
• onFinderResult
• onPrepareFinderContent

<translate>

Installer

</translate>

• onInstallerAddInstallationTab

<translate>

Media Action

</translate>

• onContentBeforeSave

<translate>

Privacy

</translate>

• onPrivacyCanRemoveData
• onPrivacyExportRequest
• onPrivacyRemoveData

<translate>

Quick Icons

</translate>

• onGetIcons

<translate>

Sampledata

</translate>

• onSampledataGetOverview
• onAjaxSampledataApplyStep1
• onAjaxSampledataApplyStep2
• onAjaxSampledataApplyStep3

<translate>

Schemaorg

</translate>

• onSchemaBeforeCompileHead
• onSchemaPrepareData
• onSchemaPrepareForm
• onSchemaPrepareSave

<translate>

System

</translate>

• onAfterInitialise
• onAfterRoute
• onAfterDispatch
• onAfterRender
• onBeforeRender
• onBeforeCompileHead
• onAfterSessionStart

<translate>

User

</translate>

• onUserAuthorisation
• onUserAuthorisationFailure
• onUserBeforeSave
• onUserAfterSave
• onUserBeforeDelete
• onUserAfterDelete
• onUserLogin
• onUserLoginFailure
• onUserAfterLogin
• onUserLogout
• onUserBeforeSaveGroup
• onUserAfterSaveGroup
• onUserBeforeDeleteGroup
• onUserAfterDeleteGroup
• onUserAfterRemind

<translate>

Web Services

</translate>

• onBeforeApiRoute

<translate>

Workflow

</translate>

• onWorkflowBeforeTransition

<translate> === Other Core Component Events === </translate>

<translate>

Actionlog Component

</translate>

• onAfterLogPurge
• onAfterLogExport

<translate>

Cache Component

</translate>

• onAfterPurge

<translate>

Checkin Component

</translate>

• onAfterCheckin

<translate>

Config Component

</translate>

• onApplicationAfterSave

<translate>

Contact Component

</translate>

• onValidateContact
• onSubmitContact

<translate>

Installer Component

</translate>

• onInstallerBeforeInstallation
• onInstallerBeforeInstaller
• onInstallerAfterInstaller

<translate>

Menu Component

</translate>

• onAfterGetMenuTypeOptions

<translate>

Module

</translate>

• onRenderModule
• onAfterRenderModule
• onAfterRenderModules
• onPrepareModuleList
• onAfterModuleList
• onAfterCleanModuleList