Actions

Portal

Difference between revisions of "Plugin Development"

From Joomla! Documentation

m (Hutchy68 moved page Plugin Development to Portal:Plugin Development: navigational structure)
 
(8 intermediate revisions by one user not shown)
Line 1: Line 1:
{{browsebar|development}}
+
__TOC__
<div style="clear:both; width:100%">
+
{{/box-header-sq|<big>Introduction to {{PAGENAME}}</big>|{{FULLPAGENAME}}/Intro|}}
+
 
{{:{{FULLPAGENAME}}/Intro}}
 
{{:{{FULLPAGENAME}}/Intro}}
{{/box-footer|}}
+
<div class="large-7 column"> <!-- Switch to one column on narrow screens -->
 +
{{:{{FULLPAGENAME}}/Using Plugins}}
 
</div>
 
</div>
 
+
<div class="large-5 column panel radius" style="background:aliceblue;">
<div class="portal-column-left-wide">
+
<onlyinclude>{{:Portal:Plugin_Development/Reading list}}</onlyinclude>
{{/box-header-sq|Recommended Reading|{{FULLPAGENAME}}/Reading list|}}<onlyinclude>
+
{{:Plugin Development/Reading list}}</onlyinclude>
+
{{/box-footer|}}
+
 
</div>
 
</div>
  
<div class="portal-column-right-narrow"> <!-- Switch to one column on narrow screens -->
+
<div class="large-12 column panel radius" style="background:#fff;">
{{/box-header-sq|FAQs|{{FULLPAGENAME}}/FAQs|}}
+
{{:{{FULLPAGENAME}}/FAQs}}
+
{{/box-footer|}}
+
</div>
+
 
+
<div style="clear:both; width:100%">
+
 
+
{{/box-header-sq|Plugin Development Tutorials|{{FULLPAGENAME}}/Tutorials|}}
+
 
{{:{{FULLPAGENAME}}/Tutorials}}
 
{{:{{FULLPAGENAME}}/Tutorials}}
{{/box-footer|}}
 
 
</div>
 
</div>
 
+
{{-}}
<div style="clear:both; width:100%">
+
{{/box-header-sq|{{PAGENAME}} Documentation Projects|{{FULLPAGENAME}}/Projects|}}
+
 
{{:{{FULLPAGENAME}}/Projects}}
 
{{:{{FULLPAGENAME}}/Projects}}
{{/box-footer|}}
 
</div>
 
 
  
__NOTOC__ __NOEDITSECTION__
+
<noinclude>[[Category:Development]]  
<noinclude>[[Category:Development]][[Category:Plugins]]</noinclude>
+
[[Category:Plugin Development]]
 +
</noinclude>

Latest revision as of 15:13, 8 October 2013

Contents

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

Tip-icon.png
What is a Plugin?

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

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.

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.

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

Recommended Reading

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

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.

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.

Documentation all together tranparent small.png
Want or Need a New Article on Plugin Development?

To add a Red Link click here and add it to the Plugins Development Projects page. Please use the following wikimarkup code to add the suggested topic to the list:

*[[Put your Plugin Article name here]]

List of Red Links for needed Plugin Develepment Articles: