Plugin

From Joomla! Documentation
(Difference between revisions)
Jump to: navigation, search
m (Referenced "Recommended Reading" reference)
m (Split off events to Plugin events)
Line 15: Line 15:
  
 
==Events==
 
==Events==
−
Joomla! ships with a variety of core events, organised into groups.  These are described in the following topics.
+
{{:Plugin events}}
−
 
+
−
* [[Reference:System Events for Plugin System|System events]]
+
−
* [[Reference:User Events for Plugin System|User events]]
+
−
* [[Reference:Editor Events for Plugin System|Editor events]]
+
−
* [[Reference:Content Events for Plugin System|Content events]]
+
−
* [[Reference:Contact Events for Plugin System|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.
+
−
 
+
−
* [[Reference:Content Events for Plugin System#onAfterContentSave|onAfterContentSave]] (content)
+
−
* [[Reference:User Events for Plugin System#onAfterDeleteUser|onAfterDeleteUser]] (user)
+
−
* [[Reference:Content Events for Plugin System#onAfterDisplay|onAfterDisplay]] (content)
+
−
* [[Reference:Content Events for Plugin System#onAfterDisplayTitle|onAfterDisplayTitle]] (content)
+
−
* [[Reference:Content Events for Plugin System#onAfterDisplayContent|onAfterDisplayContent]] (content)
+
−
* [[Reference:System Events for Plugin System#onAfterInitialise|onAfterInitialise]] (system)
+
−
* [[Reference:System Events for Plugin System#onAfterRoute|onAfterRoute]] (system)
+
−
* [[Reference:System Events for Plugin System#onAfterDispatch|onAfterDispatch]] (system)
+
−
* [[Reference:System Events for Plugin System#onAfterRender|onAfterRender]] (system)
+
−
* [[Reference:User_Events for Plugin System#onAfterStoreUser|onAfterStoreUser]] (user)
+
−
* [[Reference:User_Events for Plugin System#onAuthenticate|onAuthenticate]] (authentication)
+
−
* [[Reference:User_Events for Plugin System#onAuthenticateFailure|onAuthenticateFailure]] (authentication)
+
−
* [[Reference:Content Events for Plugin System#onBeforeContentSave|onBeforeContentSave]] (content)
+
−
* [[Reference:User Events for Plugin System#onBeforeDeleteUser|onBeforeDeleteUser]] (user)
+
−
* [[Reference:Content Events for Plugin System#onBeforeDisplay|onBeforeDisplay]] (content)
+
−
* [[Reference:Content Events for Plugin System#onBeforeDisplayContent|onBeforeDisplayContent]] (content)
+
−
* [[Reference:User Events for Plugin System#onBeforeStoreUser|onBeforeStoreUser]] (user)
+
−
* [[Reference:Editor Events for Plugin System#onCustomEditorButton|onCustomEditorButton]] (editors-xtd)
+
−
* [[Reference:Editor Events for Plugin System#onDisplay|onDisplay]] (editors)
+
−
* [[Reference:Editor Events for Plugin System#onGetContent|onGetContent]] (editors)
+
−
* [[Reference:Editor Events for Plugin System#onGetInsertMethod|onGetInsertMethod]] (editors)
+
−
* [[Reference:System Events for Plugin System#onGetWebServices|onGetWebServices]] (xmlrpc)
+
−
* [[Reference:Editor Events for Plugin System#onInit|onInit]] (editors)
+
−
* [[Reference:User Events for Plugin System#onLoginUser|onLoginFailure]] (user)
+
−
* [[Reference:User Events for Plugin System#onLogoutUser|onLogoutFailure]] (user)
+
−
* [[Reference:User Events for Plugin System#onLoginUser|onLoginUser]] (user)
+
−
* [[Reference:User Events for Plugin System#onLogoutUser|onLogoutUser]] (user)
+
−
* [[Reference:Content Events for Plugin System#onPrepareContent|onPrepareContent]] (content)
+
−
* [[Reference:Editor Events for Plugin System#onSave|onSave]] (editors)
+
−
* [[Reference:System Events for Plugin System#onSearch|onSearch]] (search)
+
−
* [[Reference:System Events for Plugin System#onSearchAreas|onSearchAreas]] (search)
+
−
* [[Reference:Editor Events for Plugin System#onSetContent|onSetContent]] (editors)
+
−
* [[Reference:Contact Events for Plugin System#onSubmitContact|onSubmitContact]] (contact)
+
−
* [[Reference:Contact Events for Plugin System#onValidateContact|onValidateContact]] (contact)
+
 
<noinclude>[[Category:Landing Pages]][[Category:Glossary]][[Category:Development]][[Category:Plugins]]</noinclude>
 
<noinclude>[[Category:Landing Pages]][[Category:Glossary]][[Category:Development]][[Category:Plugins]]</noinclude>

Revision as of 08:41, 14 July 2011

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 the Joomla! Framework. It also offers extension developers a way to allow other extensions to respond to their actions, making extensions extensible.

The Joomla! plugin architecture follows the Observer design pattern. The JPlugin class is derived from JObserver and provides the means to register custom plugin code with core or custom events. The JEventDispatcher class, derived from JObservable, is an event handler which calls all plugins registered for a particular event, when that event is triggered.

See also: Component, Module, Template

Joomla! plugins enable you to execute code in response to certain events, either Joomla! core events or custom events that are triggered from your own code. This is a powerful way of extending the basic Joomla! functionality. To see where plugins fit in with the overall Joomla! architecture, look at Framework overview.

The Joomla! plugin architecture follows the Observer design pattern. The JPlugin class is derived from JObserver and provides the means to register custom plugin code with core or custom events. The JEventDispatcher class, derived from JObservable, is an event handler which calls all plugins registered for a particular event, when that event is triggered.

Prior to Joomla! 1.5 plugins were known as mambots. Mambots were able to change content only and were based on certain signal words. Since then their scope has been stretched and extended to such an extent that to enhance the meaning of the new functionality the developers decided to change the name from mambots to plugins. Joomla! 1.5 includes legacy support for Joomla! 1.0 mambots.

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

Contents

Recommended Reading

Developers

For more developer information, see Plugin Development.


Events

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

Authentication

Captcha

Content

Contact

Editors

Extensions

Finder

Quick Icons

Search

System

User

XML-RPC

Retrieved from "http://docs.joomla.org/index.php?title=Plugin&oldid=60754"
Personal tools
Namespaces

Variants
Actions
Navigation
Joomla! Sites
Toolbox