Plugin: Difference between revisions

Revision as of 22:58, 30 January 2011

<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>

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

<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

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

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.

onAfterContentSave (content)
onAfterDeleteUser (user)
onAfterDisplay (content)
onAfterDisplayTitle (content)
onAfterDisplayContent (content)
onAfterInitialise (system)
onAfterRoute (system)
onAfterDispatch (system)
onAfterRender (system)
onAfterStoreUser (user)
onAuthenticate (authentication)
onAuthenticateFailure (authentication)
onBeforeContentSave (content)
onBeforeDeleteUser (user)
onBeforeDisplay (content)
onBeforeDisplayContent (content)
onBeforeStoreUser (user)
onCustomEditorButton (editors-xtd)
onDisplay (editors)
onGetContent (editors)
onGetInsertMethod (editors)
onGetWebServices (xmlrpc)
onInit (editors)
onLoginFailure (user)
onLogoutFailure (user)
onLoginUser (user)
onLogoutUser (user)
onPrepareContent (content)
onSave (editors)
onSearch (search)
onSearchAreas (search)
onSetContent (editors)
onSubmitContact (contact)
onValidateContact (contact)

@@ Line 5: / Line 5: @@
 The Joomla! plugin architecture follows the [http://en.wikipedia.org/wiki/Observer_pattern 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.
-* [[Creating a Plugin for Joomla 1.5]]
+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.
-* [[Creating a content plugin]]
-* [[Creating a search plugin]]
-* [[Creating an Authentication Plugin for Joomla 1.5]]
-* [[Using plugins in your own extension]]
 Useful reference: [http://codex.gallery2.org/index.php/Gallery2:Embedding:Event-Based_Loose-Coupled_Integration Gallery 2: Embedding: Event-Based Loose-Coupled Integration]
-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.
+==Recommended Reading==
+===Developers===
+{{RecReading|Plugin|dev|audience}}
 ==Events==