Plugin/en

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.

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

See also: Component, Module, Template

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. For developer reference there is a full list of plugins grouped by their event type. Please note, the names of a lot of events changed between the Joomla 1.5 and Joomla 2.5 versions. Here is a full list of the 1.5 to 2.5 plugin event name 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.

• Creating an Authentication Plugin for Joomla
• Creating a profile plugin

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