Manual:Hooks/UserGetRightsRemove
From Linux Web Expert
| UserGetRightsRemove | |
|---|---|
| <translate> Available from <tvar name=1><translate> version <tvar (Gerrit change 462157)</tvar></translate> Dynamically removes from a user the rights implied by their group membership | |
| <translate> Define function:</translate> | public static function onUserGetRightsRemove( User $user, array &$aRights ) { ... }
|
| <translate> Attach hook:</translate> | <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
"Hooks": {
"UserGetRightsRemove": "MediaWiki\\Extension\\MyExtension\\Hooks::onUserGetRightsRemove"
}
}
|
| <translate> Called from:</translate> | <translate> File(s):</translate> Permissions/PermissionManager.php <translate> Function(s):</translate> getUserPermissions |
| <translate> Interface:</translate> | UserGetRightsRemoveHook.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:UserGetRightsRemove extensions</tvar>.</translate>
Details
$user: User to get rights for&$rights: Current rights
Called in User::getRights(), after the UserGetRights hook has finished. It can be used to remove rights in a safe way (which would not be possible in UserGetRights as there's no way to guarantee that the next hook handler won't re-add the right). Therefore, UserGetRightsRemove handlers should never add rights, only remove them.
