API17

Difference between revisions of "JModuleHelper::getModule"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JModuleHelper::getModule|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JModuleHelper::getModule|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public & JModuleHelper::getModule ($name, $title=null)
+
public & function getModule (
 +
        $name
 +
        $title=null
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 30: Line 32:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' object The Module object
object The Module object
+
* '''Defined''' on line 34 of libraries/joomla/application/module/helper.php
===Defined in===
+
* '''Referenced by'''
libraries/joomla/application/module/helper.php (line 34)
+
** [[getModules/11.1|getModules]]
* see source code in [[jplatform:application/module/helper.php#cl-34|BitBucket]]
+
** [[isEnabled/11.1|isEnabled]]
===Referenced by===
+
** [[JDocumentRendererModule::render/11.1|JDocumentRendererModule::render]]
* [[getModules/11.1|getModules]]
 
* [[isEnabled/11.1|isEnabled]]
 
* [[JDocumentRendererModule::render/11.1|JDocumentRendererModule::render]]
 
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JModuleHelper::getModule source code''' on [[jplatform:application/module/helper.php#cl-26|BitBucket]]
 +
* {{JVer|11.1}} Class [[JModuleHelper/11.1|JModuleHelper]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
 +
* [[JModuleHelper::getModule|Other versions of JModuleHelper::getModule]]
 +
{{SeeAlso:JModuleHelper::getModule}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JModuleHelper::getModule|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JModuleHelper::getModule|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JModuleHelper/11.1|JModuleHelper]]
+
===User contributed notes===
* [[JModuleHelper::getModule|Other versions of this method]]
 
{{SeeAlso:JModuleHelper::getModule}}
 
===Examples===
 
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 54: Line 55:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JModuleHelper]][[Category:JModuleHelper::getModule]]</noinclude>
 
<noinclude>[[Category:JModuleHelper]][[Category:JModuleHelper::getModule]]</noinclude>

Revision as of 21:25, 27 April 2011

The "API17" 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.

Joomla 11.1 JModuleHelper::getModule[edit]

Description[edit]

Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs').

Template:Description:JModuleHelper::getModule [Edit Descripton]

public & function getModule (
        $name
        $title=null
)
Parameter Type Default Description
$name string The name of the module
$title string null The title of the module, optional

See also[edit]

Template:SeeAlso:JModuleHelper::getModule [Edit See Also]

User contributed notes[edit]

<CodeExamplesForm />