Joomla! Documentation™

Description

Load a helper file

Syntax

loadHelper($hlp=null)

Parameter Name	Default Value	Description
$hlp	null	The name of the helper source file ... automatically searches the helper paths and compiles as needed.

Returns

boolean Returns true if the file was loaded

Defined in

libraries/joomla/application/component/view.php

Importing

jimport( 'joomla.application.component.view' );

Source Body

function loadHelper($hlp = null)
{
        // clean the file name
        $file = preg_replace('/[^A-Z0-9_\.-]/i', '', $hlp);

        // load the template script
        jimport('joomla.filesystem.path');
        $helper = JPath::find($this->_path['helper'], $this->_createFileName('helper', array('name' => $file)));

        if ($helper != false)
        {
                // include the requested template filename in the local scope
                include_once $helper;
        }
}