Plugin/Events: Difference between revisions

From Joomla! Documentation

< Plugin
Mvangeest (talk | contribs)
Editors
1,202 edits
Split off events from Plugin
 
Heelc29 (talk | contribs)
133 edits
translation
 
(107 intermediate revisions by 22 users not shown)
Line 1: Line 1:
Joomla! ships with a variety of core events, organised into groups.  These are described in the following topics.
<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=3.x|}}</noinclude>
{{-}}
<translate><!--T:1-->
Joomla! ships with a variety of core events, organised into groups.  These are described in the following topics.</translate>


* [[Plugin events/System|System events]]
<translate>
* [[Plugin events/User|User events]]
=== Api Authentication=== <!--T:26-->
* [[Plugin events/Editor|Editor events]]
</translate>
* [[Plugin events/Content|Content events]]
* [[S:MyLanguage/Plugin/Events/ApiAuthentication#onUserAuthenticate|onUserAuthenticate]]
* [[Plugin events/Contact|Contact events]]


This is an alphabetical list of the core events in Joomla! 1.5 together with the group name to which each belongs.  Each event name links to more detailed information.
<translate>
=== Authentication === <!--T:27-->
</translate>
* [[S:MyLanguage/Plugin/Events/Authentication#onUserAuthenticate|onUserAuthenticate]]


* [[Plugin events/Content#onAfterContentSave|onAfterContentSave]] (content)
<translate>
* [[Plugin events/User#onAfterDeleteUser|onAfterDeleteUser]] (user)
=== Behaviour === <!--T:28-->
* [[Plugin events/Content#onAfterDisplay|onAfterDisplay]] (content)
</translate>
* [[Plugin events/Content#onAfterDisplayTitle|onAfterDisplayTitle]] (content)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableObjectCreate|onTableObjectCreate]]
* [[Plugin events/Content#onAfterDisplayContent|onAfterDisplayContent]] (content)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableBeforeReset|onTableBeforeReset]]
* [[Plugin events/System#onAfterInitialise|onAfterInitialise]] (system)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableAfterReset|onTableAfterReset]]
* [[Plugin events/System#onAfterRoute|onAfterRoute]] (system)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableBeforeBind|onTableBeforeBind]]
* [[Plugin events/System#onAfterDispatch|onAfterDispatch]] (system)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableAfterBind|onTableAfterBind]]
* [[Plugin events/System#onAfterRender|onAfterRender]] (system)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableBeforeLoad|onTableBeforeLoad]]
* [[Plugin events/User#onAfterStoreUser|onAfterStoreUser]] (user)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableAfterLoad|onTableAfterLoad]]
* [[Plugin events/User#onAuthenticate|onAuthenticate]] (authentication)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableCheck|onTableCheck]]
* [[Plugin events/User#onAuthenticateFailure|onAuthenticateFailure]] (authentication)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableBeforeBind|onTableBeforeBind]]
* [[Plugin events/Content#onBeforeContentSave|onBeforeContentSave]] (content)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableAfterBind|onTableAfterBind]]
* [[Plugin events/User#onBeforeDeleteUser|onBeforeDeleteUser]] (user)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableBeforeStore|onTableBeforeStore]]
* [[Plugin events/Content#onBeforeDisplay|onBeforeDisplay]] (content)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableAfterStore|onTableAfterStore]]
* [[Plugin events/Content#onBeforeDisplayContent|onBeforeDisplayContent]] (content)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableBeforeDelete|onTableBeforeDelete]]
* [[Plugin events/User#onBeforeStoreUser|onBeforeStoreUser]] (user)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableAfterDelete|onTableAfterDelete]]
* [[Plugin events/Editor#onCustomEditorButton|onCustomEditorButton]] (editors-xtd)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableBeforeCheckout|onTableBeforeCheckout]]
* [[Plugin events/Editor#onDisplay|onDisplay]] (editors)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableAfterCheckout|onTableAfterCheckout]]
* [[Plugin events/Editor#onGetContent|onGetContent]] (editors)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableBeforeCheckin|onTableBeforeCheckin]]
* [[Plugin events/Editor#onGetInsertMethod|onGetInsertMethod]] (editors)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableAfterCheckin|onTableAfterCheckin]]
* [[Plugin events/System#onGetWebServices|onGetWebServices]] (xmlrpc)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableBeforeHit|onTableBeforeHit]]
* [[Plugin events/Editor#onInit|onInit]] (editors)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableAfterHit|onTableAfterHit]]
* [[Plugin events/User#onLoginUser|onLoginFailure]] (user)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableBeforeReorder|onTableBeforeReorder]]
* [[Plugin events/User#onLogoutUser|onLogoutFailure]] (user)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableAfterReorder|onTableAfterReorder]]
* [[Plugin events/User#onLoginUser|onLoginUser]] (user)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableBeforeMove|onTableBeforeMove]]
* [[Plugin events/User#onLogoutUser|onLogoutUser]] (user)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableAfterMove|onTableAfterMove]]
* [[Plugin events/Content#onPrepareContent|onPrepareContent]] (content)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableBeforePublish|onTableBeforePublish]]
* [[Plugin events/Editor#onSave|onSave]] (editors)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableAfterPublish|onTableAfterPublish]]
* [[Plugin events/System#onSearch|onSearch]] (search)
* [[S:MyLanguage/Plugin/Events/Behaviour#onTableSetNewTags|onTableSetNewTags]]
* [[Plugin events/System#onSearchAreas|onSearchAreas]] (search)
 
* [[Plugin events/Editor#onSetContent|onSetContent]] (editors)
<translate>
* [[Plugin events/Contact#onSubmitContact|onSubmitContact]] (contact)
=== Captcha === <!--T:6-->
* [[Plugin events/Contact#onValidateContact|onValidateContact]] (contact)
</translate>
<noinclude>[[Category:Plugin Development|Events]][[Category:Specifications]]</noinclude>
* [[S:MyLanguage/Plugin/Events/Captcha#onInit|onInit]]
* [[S:MyLanguage/Plugin/Events/Captcha#onDisplay|onDisplay]]
* [[S:MyLanguage/Plugin/Events/Captcha#onCheckAnswer|onCheckAnswer]]
* [[S:MyLanguage/Plugin/Events/Captcha#onPrivacyCollectAdminCapabilities|onPrivacyCollectAdminCapabilities]]
 
<translate>
=== Content === <!--T:7-->
</translate>
* [[S:MyLanguage/Plugin/Events/Content#onContentPrepare|onContentPrepare]]
* [[S:MyLanguage/Plugin/Events/Content#onContentAfterTitle|onContentAfterTitle]] ({{JVer|3.0}} <translate><!--T:24--> and higher</translate>)
* [[S:MyLanguage/Plugin/Events/Content#onContentBeforeDisplay|onContentBeforeDisplay]]
* [[S:MyLanguage/Plugin/Events/Content#onContentAfterDisplay|onContentAfterDisplay]]
* [[S:MyLanguage/Plugin/Events/Content#onContentBeforeSave|onContentBeforeSave]]
* [[S:MyLanguage/Plugin/Events/Content#onContentAfterSave|onContentAfterSave]]
* [[S:MyLanguage/Plugin/Events/Content#onContentPrepareForm|onContentPrepareForm]]
* [[S:MyLanguage/Plugin/Events/Content#onContentPrepareData|onContentPrepareData]]
* [[S:MyLanguage/Plugin/Events/Content#onContentBeforeDelete|onContentBeforeDelete]]
* [[S:MyLanguage/Plugin/Events/Content#onContentAfterDelete|onContentAfterDelete]]
* [[S:MyLanguage/Plugin/Events/Content#onContentChangeState|onContentChangeState]]
* [[S:MyLanguage/Plugin/Events/Content#onContentSearch|onContentSearch]]
* [[S:MyLanguage/Plugin/Events/Content#onContentSearchAreas|onContentSearchAreas]]
* [[S:MyLanguage/Plugin/Events/Content#onUserBeforeDataValidation|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 {{JVer|4.0}})
 
<translate>
=== Editors === <!--T:29-->
</translate>
* [[S:MyLanguage/Plugin/Events/Editor#onInit|onInit]]
* [[S:MyLanguage/Plugin/Events/Editor#onSave|onSave]]
* [[S:MyLanguage/Plugin/Events/Editor#onSetContent|onSetContent]]
* [[S:MyLanguage/Plugin/Events/Editor#onDisplay|onDisplay]]
* [[S:MyLanguage/Plugin/Events/Editor#onGetContent|onGetContent]]
* [[S:MyLanguage/Plugin/Events/Editor#onGetInsertMethod|onGetInsertMethod]]
 
<translate>
=== Editors-xtd === <!--T:30-->
</translate>
* [[S:MyLanguage/Plugin/Events/Editor-xtd#onDisplay|onDisplay]]
 
<translate>
=== Extensions === <!--T:9-->
</translate>
* [[S:MyLanguage/Plugin/Events/Extension#onExtensionAfterInstall|onExtensionAfterInstall]]
* [[S:MyLanguage/Plugin/Events/Extension#onExtensionAfterUninstall|onExtensionAfterUninstall]]
* [[S:MyLanguage/Plugin/Events/Extension#onExtensionAfterUpdate|onExtensionAfterUpdate]]
* [[S:MyLanguage/Plugin/Events/Extension#onExtensionAfterUpdate|onExtensionBeforeSave]]
* [[S:MyLanguage/Plugin/Events/Extension#onExtensionAfterUpdate|onExtensionAfterSave]]
* [[S:MyLanguage/Plugin/Events/Extension#onExtensionAfterDelete|onExtensionAfterDelete]]
 
<translate>
=== Fields === <!--T:31-->
</translate>
* [[S:MyLanguage/Plugin/Events/Fields#onCustomFieldsPrepareDom|onCustomFieldsPrepareDom]]
 
<translate>
=== Filesystem === <!--T:8-->
</translate>
* [[S:MyLanguage/Plugin/Events/Filesystem#onSetupProviders|onSetupProviders]]
 
<translate>
=== Finder === <!--T:10-->
</translate>
* [[S:MyLanguage/Plugin/Events/Finder#onFinderCategoryChangeState|onFinderCategoryChangeState]]
* [[S:MyLanguage/Plugin/Events/Finder#onFinderChangeState|onFinderChangeState]]
* [[S:MyLanguage/Plugin/Events/Finder#onFinderBeforeDelete|onFinderAfterDelete]]
* [[S:MyLanguage/Plugin/Events/Finder#onFinderAfterDelete|onFinderAfterDelete]]
* [[S:MyLanguage/Plugin/Events/Finder#onFinderBeforeSave|onFinderBeforeSave]]
* [[S:MyLanguage/Plugin/Events/Finder#onFinderAfterSave|onFinderAfterSave]]
* [[S:MyLanguage/Plugin/Events/Finder#onFinderResult|onFinderResult]] {{JVer|4.0}}
* [[S:MyLanguage/Plugin/Events/Finder#onPrepareFinderContent|onPrepareFinderContent]]
 
<translate>
=== Installer === <!--T:18-->
</translate>
* [[S:MyLanguage/Plugin/Events/Installer#onInstallerAddInstallationTab|onInstallerAddInstallationTab]]
 
<translate>
=== Media Action === <!--T:32-->
</translate>
* [[S:MyLanguage/Plugin/Events/Media-Action#onContentBeforeSave|onContentBeforeSave]]
 
<translate>
=== Privacy === <!--T:33-->
</translate>
* [[S:MyLanguage/Plugin/Events/Privacy#onPrivacyCanRemoveData|onPrivacyCanRemoveData]]
* [[S:MyLanguage/Plugin/Events/Privacy#onPrivacyExportRequest|onPrivacyExportRequest]]
* [[S:MyLanguage/Plugin/Events/Privacy#onPrivacyRemoveData|onPrivacyRemoveData]]
 
<translate>
=== Quick Icons === <!--T:11-->
</translate>
* [[S:MyLanguage/Plugin/Events/Quickicon#onGetIcons|onGetIcons]]
 
<translate>
=== Sampledata === <!--T:19-->
</translate>
* [[S:MyLanguage/Plugin/Events/SampleData#onSampledataGetOverview|onSampledataGetOverview]]
* [[S:MyLanguage/Plugin/Events/SampleData#onAjaxSampledataApplyStep1|onAjaxSampledataApplyStep1]]
* [[S:MyLanguage/Plugin/Events/SampleData#onAjaxSampledataApplyStep2|onAjaxSampledataApplyStep2]]
* [[S:MyLanguage/Plugin/Events/SampleData#onAjaxSampledataApplyStep3|onAjaxSampledataApplyStep3]]
 
<translate>
=== Schemaorg === <!--T:35-->
</translate>
* [[S:MyLanguage/Plugin/Events/Schemaorg#onSchemaBeforeCompileHead|onSchemaBeforeCompileHead]]
* [[S:MyLanguage/Plugin/Events/Schemaorg#onSchemaPrepareData|onSchemaPrepareData]]
* [[S:MyLanguage/Plugin/Events/Schemaorg#onSchemaPrepareForm|onSchemaPrepareForm]]
* [[S:MyLanguage/Plugin/Events/Schemaorg#onSchemaPrepareSave|onSchemaPrepareSave]]
 
<translate>
=== System === <!--T:12-->
</translate>
* [[S:MyLanguage/Plugin/Events/System#onAfterInitialise|onAfterInitialise]]
* [[S:MyLanguage/Plugin/Events/System#onAfterRoute|onAfterRoute]]
* [[S:MyLanguage/Plugin/Events/System#onAfterDispatch|onAfterDispatch]]
* [[S:MyLanguage/Plugin/Events/System#onAfterRender|onAfterRender]]
* [[S:MyLanguage/Plugin/Events/System#onBeforeRender|onBeforeRender]]
* [[S:MyLanguage/Plugin/Events/System#onBeforeCompileHead|onBeforeCompileHead]]
* [[S:MyLanguage/Plugin/Events/System#onAfterSessionStart|onAfterSessionStart]]
 
<translate>
=== User === <!--T:13-->
</translate>
* [[S:MyLanguage/Plugin/Events/User#onUserAuthorisation|onUserAuthorisation]]
* [[S:MyLanguage/Plugin/Events/User#onUserAuthorisationFailure|onUserAuthorisationFailure]]
* [[S:MyLanguage/Plugin/Events/User#onUserBeforeSave|onUserBeforeSave]]
* [[S:MyLanguage/Plugin/Events/User#onUserAfterSave|onUserAfterSave]]
* [[S:MyLanguage/Plugin/Events/User#onUserBeforeDelete|onUserBeforeDelete]]
* [[S:MyLanguage/Plugin/Events/User#onUserAfterDelete|onUserAfterDelete]]
* [[S:MyLanguage/Plugin/Events/User#onUserLogin|onUserLogin]]
* [[S:MyLanguage/Plugin/Events/User#onUserLoginFailure|onUserLoginFailure]]
* [[S:MyLanguage/Plugin/Events/User#onUserAfterLogin|onUserAfterLogin]]
* [[S:MyLanguage/Plugin/Events/User#onUserLogout|onUserLogout]]
* [[S:MyLanguage/Plugin/Events/User#onUserBeforeSaveGroup|onUserBeforeSaveGroup]]
* [[S:MyLanguage/Plugin/Events/User#onUserAfterSaveGroup|onUserAfterSaveGroup]]
* [[S:MyLanguage/Plugin/Events/User#onUserBeforeDeleteGroup|onUserBeforeDeleteGroup]]
* [[S:MyLanguage/Plugin/Events/User#onUserAfterDeleteGroup|onUserAfterDeleteGroup]]
* [[S:MyLanguage/Plugin/Events/User#onUserAfterRemind|onUserAfterRemind]]
 
<translate>
=== Web Services === <!--T:34-->
</translate>
* [[S:MyLanguage/Plugin/Events/WebServices#onBeforeApiRoute|onBeforeApiRoute]]
 
<translate>
=== Workflow === <!--T:35-->
</translate>
* [[S:MyLanguage/Plugin/Events/Workflow#onWorkflowBeforeTransition|onWorkflowBeforeTransition]]
 
<translate>
=== Other Core Component Events === <!--T:2--></translate>
 
<translate>
==== Actionlog Component ==== <!--T:20-->
</translate>
* [[S:MyLanguage/Plugin/Events/Actionlog#onAfterLogPurge|onAfterLogPurge]]
* [[S:MyLanguage/Plugin/Events/Actionlog#onAfterLogExport|onAfterLogExport]]
 
<translate>
==== Cache Component ==== <!--T:21-->
</translate>
* [[S:MyLanguage/Plugin/Events/Cache#onAfterPurge|onAfterPurge]]
 
<translate>
==== Checkin Component ==== <!--T:22-->
</translate>
* [[S:MyLanguage/Plugin/Events/Checkin#onAfterCheckin|onAfterCheckin]]
 
<translate>
==== Config Component ==== <!--T:23-->
</translate>
* [[S:MyLanguage/Plugin/Events/Config#onApplicationAfterSave|onApplicationAfterSave]]
 
<translate>
==== Contact Component ==== <!--T:14-->
</translate>
* [[S:MyLanguage/Plugin/Events/Contact#onValidateContact|onValidateContact]]
* [[S:MyLanguage/Plugin/Events/Contact#onSubmitContact|onSubmitContact]]
 
<translate>
==== Installer Component ==== <!--T:15-->
</translate>
* [[S:MyLanguage/Plugin/Events/Install#onInstallerBeforeInstallation|onInstallerBeforeInstallation]]
* [[S:MyLanguage/Plugin/Events/Install#onInstallerBeforeInstaller|onInstallerBeforeInstaller]]
* [[S:MyLanguage/Plugin/Events/Install#onInstallerAfterInstaller|onInstallerAfterInstaller]]
 
<translate>
==== Menu Component ==== <!--T:16-->
</translate>
* [[S:MyLanguage/Plugin/Events/Menu#onAfterGetMenuTypeOptions|onAfterGetMenuTypeOptions]]
 
<translate>
==== Module ==== <!--T:17-->
</translate>
* [[S:MyLanguage/Plugin/Events/Module#onRenderModule|onRenderModule]]
* [[S:MyLanguage/Plugin/Events/Module#onAfterRenderModule|onAfterRenderModule]]
* [[S:MyLanguage/Plugin/Events/Module#onAfterRenderModules|onAfterRenderModules]]
* [[S:MyLanguage/Plugin/Events/Module#onPrepareModuleList|onPrepareModuleList]]
* [[S:MyLanguage/Plugin/Events/Module#onAfterModuleList|onAfterModuleList]]
* [[S:MyLanguage/Plugin/Events/Module#onAfterCleanModuleList|onAfterCleanModuleList]]
 
<noinclude>
[[Category:Plugin Development|Events{{#translation:}}]]
[[Category:Specifications{{#translation:}}]]
[[Category:Tutorials{{#translation:}}]]
</noinclude>

Latest revision as of 10:40, 6 August 2023

Other languages:
Joomla! 
3.x

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

Api Authentication

Authentication

Behaviour

Captcha

Content

Editors

Editors-xtd

Extensions

Fields

Filesystem

Finder

Installer

Media Action

Privacy

Quick Icons

Sampledata

Schemaorg

System

User

Web Services

Workflow

Other Core Component Events

Actionlog Component

Cache Component

Checkin Component

Config Component

Contact Component

Installer Component

Menu Component

Module

Retrieved from "https://docs.sandbox.joomla.org/index.php?title=Plugin/Events&oldid=1010366"