API16

API16:JMenu/setActive

From Joomla! Documentation

Revision as of 22:37, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Set the default item by id <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki> </s...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Set the default item by id

[Edit Descripton]

Template:Description:JMenu/setActive

Syntax

setActive($id)
Parameter Name Default Value Description
$id The item id

Returns

If successfull the active item, otherwise null

Defined in

libraries/joomla/application/menu.php

Importing

jimport( 'joomla.application.menu' );

Source Body

public function setActive($id)
{
        if (isset($this->_items[$id])) {
                $this->_active = $id;
                $result = &$this->_items[$id];
                return $result;
        }

        return null;
}

[Edit See Also] Template:SeeAlso:JMenu/setActive

Examples

<CodeExamplesForm />