API16

JModuleHelper/getLayoutPath: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 4: Line 4:




{{subst:Description:JModuleHelper/getLayoutPath}}
 


===Syntax===
===Syntax===
Line 53: Line 53:




{{subst:SeeAlso:JModuleHelper/getLayoutPath}}
 


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=getLayoutPath
  category=getLayoutPath
  category=JModuleHelper
  category=JModuleHelper
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*
  format= ,,,
  format= ,,,
</dpl>
</dpl>

Latest revision as of 01:55, 25 March 2017

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

Code Examples