Difference between revisions of "Plugin"

Revision as of 09:01, 6 October 2013

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

Learning More[edit]

Beginner[edit]

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

Intermediate[edit]

To understand plugins better it is advised that you create a basic plugin for Joomla!.

It is also advised to read on how to run a basic content plugin in a custom module or component you may have already developed it is recommended to read Triggering content plugins in your extension.

Advanced[edit]

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[edit]

Plugins are grouped together depending on which event they run on. A full list of events grouped by event type can be found here (the names of a lot of events changed between and 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:

Creating a search plugin
Creating a Smart Search plug-in ( only)

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 ( only).

@@ Line 1: / Line 1: @@
-[[Category:Bin]]
+__TOC__
-====== Plugins ======
+{{Chunk:Plugin}}
-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]].
-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==
-  * [[plugins:create_plugin|How to create your own plugin]]
+<div class="large-5 column" style="background:white; border:none;">
-  * [[plugins:using_plugins|How to use plugins in your own code]]
+<div class="large-12 column panel radius" style="background:aliceblue;">
-  * [[plugins:plugins_part2|Creating an Authentication Plugin]]
+{{:Plugin/Reading}}
+</div>
+</div>
+<div class="large-7 column">
+{{:Plugin/Using_Plugins}}
+</div>
-Useful reference: [[http://codex.gallery2.org/index.php/Gallery2:Embedding:Event-Based_Loose-Coupled_Integration|Gallery 2: Embedding: Event-Based Loose-Coupled Integration]]
+[[Category:Extensions| Module]][[Category:Landing Pages]][[Category:Glossary]][[Category:JED]]
-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.
-  * [[plugins:system_events|System events]]
-  * [[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.
-  *[[plugins:user_events#onAfterDeleteUser|onAfterDeleteUser]] (user)
-  *[[plugins:content_events#onAfterDisplay|onAfterDisplay]] (content)
-  *[[plugins:content_events#onAfterDisplayTitle|onAfterDisplayTitle]] (content)
-  *[[plugins:content_events#onAfterDisplayContent|onAfterDisplayContent]] (content)
-  *[[plugins:system_events#onAfterInitialise|onAfterInitialise]] (system)
-  *[[plugins:system_events#onAfterRoute|onAfterRoute]] (system)
-  *[[plugins:system_events#onAfterDispatch|onAfterDispatch]] (system)
-  *[[plugins:system_events#onAfterRender|onAfterRender]] (system)
-  *[[plugins:user_events#onAfterStoreUser|onAfterStoreUser]] (user)
-  *[[plugins:user_events#onAuthenticate|onAuthenticate]] (authentication)
-  *[[plugins:user_events#onAuthenticateFailure|onAuthenticateFailure]] (authentication)
-  *[[plugins:user_events#onBeforeDeleteUser|onBeforeDeleteUser]] (user)
-  *[[plugins:content_events#onBeforeDisplay|onBeforeDisplay]] (content)
-  *[[plugins:content_events#onBeforeDisplayContent|onBeforeDisplayContent]] (content)
-  *[[plugins:user_events#onBeforeStoreUser|onBeforeStoreUser]] (user)
-  *[[plugins:editor_events#onCustomEditorButton|onCustomEditorButton]] (editors-xtd)
-  *[[plugins:editor_events#onDisplay|onDisplay]] (editors)
-  *[[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)