Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3namespace MediaWiki\Hook;
4
5use MediaWiki\User\User;
6use MediaWiki\User\UserIdentity;
7
8/**
9 * This is a hook handler interface, see docs/Hooks.md.
10 * Use the hook name "ChangeUserGroups" to register handlers implementing this interface.
11 *
12 * @stable to implement
13 * @ingroup Hooks
14 */
15interface ChangeUserGroupsHook {
16    /**
17     * This hook is called before user groups are changed.
18     *
19     * @since 1.35
20     *
21     * @param User $performer The User who will perform the change
22     * @param User|UserIdentity $user The User whose groups will be changed, for local group changes this is a
23     *   User class, for interwiki group changes this was a UserRightsProxy until 1.40 and is a UserIdentity since 1.41
24     * @param array &$add The groups that will be added
25     * @param array &$remove The groups that will be removed
26     * @return bool|void True or no return value to continue or false to abort
27     */
28    public function onChangeUserGroups( $performer, $user, &$add, &$remove );
29}