Actions

API15

JPluginHelper/importPlugin

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

Loads all the plugin files for a particular type if no specific plugin is specified otherwise only the specific pugin is loaded.

[<! removed edit link to red link >]

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

Syntax

importPlugin($type, $plugin=null, $autocreate=true, $dispatcher=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
$autocreate true
$dispatcher null

Returns

boolean True if success

Defined in

libraries/joomla/plugin/helper.php

Importing

jimport( 'joomla.plugin.helper' );

Source Body

function importPlugin($type, $plugin = null, $autocreate = true, $dispatcher = null)
{
        $result = false;
 
        $plugins = JPluginHelper::_load();
 
        $total = count($plugins);
        for($i = 0; $i < $total; $i++) {
                if($plugins[$i]->type == $type && ($plugins[$i]->name == $plugin ||  $plugin === null)) {
                        JPluginHelper::_import( $plugins[$i], $autocreate, $dispatcher );
                        $result = true;
                }
        }
 
        return $result;
}

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

Examples

<CodeExamplesForm />