JApplication/setUserState

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]

Sets the value of a user state variable.

[Edit Descripton]

Template:Description:JApplication/setUserState

Syntax[edit]

setUserState($key, $value)

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

Returns[edit]

mixed The previous state, if one existed.

Defined in[edit]

libraries/joomla/application/application.php

Importing[edit]

jimport( 'joomla.application.application' );

Source Body[edit]

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

Examples[edit]

API15