API15

JApplication/getUserState

From Joomla! Documentation

< API15:JApplication

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]

Gets a user state.


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

Syntax[edit]

getUserState($key)
Parameter Name Default Value Description
$key The path of the state.

Returns[edit]

mixed The user state.

Defined in[edit]

libraries/joomla/application/application.php

Importing[edit]

jimport( 'joomla.application.application' );

Source Body[edit]

function getUserState( $key )
{
        $session        =& JFactory::getSession();
        $registry       =& $session->get('registry');
        if(!is_null($registry)) {
                return $registry->getValue($key);
        }
        return null;
}


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

Examples[edit]

Code Examples[edit]