API16:JPluginHelper/getPlugin
From Joomla! Documentation
Description
Get the plugin data of a specific type if no specific plugin is specified otherwise only the specific plugin data is returned.
Syntax
static getPlugin($type, $plugin=null)
| Parameter Name | Default Value | Description |
|---|---|---|
| $type | $type The plugin type, relates to the sub-directory in the plugins directory. | |
| $plugin | null | $plugin The plugin name. |
Returns
mixed An array of plugin data objects, or a plugin data object.
Defined in
libraries/joomla/plugin/helper.php
Importing
jimport( 'joomla.plugin.helper' );
Source Body
public static function getPlugin($type, $plugin = null)
{
$result = array();
$plugins = self::_load();
// Find the correct plugin(s) to return.
for ($i = 0, $t = count($plugins); $i < $t; $i++)
{
// Are we loading a single plugin or a group?
if (is_null($plugin))
{
// Is this the right plugin?
if ($plugins[$i]->type == $type) {
$result[] = $plugins[$i];
}
}
else
{
// Is this plugin in the right group?
if ($plugins[$i]->type == $type && $plugins[$i]->name == $plugin) {
$result = $plugins[$i];
break;
}
}
}
return $result;
}
Examples
Code Examples