Manual:Hooks/UserGroupsChanged
From Linux Web Expert
| UserGroupsChanged | |
|---|---|
| <translate> Available from <tvar name=1><translate> version <tvar </tvar></translate> Called after user groups are changed. | |
| <translate> Define function:</translate> | public static function onUserGroupsChanged( User $user, array $added, array $removed, $performer, $reason, $oldUGMs, $newUGMs ) { ... }
|
| <translate> Attach hook:</translate> | <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
"Hooks": {
"UserGroupsChanged": "MediaWiki\\Extension\\MyExtension\\Hooks::onUserGroupsChanged"
}
}
|
| <translate> Called from:</translate> | <translate> File(s):</translate> specials/SpecialUserrights.php, user/User.php |
| <translate> Interface:</translate> | UserGroupsChangedHook.php |
<translate> For more information about attaching hooks, see <tvar name=1>Manual:Hooks</tvar>.</translate>
<translate> For examples of extensions using this hook, see <tvar name=cat>Category:UserGroupsChanged extensions</tvar>.</translate>
Details
- $user: User whose groups changed
- $added: Groups added
- $removed: Groups removed
- $performer: User who performed the change, false if via autopromotion
- $reason (added in MW 1.28): Reason/log comment for the change, or false if via autopromotion
- $oldUGMs (added in MW 1.31): old user group memberships (as returned by
$user->getGroupMemberships()) - $newUGMs (added in MW 1.31): new user group memberships
Notes
Added in MediaWiki 1.26 as part of the upcoming AuthManager system. Replaces the AuthPlugin::updateExternalDBGroups() method call.
