Actions

API15

JPluginHelper/getPlugin

From Joomla! Documentation

< API15:JPluginHelper
Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Get the plugin data of a specific type if no specific plugin is specified otherwise only the specific plugin data is returned

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

& 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

function &getPlugin($type, $plugin = null)
{
        $result = array();
 
        $plugins = JPluginHelper::_load();
 
        $total = count($plugins);
        for($i = 0; $i < $total; $i++)
        {
                if(is_null($plugin))
                {
                        if($plugins[$i]->type == $type) {
                                $result[] = $plugins[$i];
                        }
                }
                else
                {
                        if($plugins[$i]->type == $type && $plugins[$i]->name == $plugin) {
                                $result = $plugins[$i];
                                break;
                        }
                }
 
        }
 
        return $result;
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />