Portal:Plugin Development

Plugin Development

This page contains many links to documentation concerning Plugin Development for and . A good place to start is with the Reading list articles below as they provide a good introductory base of knowledge to build on.

What is a Plugin?

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

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

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

Content plugins can be used to add custom fields to core components. The following tutorial explains how to do this and how to display the new field on your webite.

• Adding custom fields to core components using a plugin

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

Reading list

The following articles will help familiarise you with Joomla! plugins. They are a good starting point to understanding and then developing plugins.

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

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.

Tutorials

Below is a list of all articles belonging to the categories "Tutorials" AND "Plugin Development" within Joomla! Documentation.

• Accessing the current user object
• Adapting a Joomla! 1.5 extension to Joomla! 2.5
• Adding custom fields to core components using a plugin
• Creating a Plugin for Joomla!
• Creating a Plugin for Joomla!
• Creating a System Plugin to augment JRouter

• Creating a profile plugin
• Creating a search plugin
• Creating an Authentication Plugin for Joomla!
• Creating an Authentication Plugin for Joomla!
• Extension Installer
• Plugin/Events

Plugin Development Articles Needed

The Joomla! Documentation Wiki needs your help! Below is a list of pages/articles needed for Plugin Development. If you know of a topic which needs to be addressed, just add it to the List of Red Links below by using the following wikimarkup.

Want or Need a New Article on Plugin Development?

*[[Put your Plugin Article name here]]

List of Red Links for needed Plugin Development Articles: