API16:JUserHelper/removeUserFromGroup

Description

Method to remove a user from a group.

{{subst:Description:JUserHelper/removeUserFromGroup}}

Syntax

static removeUserFromGroup($userId, $groupId)

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

Returns

mixed Boolean true on success, on error.

Defined in

libraries/joomla/user/helper.php

Importing

jimport( 'joomla.user.helper' );

Source Body

public static function removeUserFromGroup($userId, $groupId)
{
        // Get the user object.
        $user = & JUser::getInstance((int) $userId);

        // Remove the user from the group if necessary.
        if (array_key_exists($groupId, $user->groups))
        {
                // Remove the user from the group.
                unset($user->groups[$groupId]);

                // Store the user object.
                if (!$user->save()) {
                        return new JException($user->getError());
                }
        }

        // Set the group data for any preloaded user objects.
        $temp = & JFactory::getUser((int) $userId);
        $temp->groups = $user->groups;

        // Set the group data for the user object in the session.
        $temp = & JFactory::getUser();
        if ($temp->id == $userId) {
                $temp->groups = $user->groups;
        }

        return true;
}

{{subst:SeeAlso:JUserHelper/removeUserFromGroup}}

Examples

<CodeExamplesForm />