API16:JUserHelper/getUserGroups

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.

Description

Method to get a list of groups a user is in.

Syntax

static getUserGroups($userId)

Parameter Name	Default Value	Description
$userId		$userId The id of the user.

Returns

mixed Array on success, on error.

Defined in

libraries/joomla/user/helper.php

Importing

jimport( 'joomla.user.helper' );

Source Body

public static function getUserGroups($userId)
{
        // Get the user object.
        $user = &JUser::getInstance((int) $userId);
 
        return isset($user->groups) ? $user->groups : array();
}

Examples

<CodeExamplesForm />