Actions

API16

JPluginHelper/importPlugin

From Joomla! Documentation

< API16: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.

[Edit Descripton]

Description:JPluginHelper/importPlugin

Syntax

static 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

public static function importPlugin($type, $plugin = null, $autocreate = true, $dispatcher = null)
{
        $results = null;
 
        // Load the plugins from the database.
        $plugins = self::_load();
 
        // Get the specified plugin(s).
        for ($i = 0, $t = count($plugins); $i < $t; $i++) {
                if ($plugins[$i]->type == $type && ($plugins[$i]->name == $plugin ||  $plugin === null)) {
                        self::_import($plugins[$i], $autocreate, $dispatcher);
                        $results = true;
                }
        }
 
        return $results;
}

[Edit See Also] SeeAlso:JPluginHelper/importPlugin

Examples

<CodeExamplesForm />