Add to / remove from user group

Question

I have a profile form with a select menu for a user to choose their nearest location (a Category group.) A user will select their nearest location, it will add the category to their profile and then add them to the corresponding User group.

I would also like to remove the user from their existing group. For example, if they change from London to New York, they should be removed from the London user group and placed in the New York group.

The complication is that they belong to other user groups, which they need to stay in.

Adding to the new location group is working well, but I'm looking for a hand in removing the exisiting one. If anyone has any thoughts on my code below, I would very much appreciate it!

Event::on(
    User::class, Element::EVENT_AFTER_SAVE, function (ModelEvent $event) {
        if (Craft::$app->getRequest()->getIsConsoleRequest()) {
            return;
        }
    $user = $event->sender;
    $userLocation = Craft::$app->getRequest()->getBodyParam('fields[userLocation][0]');

    if (!$userLocation) {
        return;
    }

    $newLocationCategory = Craft::$app->getCategories()->getCategoryById($userLocation);
    $newLocationGroup = Craft::$app->getUserGroups()->getGroupByHandle($newLocationCategory->title);

    $oldLocationCategory = Craft::$app->getCategories()->getCategoryById($user->userLocation->id[0]);
    $oldLocationGroup = Craft::$app->getUserGroups()->getGroupByHandle($oldLocationCategory->title);

    $currentGroupIds = \array_map(function ($group) {
        return (int)$group->id;
    }, $user->getGroups());


    // Remove the user from their old Location group - this is not working
    if (($key = array_search($oldLocationGroup->id, $currentGroupIds)) !== false) {
        unset($currentGroupIds[$key]);
    }


    $finalGroupIds = array_merge($currentGroupIds, [$newLocationGroup->id]);
    Craft::$app->getUsers()->assignUserToGroups($user->id, $finalGroupIds);
}

);

Answer 1

Try to use EVENT_BEFORE_SAVE and try to do a query the user again to get the old user data, something like this:

Event::on(
        User::class, 
        Element::EVENT_BEFORE_SAVE, 
              function (ModelEvent $event) {
                if (Craft::$app->getRequest()->getIsConsoleRequest()) {
                    return;
                }
            $user = $event->sender;
            $userLocation = $user->userLocation->one();

            $newLocationCategory = $user->userLocation->one();
            $newLocationGroup = Craft::$app->getUserGroups()->getGroupByHandle($newLocationCategory->title);
            $currentGroupIds = [];
            if (!$event->isNew) {
                // to get all location we need to do a query for user again.
                $oldUserData = User::findOne($user->id);
                $oldUserCategory = $oldUserData->userLocation->one();
                $oldLocationGroup = Craft::$app->getUserGroups()->getGroupByHandle($oldUserCategory->title);

                $currentGroupIds = \array_map(function($group) {
                    return (int)$group->id;
                }, $user->getGroups());


                // Remove the user from their old Location group - this is not working
                if (($key = array_search($oldLocationGroup->id, $currentGroupIds)) !== false) {
                    unset($currentGroupIds[$key]);
                }
            }

            $finalGroupIds = array_merge($currentGroupIds, [$newLocationGroup?->id]);
            Craft::$app->getUsers()->assignUserToGroups($user->id, $finalGroupIds);
        }
);

PS: I didn't test the code.

Answer 2

So, are you sure you only have the necessary user group IDs at the end, in $finalGroupIds ?

Can you try to drop the keys after deleting(unset) unnecessary items(old groupIds) in your array?

$finalGroupIds = array_values(array_merge($currentGroupIds, [$newLocationGroup->id]));