API17:JApplication::getUserStateFromRequest
From Joomla! Documentation
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.
JApplication::getUserStateFromRequest
Description
Gets the value of a user state variable.
Description:JApplication::getUserStateFromRequest [Edit Descripton]
Since
Synopsis
public JApplication->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 in
libraries/joomla/application/application.php
Referenced by
See also
SeeAlso:JApplication::getUserStateFromRequest
Examples
<CodeExamplesForm />
