View source for Creating a Plugin for Joomla

=== Creating the Plugin === <!--T:9-->
The object-oriented way of writing plugins involves writing a subclass of [http://api.joomla.org/Joomla-Platform/Plugin/JPlugin.html JPlugin], a base class that implements the basic properties of plugins. In your methods, the following properties are available:
</translate>

<translate>
<!--T:10-->
* <code>$this->params</code>: the [[S:MyLanguage/Parameter|parameters]] set for this plugin by the administrator
* <code>$this->_name</code>: the name of the plugin
* <code>$this->_type</code>: the [[S:MyLanguage/Plugin/Events|group (type)]] of the plugin
* <code>$this->db</code>: the db object (since {{JVer|3.1}})
* <code>$this->app</code>: the application object (since {{JVer|3.1}})
'''Tip''' To use <code>$this->db</code> and <code>$this->app</code>, <code>JPlugin</code> tests if the property exists and is not private. If it is desired for the default objects to be used, create un-instantiated properties in the plugin class (i.e. <code>protected $db; protected $app;</code> in the same area as <code>protected $autoloadLanguage = true;</code>). The properties will not exist unless explicitly created.
</translate>

<translate>
<!--T:11-->
In the following code example, <code><PluginGroup></code> represents the [[S:MyLanguage/Plugin/Events|group (type)]] of the plugin, and <code><PluginName></code> represents its name. Note that class and function names in PHP are case-insensitive. The name must correspond with the <code>plugin</code> attribute of the <code>filename<code> element in the XML configuration that points at the plugin php file.
</translate>

<source lang="php">
<?php
// no direct access
defined( '_JEXEC' ) or die;

class plg<PluginGroup><PluginName> extends JPlugin
{
	/**
	 * Load the language file on instantiation. Note this is only available in Joomla 3.1 and higher.
	 * If you want to support 3.0 series you must override the constructor
	 *
	 * @var    boolean
	 * @since  3.1
	 */
	protected $autoloadLanguage = true;

	/**
	 * Plugin method with the same name as the event will be called automatically.
	 */
	 function <EventName>()
	 {
		/*
		 * Plugin code goes here.
		 * You can access database and application objects and parameters via $this->db,
		 * $this->app and $this->params respectively
		 */
		return true;
	}
}
?>
</source>

<translate>