Actions

Difference between revisions of "Plugin"

From Joomla! Documentation

m (Added category)
m (Learning More: update)
(One intermediate revision by one user not shown)
Line 1: Line 1:
<onlyinclude>{{Chunk:Plugin}}</onlyinclude>
+
__TOC__
 +
{{Chunk:Plugin}}
  
Useful reference: [http://codex.gallery2.org/index.php/Gallery2:Embedding:Event-Based_Loose-Coupled_Integration Gallery 2: Embedding: Event-Based Loose-Coupled Integration]
+
==Learning More==
  
==Recommended Reading==
+
<div class="large-5 column" style="background:white; border:none;">
 +
<div class="large-12 column panel radius" style="background:aliceblue;">
 +
{{:Plugin/Reading}}
 +
</div>
 +
</div>
 +
<div class="large-7 column">
 +
{{:Plugin/Using_Plugins}}
 +
</div>
  
===Developers===
+
[[Category:Extensions| Module]][[Category:Landing Pages]][[Category:Glossary]][[Category:JED]]
{{RecReading|Plugin|dev|audience}}
+
==Events==
+
{{:Plugin/Events}}
+
<noinclude>[[Category:Extensions| Plugin]][[Category:Landing Pages]][[Category:Glossary]][[Category:Development]][[Category:Plugins]]</noinclude>
+

Revision as of 09:01, 6 October 2013

Contents

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


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

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 events 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).