Actions

API15

JApplication/getUserState

From Joomla! Documentation

< API15:JApplication
Revision as of 07:33, 12 May 2013 by JoomlaWikiBot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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

Gets a user state.

[<! removed edit link to red link >]

<! 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

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

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

Examples

<CodeExamplesForm />