wiki.techinc.nl/includes/user/Hook/UserRemoveGroupHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

26 lines
665 B
PHP

<?php
namespace MediaWiki\User\Hook;
use User;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "UserRemoveGroup" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface UserRemoveGroupHook {
/**
* This hook is called when removing a group.
*
* @since 1.35
*
* @param User $user The user that is to have a group removed
* @param string &$group The group to be removed. Can be modified.
* @return bool|void True or no return value to continue or false to abort (override
* the stock group removal)
*/
public function onUserRemoveGroup( $user, &$group );
}