JModuleHelper/getLayoutPath: Difference between revisions

Revision as of 18:37, 12 May 2013

Description

Get the path to a layout for a module

[<! removed edit link to red link >]

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

Syntax

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

function getLayoutPath($module, $layout = 'default')
{
        global $mainframe;

        // Build the template and base path for the layout
        $tPath = JPATH_BASE.DS.'templates'.DS.$mainframe->getTemplate().DS.'html'.DS.$module.DS.$layout.'.php';
        $bPath = JPATH_BASE.DS.'modules'.DS.$module.DS.'tmpl'.DS.$layout.'.php';

        // If the template has a layout override use it
        if (file_exists($tPath)) {
                return $tPath;
        } else {
                return $bPath;
        }
}

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

Examples

@@ Line 3: / Line 3: @@
 <span class="editsection" style="font-size:76%;">
-	<nowiki>[</nowiki>[[Description:JModuleHelper/getLayoutPath|Edit Descripton]]<nowiki>]</nowiki>
+	<nowiki>[<! removed edit link to red link >]</nowiki>
 </span>
-{{Description:JModuleHelper/getLayoutPath}}
+<! removed transcluded page call, red link never existed >
 ===Syntax===
@@ Line 54: / Line 54: @@
 <span class="editsection" style="font-size:76%;">
-	<nowiki>[</nowiki>[[SeeAlso:JModuleHelper/getLayoutPath|Edit See Also]]<nowiki>]</nowiki>
+	<nowiki>[<! removed edit link to red link >]</nowiki>
 </span>
-{{SeeAlso:JModuleHelper/getLayoutPath}}
+<! removed transcluded page call, red link never existed >
 ===Examples===
@@ Line 69: / Line 69: @@
   format= ,,,
 </dpl>
+[[Category:Archived pages API15]]

API15