API16

Difference between revisions of "JModuleHelper"

From Joomla! Documentation

(New page: <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki> </span> {{Description:JModuleHelper}} ===Defined ...)
 
m (preparing for archive only)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<span class="editsection" style="font-size:76%;">
+
[[JModuleHelper]] is a static helper class which provides functionality to handle modules.
<nowiki>[</nowiki>[[Description:JModuleHelper|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
{{Description:JModuleHelper}}
 
  
 
===Defined in===
 
===Defined in===
Line 27: Line 24:
 
|Get the path to a layout for a module
 
|Get the path to a layout for a module
 
|}
 
|}
 +
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.application.module.helper' );</source>
 
<source lang="php">jimport( 'joomla.application.module.helper' );</source>
  
<span class="editsection" style="font-size:76%;">
+
 
<nowiki>[</nowiki>[[SeeAlso:JModuleHelper|Edit See Also]]<nowiki>]</nowiki>
+
 
</span>
 
{{SeeAlso:JModuleHelper}}
 
  
 
===Examples===
 
===Examples===
<CodeExamplesForm />
+
=== Code Examples ===
 
<dpl>
 
<dpl>
 
  noresultsheader=\n
 
  noresultsheader=\n
 
  category=JModuleHelper
 
  category=JModuleHelper
  category=CodeExample
+
  namespace=CodeExample
 
  category=ClassExample
 
  category=ClassExample
 
  include=*
 
  include=*
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>

Latest revision as of 20:55, 24 March 2017

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

JModuleHelper is a static helper class which provides functionality to handle modules.

Defined in[edit]

libraries/joomla/application/module/helper.php

Methods[edit]

Method name Description
getModule Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs')
getModules Get modules by position
isEnabled Checks if a module is enabled
renderModule Render the module.
getLayoutPath Get the path to a layout for a module

Importing[edit]

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



Examples[edit]

Code Examples[edit]