API16

JMenu/setActive: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 4: Line 4:




{{subst:Description:JMenu/setActive}}
 


===Syntax===
===Syntax===
Line 43: Line 43:




{{subst:SeeAlso:JMenu/setActive}}
 


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=setActive
  category=setActive
  category=JMenu
  category=JMenu
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*
  format= ,,,
  format= ,,,
</dpl>
</dpl>

Latest revision as of 01:54, 25 March 2017

Description

Set the default item by id



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;
}



Examples

Code Examples