API16:JApplication/setUserState

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

Sets the value of a user state variable.

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

Syntax

setUserState($key, $value)

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

Returns

mixed The previous state, if one existed.

Defined in

libraries/joomla/application/application.php

Importing

jimport( 'joomla.application.application' );

Source Body

public function setUserState($key, $value)
{
        $session        = &JFactory::getSession();
        $registry       = &$session->get('registry');
        if (!is_null($registry)) {
                return $registry->setValue($key, $value);
        }
        return null;
}

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

Examples

<CodeExamplesForm />