API15:JModuleHelper/getModules
From Joomla! Documentation
Description
Get modules by position
Template:Description:JModuleHelper/getModules
Syntax
static& getModules($position)
| Parameter Name | Default Value | Description |
|---|---|---|
| $position | $position The position of the module |
Returns
array An array of module objects
Defined in
libraries/joomla/application/module/helper.php
Importing
jimport( 'joomla.application.module.helper' );
Source Body
public static function &getModules($position)
{
$app = &JFactory::getApplication();
$position = strtolower($position);
$result = array();
$modules = &JModuleHelper::_load();
$total = count($modules);
for ($i = 0; $i < $total; $i++)
{
if ($modules[$i]->position == $position) {
$result[] = &$modules[$i];
}
}
if (count($result) == 0)
{
if ($app->getCfg('debug_modules') && JRequest::getBool('tp'))
{
$result[0] = JModuleHelper::getModule('mod_'.$position);
$result[0]->title = $position;
$result[0]->content = $position;
$result[0]->position = $position;
}
}
return $result;
}
[Edit See Also] Template:SeeAlso:JModuleHelper/getModules
Examples
<CodeExamplesForm />