API15

API15:JPluginHelper/getPlugin

From Joomla! Documentation

Revision as of 22:10, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Get the plugin data of a specific type if no specific plugin is specified otherwise only the specific plugin data is returned <span class="editsection" style="font-siz...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

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

[Edit Descripton]

Template:Description:JPluginHelper/getPlugin

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;
}

[Edit See Also] Template:SeeAlso:JPluginHelper/getPlugin

Examples

<CodeExamplesForm />