Joomla! Docs

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.

Description

Gets a user state.

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

Syntax

getUserState($key)

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

Returns

mixed The user state.

Defined in

libraries/joomla/application/application.php

Importing

jimport( 'joomla.application.application' );

Source Body

public 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

<CodeExamplesForm />