JFactory/getUser
From Joomla! Documentation
< JFactory(Difference between revisions)
(New page: Returns a reference to the global user object, only creating it if it doesn't already exist. The object returned will be of type JUser. ===Syntax=== object JUser getUser( $id ) w...) |
m (→See also: Updated API link) |
||
| Line 53: | Line 53: | ||
===See also=== | ===See also=== | ||
| − | * [http://api.joomla.org/Joomla- | + | * [http://api.joomla.org/Joomla-Platform/JFactory.html#getUser JFactory->getUser on api.joomla.org] |
* [[JUser]] | * [[JUser]] | ||
<noinclude>[[Category:Development]][[Category:Framework]][[Category:JFactory]]</noinclude> | <noinclude>[[Category:Development]][[Category:Framework]][[Category:JFactory]]</noinclude> | ||
Latest revision as of 12:55, 30 November 2012
Returns a reference to the global user object, only creating it if it doesn't already exist. The object returned will be of type JUser.
Contents |
[edit] Syntax
object JUser getUser( $id )
where:
| Argument | Data type | Description | Default |
|---|---|---|---|
| $id | integer or string | The user to load. If a string is passed then it will be interpreted as a user name and converted to an integer id automatically. If the argument is omitted or is null then the current user will loaded. | null |
[edit] Example 1
In this example, some information about the current logged in user is displayed, but only when the user is actually logged in.
$user =& JFactory::getUser(); if (!$user->guest) { echo 'You are logged in as:<br />'; echo 'User name: ' . $user->username . '<br />'; echo 'Real name: ' . $user->name . '<br />'; echo 'User ID : ' . $user->id . '<br />'; }
[edit] Example 2
In this example, information about a specific user, with username 'joebloggs', is displayed, regardless of the status of the current user.
$user =& JFactory::getUser( 'joebloggs' ); if ($user->id == 0) { echo 'There is no user joebloggs registered on this site.<br />'; } else { echo 'User name: ' . $user->username . '<br />'; echo 'Real name: ' . $user->name . '<br />'; echo 'User ID : ' . $user->id . '<br />'; }
[edit] Example 3
In this example, a check is made to determine if the current user has edit permission on content. For more information on permissions see JAuthorization. See also JFactory->getACL.
$user =& JFactory::getUser(); if ($user->authorize( 'com_content', 'edit', 'content', 'all' )) { echo 'Editing permitted.'; } else { echo 'Editing not permitted.'; }
