API15

JPluginHelper/getPlugin: Difference between revisions

From Joomla! Documentation

m removing red link to edit, no existant pages
m preparing for archive only
 
Line 71: Line 71:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=getPlugin
  category=getPlugin
  category=JPluginHelper
  category=JPluginHelper
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 01:02, 25 March 2017

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

Code Examples