Actions

Difference between revisions of "Plugin"

From Joomla! Documentation

m (Changed the last of the links)
m (Plugins: Adding missing link to tutorials)
Line 5: Line 5:
 
The Joomla! plugin architecture follows the [[http://en.wikipedia.org/wiki/Observer_pattern|Observer]] design pattern.  The [[references:joomla.framework:application:jplugin|JPlugin]] class is derived from [[references:joomla.framework:base:jobserver|JObserver]] and provides the means to register custom plugin code with core or custom events.  The [[references:joomla.framework:application:jeventdispatcher|JEventDispatcher]] class, derived from [[references:joomla.framework:base:jobservable|JObservable]], is an event handler which calls all plugins registered for a particular event, when that event is triggered.
 
The Joomla! plugin architecture follows the [[http://en.wikipedia.org/wiki/Observer_pattern|Observer]] design pattern.  The [[references:joomla.framework:application:jplugin|JPlugin]] class is derived from [[references:joomla.framework:base:jobserver|JObserver]] and provides the means to register custom plugin code with core or custom events.  The [[references:joomla.framework:application:jeventdispatcher|JEventDispatcher]] class, derived from [[references:joomla.framework:base:jobservable|JObservable]], is an event handler which calls all plugins registered for a particular event, when that event is triggered.
  
   * [[plugins:create_plugin|How to create your own plugin]]
+
   * [[Tutorial:Creating_a_Plugin_for_Joomla_1.5]]
 +
  * [[How_to_create_a_content_plugin]]
 
   * [[plugins:using_plugins|How to use plugins in your own code]]
 
   * [[plugins:using_plugins|How to use plugins in your own code]]
   * [[plugins:plugins_part2|Creating an Authentication Plugin]]
+
   * [[Tutorial:Creating_an_Authentication_Plugin_for_Joomla_1.5]]
  
 
Useful reference: [[http://codex.gallery2.org/index.php/Gallery2:Embedding:Event-Based_Loose-Coupled_Integration|Gallery 2: Embedding: Event-Based Loose-Coupled Integration]]
 
Useful reference: [[http://codex.gallery2.org/index.php/Gallery2:Embedding:Event-Based_Loose-Coupled_Integration|Gallery 2: Embedding: Event-Based Loose-Coupled Integration]]
Line 15: Line 16:
 
[[Category:Development]]
 
[[Category:Development]]
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 +
 
======Events======
 
======Events======
 
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.

Revision as of 06:32, 3 September 2008

Plugins

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 [overview].

The Joomla! plugin architecture follows the [[1]] 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.

 * Tutorial:Creating_a_Plugin_for_Joomla_1.5
 * How_to_create_a_content_plugin
 * How to use plugins in your own code
 * Tutorial:Creating_an_Authentication_Plugin_for_Joomla_1.5

Useful reference: [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.

Events

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

 * System events
 * User events
 * Editor events
 * Content 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.

 *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)
 *onLoginUser (user)
 *onLogoutUser (user)
 *onPrepareContent (content)
 *onSave (editors)
 *onSearch (search)
 *onSearchAreas (search)
 *onSetContent (editors)