API15

JDocumentRendererModules/render

From Joomla! Documentation

< API15:JDocumentRendererModules
Revision as of 11:46, 12 May 2013 by JoomlaWikiBot (talk | contribs) (removing red link to edit, no existant pages)

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

Description[edit]

Renders multiple modules script and returns the results as a string

[<! removed edit link to red link >]

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

Syntax[edit]

render($position, $params=array(), $content=null)
Parameter Name Default Value Description
$position $name The position of the modules to render
$params array() $params Associative array of values
$content null

Returns[edit]

string The output of the script

Defined in[edit]

libraries/joomla/document/html/renderer/modules.php

Importing[edit]

jimport( 'joomla.document.html.renderer.modules' );

Source Body[edit]

function render( $position, $params = array(), $content = null )
{
        $renderer =&  $this->_doc->loadRenderer('module');

        $contents = '';
        foreach (JModuleHelper::getModules($position) as $mod)  {
                $contents .= $renderer->render($mod, $params, $content);
        }
        return $contents;
}

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

Examples[edit]

<CodeExamplesForm />