Actions

API16

JPluginHelper/getPlugin

From Joomla! Documentation

< API16:JPluginHelper
Revision as of 17:36, 22 March 2010 by Doxiki (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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.

[Edit Descripton]

Description:JPluginHelper/getPlugin

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

[Edit See Also] SeeAlso:JPluginHelper/getPlugin

Examples

<CodeExamplesForm />