Actions

Difference between revisions of "Plugin"

From Joomla! Documentation

m
m (revert)
(41 intermediate revisions by 14 users not shown)
Line 1: Line 1:
[[Category:Development]]
+
<noinclude><languages /></noinclude>
====== Plugins ======
+
<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 [[http://dev.joomla.org/content/view/1137/80/|Framework overview]].
+
<!--T:1-->
 +
{{Chunk:Plugin/en}}
  
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.
+
==Learning More== <!--T:2-->
  
  * [[plugins:create_plugin|How to create your own plugin]]
+
===Beginner=== <!--T:3-->
  * [[plugins:using_plugins|How to use plugins in your own code]]
+
To understand how to install and use a plugin in Joomla it is recommended to read [[Administration of a Plugin in Joomla]]
  * [[plugins:plugins_part2|Creating an Authentication Plugin]]
+
  
Useful reference: [[http://codex.gallery2.org/index.php/Gallery2:Embedding:Event-Based_Loose-Coupled_Integration|Gallery 2: Embedding: Event-Based Loose-Coupled Integration]]
+
===Intermediate=== <!--T:4-->
 +
To understand plugins better, you should [[S:MyLanguage/Creating_a_Plugin_for_Joomla|create a basic plugin for Joomla!]].
  
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.
+
<!--T:5-->
 +
If you have a basic content plugin in a custom module or component, we recommended reading [[Triggering content plugins in your extension]].
  
======Events======
+
===Advanced=== <!--T:6-->
Joomla! ships with a variety of core events, organised into groups. These are described in the following topics.
+
To understand the principles on which the Plugin system works  [[Plugin Developer Overview]]. To then implement this in a component you have designed it is recommended to read [[Supporting plugins in your component]].
  
  * [[plugins:system_events|System events]]
+
==Using Plugins== <!--T:7-->
  * [[plugins:user_events|User events]]
+
  * [[plugins:editor_events|Editor events]]
+
  * [[plugins:content_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.
+
<!--T:8-->
 +
Plugins are grouped together depending on which event they run on. A full list of plugins grouped by event type can be found [[Plugin/Events|here]] (the names of a lot of events changed between {{JVer|1.5}} and {{JVer|2.5}} see [[J2.5:Adapting_a_Joomla_1.5_extension_to_Joomla_2.5#Renamed_Events|here]] for a full list of changes). There are also several simple tutorials on making some sample plugins running on some of these events to help running searches on extensions using both the search and smart search components:
  
  *[[plugins:user_events#onAfterDeleteUser|onAfterDeleteUser]] (user)
+
<!--T:9-->
  *[[plugins:content_events#onAfterDisplay|onAfterDisplay]] (content)
+
* [[Creating a search plugin]]
  *[[plugins:content_events#onAfterDisplayTitle|onAfterDisplayTitle]] (content)
+
* [[Creating a Smart Search plug-in]] ({{JVer|2.5}} only)
  *[[plugins:content_events#onAfterDisplayContent|onAfterDisplayContent]] (content)
+
 
  *[[plugins:system_events#onAfterInitialise|onAfterInitialise]] (system)
+
<!--T:10-->
  *[[plugins:system_events#onAfterRoute|onAfterRoute]] (system)
+
There are further tutorials using the user triggers on how to create an authentication plugin to help users log into Joomla and creating a profile plugin for Joomla.
  *[[plugins:system_events#onAfterDispatch|onAfterDispatch]] (system)
+
 
  *[[plugins:system_events#onAfterRender|onAfterRender]] (system)
+
<!--T:11-->
  *[[plugins:user_events#onAfterStoreUser|onAfterStoreUser]] (user)
+
* [[Creating an Authentication Plugin for Joomla]]
  *[[plugins:user_events#onAuthenticate|onAuthenticate]] (authentication)
+
* [[Creating a profile plugin]]
  *[[plugins:user_events#onAuthenticateFailure|onAuthenticateFailure]] (authentication)
+
 
  *[[plugins:user_events#onBeforeDeleteUser|onBeforeDeleteUser]] (user)
+
<!--T:12-->
  *[[plugins:content_events#onBeforeDisplay|onBeforeDisplay]] (content)
+
A more complex example of [[Creating a System Plugin to augment JRouter|using plugins to create a new system router]] to produce URLs is also available ({{JVer|2.5}} only).
  *[[plugins:content_events#onBeforeDisplayContent|onBeforeDisplayContent]] (content)
+
 
  *[[plugins:user_events#onBeforeStoreUser|onBeforeStoreUser]] (user)
+
<!--T:13-->
  *[[plugins:editor_events#onCustomEditorButton|onCustomEditorButton]] (editors-xtd)
+
[[Category:Extensions]][[Category:Landing Pages]][[Category:Glossary]][[Category:JED]]
  *[[plugins:editor_events#onDisplay|onDisplay]] (editors)
+
</translate>
  *[[plugins:editor_events#onGetContent|onGetContent]] (editors)
+
  *[[plugins:editor_events#onGetInsertMethod|onGetInsertMethod]] (editors)
+
  *[[plugins:system_events#onGetWebServices|onGetWebServices]] (xmlrpc)
+
  *[[plugins:editor_events#onInit|onInit]] (editors)
+
  *[[plugins:user_events#onLoginUser|onLoginUser]] (user)
+
  *[[plugins:user_events#onLogoutUser|onLogoutUser]] (user)
+
  *[[plugins:content_events#onPrepareContent|onPrepareContent]] (content)
+
  *[[plugins:editor_events#onSave|onSave]] (editors)
+
  *[[plugins:system_events#onSearch|onSearch]] (search)
+
  *[[plugins:system_events#onSearchAreas|onSearchAreas]] (search)
+
  *[[plugins:editor_events#onSetContent|onSetContent]] (editors)
+

Revision as of 20:07, 16 July 2014

Other languages: català 57% • ‎English 100% • ‎español 100% • ‎français 100% • ‎Bahasa Indonesia 100% • ‎日本語 100% • ‎Nederlands 100% • ‎Kiswahili 100%

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! Platform. 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 provides the means to register custom plugin code with core or custom events. The JDispatcher class (JEventDispatcher in Joomla 3.x) is an event handler which calls all plugins registered for a particular event, when that event is triggered.

See also: Component, Module, Template


Contents

Learning More

Beginner

To understand how to install and use a plugin in Joomla it is recommended to read Administration of a Plugin in Joomla

Intermediate

To understand plugins better, you should create a basic plugin for Joomla!.

If you have a basic content plugin in a custom module or component, we recommended reading Triggering content plugins in your extension.

Advanced

To understand the principles on which the Plugin system works Plugin Developer Overview. To then implement this in a component you have designed it is recommended to read Supporting plugins in your component.

Using Plugins

Plugins are grouped together depending on which event they run on. A full list of plugins grouped by event type can be found here (the names of a lot of events changed between Joomla 1.5 and Joomla 2.5 see here for a full list of changes). There are also several simple tutorials on making some sample plugins running on some of these events to help running searches on extensions using both the search and smart search components:

There are further tutorials using the user triggers on how to create an authentication plugin to help users log into Joomla and creating a profile plugin for Joomla.

A more complex example of using plugins to create a new system router to produce URLs is also available (Joomla 2.5 only).