Difference between revisions of "JApplication::getUserStateFromRequest"
From Joomla! Documentation
(Bulk upload by Doxiki2) |
m (preparing for archive only) |
||
(6 intermediate revisions by 2 users not shown) | |||
Line 4: | Line 4: | ||
Gets the value of a user state variable. | Gets the value of a user state variable. | ||
− | + | ||
− | + | ||
− | |||
− | |||
− | |||
− | |||
− | |||
<source lang="php"> | <source lang="php"> | ||
− | public | + | public function getUserStateFromRequest ( |
+ | $key | ||
+ | $request | ||
+ | $default=null | ||
+ | $type= 'none' | ||
+ | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 42: | Line 42: | ||
|- | |- | ||
|} | |} | ||
− | + | * '''Returns''' The request user state. | |
− | The request user state. | + | * '''Defined''' on line 515 of libraries/joomla/application/application.php |
− | + | * '''Since''' {{JVer|11.1 }} | |
− | libraries/joomla/application/application.php | ||
− | |||
===See also=== | ===See also=== | ||
− | + | * {{JVer|11.1}} '''JApplication::getUserStateFromRequest source code''' on [[jplatform:application/application.php#cl-507|BitBucket]] | |
− | + | * {{JVer|11.1}} Class [[API17:JApplication|JApplication]] | |
− | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage_Application|Application]] | |
− | * | + | * [[API17:JApplication::getUserStateFromRequest|Other versions of JApplication::getUserStateFromRequest]] |
− | * [[JApplication::getUserStateFromRequest|Other versions of | + | |
− | + | ||
− | ===Examples=== | + | ===User contributed notes=== |
− | + | === Code Examples === | |
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JApplication::getUserStateFromRequest | category=JApplication::getUserStateFromRequest | ||
− | + | namespace=CodeExample | |
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
+ | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
− | <noinclude>[[Category: | + | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> |
Latest revision as of 21:19, 24 March 2017
The "API17" 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.
JApplication::getUserStateFromRequest[edit]
Description[edit]
Gets the value of a user state variable.
public function getUserStateFromRequest (
$key
$request
$default=null
$type= 'none'
)
Parameter | Type | Default | Description |
---|---|---|---|
$key | string | The key of the user state variable. | |
$request | string | The name of the variable passed in a request. | |
$default | string | null | The default value for the variable if not found. Optional. |
$type | string | 'none' | Filter for the variable, for valid values see . Optional. |
- Returns The request user state.
- Defined on line 515 of libraries/joomla/application/application.php
- Since
See also[edit]
- JApplication::getUserStateFromRequest source code on BitBucket
- Class JApplication
- Subpackage Application
- Other versions of JApplication::getUserStateFromRequest
User contributed notes[edit]
Code Examples[edit]