API15

JApplication/getUserState: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 45: Line 45:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=getUserState
  category=getUserState
  category=JApplication
  category=JApplication
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 00:16, 25 March 2017

Description

Gets a user state.


<! removed transcluded page call, red link never existed >

Syntax

getUserState($key)
Parameter Name Default Value Description
$key The path of the state.

Returns

mixed The user state.

Defined in

libraries/joomla/application/application.php

Importing

jimport( 'joomla.application.application' );

Source Body

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


<! removed transcluded page call, red link never existed >

Examples

Code Examples