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 removing red link to edit, no existant pages |
||
| Line 3: | Line 3: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Syntax=== | ===Syntax=== | ||
| Line 48: | Line 48: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Examples=== | ===Examples=== | ||
| Line 63: | Line 63: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API16]] | |||
Revision as of 02:48, 13 May 2013
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
public 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 />