Actions

API15

JApplication/setUserState

From Joomla! Documentation

< API15:JApplication
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

Sets the value of a user state variable.

[<! removed edit link to red link >]

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

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

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

Examples

<CodeExamplesForm />