includes/user/Hook/UserRemoveGroupHook.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

<?php

namespace MediaWiki\User\Hook;

use MediaWiki\User\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 );
}