From Joomla! Documentation

< API16:JAccess
Revision as of 16:34, 22 March 2010 by Doxiki (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Replacement filing cabinet.png
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.


Method to return a list of user groups mapped to a user. The returned list can optionally hold only the groups explicitly mapped to the user or all groups both explicitly mapped and inherited by the user.

[Edit Descripton]



static getGroupsByUser($userId, $recursive=true)
Parameter Name Default Value Description
$userId Id of the user for which to get the list of groups.
$recursive true True to include inherited user groups.


array List of user group ids to which the user is mapped.

Defined in



jimport( 'joomla.access.access' );

Source Body

public static function getGroupsByUser($userId, $recursive = true)
        // Get the database connection object.
        $db = JFactory::getDbo();
        // Build the database query to get the rules for the asset.
        $query  = $db->getQuery(true);
        $query->select($recursive ? '' : '');
        $query->from('#__user_usergroup_map AS map');
        $query->where('map.user_id = '.(int) $userId);
        $query->leftJoin('#__usergroups AS a ON = map.group_id');
        // If we want the rules cascading up to the global asset node we need a self-join.
        if ($recursive) {
                $query->leftJoin('#__usergroups AS b ON b.lft <= a.lft AND b.rgt >= a.rgt');
        // Execute the query and load the rules from the result.
        $result = $db->loadResultArray();
        // Clean up any NULL or duplicate values, just in case
        if (empty($result)) {
                $result = array('1');
        } else {
                $result = array_unique($result);
        return $result;

[Edit See Also] SeeAlso:JAccess/getGroupsByUser


<CodeExamplesForm />