Actions

API15

JMenu/setActive

From Joomla! Documentation

< API15:JMenu
Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Set the default item by id

[<! removed edit link to red link >]

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

Syntax

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

Returns

If successfull the active item, otherwise null

Defined in

libraries/joomla/application/menu.php

Importing

jimport( 'joomla.application.menu' );

Source Body

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

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

Examples

<CodeExamplesForm />