API16

API16:JComponentHelper/getParams

From Joomla! Documentation

Revision as of 22:35, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Gets the parameter object for the component <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>[[Description:JComponentHelper/getParams|Edit Descrip...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Gets the parameter object for the component

[Edit Descripton]

Template:Description:JComponentHelper/getParams

Syntax

static getParams($option, $strict=false)
Parameter Name Default Value Description
$option The option for the component.
$strict false If set and a component does not exist, false will be returned

Returns

As of 1.6, this method returns a  (previous versions returned ). 

Defined in

libraries/joomla/application/component/helper.php

Importing

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

Source Body

public static function getParams($option, $strict = false)
{
        $component = &self::getComponent($option, $strict);
        return $component->params;
}

[Edit See Also] Template:SeeAlso:JComponentHelper/getParams

Examples

<CodeExamplesForm />