Actions

Difference between revisions of "Plugin/Events"

From Joomla! Documentation

< Plugin
(Content)
(Add in Authentication Plugins)
(37 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
<noinclude>{{version|1.5,2.5,3.x}}{{JSplit}}</noinclude>
 
Joomla! ships with a variety of core events, organised into groups.  These are described in the following topics.
 
Joomla! ships with a variety of core events, organised into groups.  These are described in the following topics.
  
* [[Plugin/Events/System|System events]]
+
==Joomla! 2.5 and up==
* [[Plugin/Events/Content|Content events]]
+
=== Authentication ===
* [[Plugin/Events/User|User events]]
+
* [[Plugin/Events/User#onUserAuthenticate|onUserAuthenticate]] {{JVer|2.5}} {{JVer|3.1}}
* [[Plugin/Events/Editor|Editor events]]
+
  
* [[Plugin/Events/Contact|Contact events]]
+
=== Captcha ===
 +
* [[Plugin/Events/Editor#onInit|onInit]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Editor#onDisplay|onDisplay]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Captcha#onCheckAnswer|onCheckAnswer]] {{JVer|2.5}} {{JVer|3.1}}
  
This is 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.
+
=== Content ===
 +
* [[Plugin/Events/Content#onContentPrepareForm|onContentPrepareForm]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Content#onContentPrepareData|onContentPrepareData]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Content#onContentAfterDelete|onContentAfterDelete]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Content#onContentBeforeDelete|onContentBeforeDelete]] {{JVer|2.5}}{{JVer|3.1}}
 +
* [[Plugin/Events/Content#onContentBeforeDisplay|onContentBeforeDisplay]] {{JVer|2.5}}{{JVer|3.1}}
 +
* [[Plugin/Events/Content#onContentAfterDisplay|onContentAfterDisplay]] {{JVer|2.5}}{{JVer|3.1}}
 +
* [[Plugin/Events/Content#onContentBeforeSave|onContentBeforeSave]] {{JVer|2.5}}{{JVer|3.1}}
 +
* [[Plugin/Events/Content#onContentAfterSave|onContentAfterSave]] {{JVer|2.5}}{{JVer|3.1}}
 +
* [[Plugin/Events/Content#onContentChangeState|onContentChangeState]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Content#onContentPrepare|onContentPrepare]] {{JVer|2.5}}{{JVer|3.1}}
 +
* [[Plugin/Events/Content#onContentSearch|onContentSearch]] {{JVer|2.5}}{{JVer|3.1}}
 +
* [[Plugin/Events/Content#onContentSearchAreas|onContentSearchAreas]] {{JVer|2.5}}{{JVer|3.1}}
 +
* [[Plugin/Events/Content#onContentAfterTitle|onContentAfterTitle]] {{JVer|3.1}}
  
== System ==
+
=== Editors ===
* [[Plugin/Events/System#onAfterInitialise|onAfterInitialise]]
+
* [[Plugin/Events/Editor#onInit|onInit]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
* [[Plugin/Events/System#onAfterRoute|onAfterRoute]]
+
* [[Plugin/Events/Editor#onSave|onSave]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
* [[Plugin/Events/System#onAfterDispatch|onAfterDispatch]]
+
* [[Plugin/Events/Editor#onSetContent|onSetContent]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
* [[Plugin/Events/System#onAfterRender|onAfterRender]]
+
* [[Plugin/Events/Editor#onDisplay|onDisplay]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Editor#onGetContent|onGetContent]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Editor#onGetInsertMethod|onGetInsertMethod]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
  
== Content ==
+
=== Extensions ===
 +
* [[Plugin/Events/Extension#onExtensionAfterInstall|onExtensionAfterInstall]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Extension#onExtensionAfterUninstall|onExtensionAfterUninstall]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Extension#onExtensionAfterUpdate|onExtensionAfterUpdate]] {{JVer|2.5}} {{JVer|3.1}}
 +
 
 +
=== Finder ===
 +
* [[Plugin/Events/Finder#onFinderCategoryChangeState|onFinderCategoryChangeState]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Finder#onFinderChangeState|onFinderChangeState]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Finder#onFinderBeforeDelete|onFinderAfterDelete]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Finder#onFinderAfterDelete|onFinderAfterDelete]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Finder#onFinderBeforeSave|onFinderBeforeSave]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Finder#onFinderAfterSave|onFinderAfterSave]] {{JVer|2.5}} {{JVer|3.1}}
 +
 
 +
=== Quick Icons ===
 +
* [[Plugin/Events/Quickicon#onGetIcons|onGetIcons]] {{JVer|2.5}} {{JVer|3.1}}
 +
 
 +
=== System ===
 +
* [[Plugin/Events/System#onAfterInitialise|onAfterInitialise]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/System#onAfterRoute|onAfterRoute]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/System#onAfterDispatch|onAfterDispatch]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/System#onAfterRender|onAfterRender]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/System#onBeforeRender|onBeforeRender]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/System#onBeforeCompileHead|onBeforeCompileHead]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/System#onSearch|onSearch]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/System#onSearchAreas|onSearchAreas]] {{JVer|2.5}} {{JVer|3.1}}
 +
 
 +
=== User ===
 +
* [[Plugin/Events/User#onUserBeforeSave|onUserBeforeSave]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/User#onUserAfterSave|onUserAfterSave]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/User#onUserBeforeDelete|onUserBeforeDelete]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/User#onUserAfterDelete|onUserAfterDelete]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/User#onUserLogin|onUserLogin]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/User#onUserLogout|onUserLogout]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/User#onUserAuthenticate|onUserAuthenticate]] {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/User#onUserAuthorisation|onUserAuthorisation]] {{JVer|2.5}} {{JVer|3.1}}
 +
 
 +
==Joomla! 1.5==
 +
=== Authentication ===
 +
* [[Plugin/Events/User#onAuthenticate|onAuthenticate]] {{JVer|1.5}}
 +
* [[Plugin/Events/User#onAuthenticateFailure|onAuthenticateFailure]] {{JVer|1.5}}
 +
 
 +
=== Content ===
 
* [[Plugin/Events/Content#onAfterDisplay|onAfterDisplay]] {{JVer|1.5}}
 
* [[Plugin/Events/Content#onAfterDisplay|onAfterDisplay]] {{JVer|1.5}}
 
* [[Plugin/Events/Content#onAfterContentSave|onAfterContentSave]] {{JVer|1.5}}
 
* [[Plugin/Events/Content#onAfterContentSave|onAfterContentSave]] {{JVer|1.5}}
Line 25: Line 84:
 
* [[Plugin/Events/Content#onBeforeContentSave|onBeforeContentSave]] {{JVer|1.5}}
 
* [[Plugin/Events/Content#onBeforeContentSave|onBeforeContentSave]] {{JVer|1.5}}
 
* [[Plugin/Events/Content#onBeforeDisplayContent|onBeforeDisplayContent]] {{JVer|1.5}}
 
* [[Plugin/Events/Content#onBeforeDisplayContent|onBeforeDisplayContent]] {{JVer|1.5}}
* [[Plugin/Events/Content#onContentPrepareForm|onContentPrepareForm]] {{JVer|1.5}}
+
* [[Plugin/Events/Content#onContentPrepareForm|onContentPrepareForm]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
* [[Plugin/Events/Content#onContentPrepareData|onContentPrepareData]] {{JVer|1.5}}
+
* [[Plugin/Events/Content#onContentPrepareData|onContentPrepareData]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
  
== User ==  
+
=== Contact ===
* [[Plugin/Events/User#onBeforeDeleteUser|onBeforeDeleteUser]]
+
* [[Plugin/Events/Contact#onSubmitContact|onSubmitContact]] {{JVer|1.5}}
* [[Plugin/Events/User#onAfterDeleteUser|onAfterDeleteUser]]
+
* [[Plugin/Events/Contact#onValidateContact|onValidateContact]] {{JVer|1.5}}
* [[Plugin/Events/User#onBeforeStoreUser|onBeforeStoreUser]]
+
* [[Plugin/Events/User#onAfterStoreUser|onAfterStoreUser]]
+
* [[Plugin/Events/User#onLoginUser|onLoginUser]]
+
* [[Plugin/Events/User#onLoginUser|onLoginFailure]]
+
* [[Plugin/Events/User#onLogoutUser|onLogoutUser]]
+
* [[Plugin/Events/User#onLogoutUser|onLogoutFailure]]
+
  
== Authentication ==
+
=== Editors ===
* [[Plugin/Events/User#onAuthenticate|onAuthenticate]]
+
* [[Plugin/Events/Editor#onCustomEditorButton|onCustomEditorButton]] (editors-xtd) {{JVer|1.5}}
* [[Plugin/Events/User#onAuthenticateFailure|onAuthenticateFailure]]
+
* [[Plugin/Events/Editor#onInit|onInit]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Editor#onSave|onSave]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Editor#onSetContent|onSetContent]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Editor#onDisplay|onDisplay]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Editor#onGetContent|onGetContent]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/Editor#onGetInsertMethod|onGetInsertMethod]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
  
== Editors ==
+
=== Search ===
* [[Plugin/Events/Editor#onInit|onInit]]
+
* [[Plugin/Events/System#onSearch|onSearch]] {{JVer|1.5}}
* [[Plugin/Events/Editor#onSave|onSave]]
+
* [[Plugin/Events/System#onSearchAreas|onSearchAreas]] {{JVer|1.5}}
* [[Plugin/Events/Editor#onSetContent|onSetContent]]
+
* [[Plugin/Events/Editor#onCustomEditorButton|onCustomEditorButton]] (editors-xtd)
+
* [[Plugin/Events/Editor#onDisplay|onDisplay]]
+
* [[Plugin/Events/Editor#onGetContent|onGetContent]]
+
* [[Plugin/Events/Editor#onGetInsertMethod|onGetInsertMethod]]
+
  
== Search ==
+
=== System ===
* [[Plugin/Events/System#onSearch|onSearch]]
+
* [[Plugin/Events/System#onGetWebServices|onGetWebServices]] {{JVer|1.5}}
* [[Plugin/Events/System#onSearchAreas|onSearchAreas]]
+
* [[Plugin/Events/System#onAfterInitialise|onAfterInitialise]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/System#onAfterRoute|onAfterRoute]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/System#onAfterDispatch|onAfterDispatch]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
 +
* [[Plugin/Events/System#onAfterRender|onAfterRender]] {{JVer|1.5}} {{JVer|2.5}} {{JVer|3.1}}
  
== Contact ==
+
=== User ===
* [[Plugin/Events/Contact#onSubmitContact|onSubmitContact]]
+
* [[Plugin/Events/User#onBeforeDeleteUser|onBeforeDeleteUser]] {{JVer|1.5}}
* [[Plugin/Events/Contact#onValidateContact|onValidateContact]]
+
* [[Plugin/Events/User#onAfterDeleteUser|onAfterDeleteUser]] {{JVer|1.5}}
 +
* [[Plugin/Events/User#onBeforeStoreUser|onBeforeStoreUser]] {{JVer|1.5}}
 +
* [[Plugin/Events/User#onAfterStoreUser|onAfterStoreUser]] {{JVer|1.5}}
 +
* [[Plugin/Events/User#onLoginUser|onLoginUser]] {{JVer|1.5}}
 +
* [[Plugin/Events/User#onLoginUser|onLoginFailure]] {{JVer|1.5}}
 +
* [[Plugin/Events/User#onLogoutUser|onLogoutUser]] {{JVer|1.5}}
 +
* [[Plugin/Events/User#onLogoutUser|onLogoutFailure]] {{JVer|1.5}}
  
== XML-RPC ==
+
=== XML-RPC ===
* [[Plugin/Events/System#onGetWebServices|onGetWebServices]]
+
* [[Plugin/Events/System#onGetWebServices|onGetWebServices]] {{JVer|1.5}}
<noinclude>[[Category:Plugin Development|Events]][[Category:Specifications]]</noinclude>
+
<noinclude>[[Category:Plugin Development|Events]][[Category:Specifications]]
 +
[[Category:Tutorials]]
 +
</noinclude>

Revision as of 06:17, 23 August 2013

Split-icon.png
Split Page into Specific Joomla! Versions - J2.5 and J3.1

It has been suggested that this article or section be split into specific version Namespaces. (Discuss). If version split is not obvious, please allow split request to remain for 1 week pending discussions. Proposed since 11 months ago.

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

Contents

Joomla! 2.5 and up

Authentication

Captcha

Content

Editors

Extensions

Finder

Quick Icons

System

User

Joomla! 1.5

Authentication

Content

Contact

Editors

Search

System

User

XML-RPC