JApplication/setUserState: Difference between revisions
From Joomla! Documentation
New page: ===Description===
Sets the value of a user state variable.
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JApplication/setUserState|Edit Descripton]... |
m preparing for archive only |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
Sets the value of a user state variable. | Sets the value of a user state variable. | ||
<! removed transcluded page call, red link never existed > | |||
===Syntax=== | ===Syntax=== | ||
| Line 47: | Line 45: | ||
</source> | </source> | ||
<! removed transcluded page call, red link never existed > | |||
< | |||
===Examples=== | ===Examples=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=setUserState | category=setUserState | ||
category=JApplication | category=JApplication | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API16]] | |||
Latest revision as of 01:18, 25 March 2017
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
Code Examples