MediaWiki\User\Hook\UserRemoveGroupHook Interface Reference
This is a hook handler interface, see docs/Hooks.md. More...
Inheritance diagram for MediaWiki\User\Hook\UserRemoveGroupHook:
Public Member Functions | |
| onUserRemoveGroup ( $user, &$group) | |
| This hook is called when removing a group. | |
Detailed Description
This is a hook handler interface, see docs/Hooks.md.
Use the hook name "UserRemoveGroup" to register handlers implementing this interface.
- Stability: stable
- to implement
Definition at line 14 of file UserRemoveGroupHook.php.
Member Function Documentation
◆ onUserRemoveGroup()
| MediaWiki\User\Hook\UserRemoveGroupHook::onUserRemoveGroup | ( | $user, | |
| & | $group | ||
| ) |
This hook is called when removing a group.
- Since
- 1.35
- Parameters
-
User $user The user that is to have a group removed string &$group The group to be removed. Can be modified.
- Returns
- bool|void True or no return value to continue or false to abort (override the stock group removal)
Implemented in MediaWiki\HookContainer\HookRunner.
The documentation for this interface was generated from the following file:
- includes/user/Hook/UserRemoveGroupHook.php
