API16:JModuleHelper/getLayoutPath

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.

Description

Get the path to a layout for a module

Syntax

static getLayoutPath($module, $layout= 'default')

Parameter Name	Default Value	Description
$module		$module The name of the module
$layout	'default'	$layout The name of the module layout

Returns

string The path to the module layout

Defined in

libraries/joomla/application/module/helper.php

Importing

jimport( 'joomla.application.module.helper' );

Source Body

public static function getLayoutPath($module, $layout = 'default')
{
        $app = JFactory::getApplication();
 
        // Build the template and base path for the layout
        $tPath = JPATH_BASE.'/templates/'.$app->getTemplate().'/html/'.$module.'/'.$layout.'.php';
        $bPath = JPATH_BASE.'/modules/'.$module.'/tmpl/'.$layout.'.php';
 
        // If the template has a layout override use it
        if (file_exists($tPath)) {
                return $tPath;
        }
        else {
                return $bPath;
        }
}

Examples

<CodeExamplesForm />