gplx/mediawiki/includes/specials/Hook/ChangeUserGroupsHook.php

30 lines
968 B
PHP

<?php
namespace MediaWiki\Hook;
use MediaWiki\User\User;
use MediaWiki\User\UserIdentity;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "ChangeUserGroups" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface ChangeUserGroupsHook {
/**
* This hook is called before user groups are changed.
*
* @since 1.35
*
* @param User $performer The User who will perform the change
* @param User|UserIdentity $user The User whose groups will be changed, for local group changes this is a
* User class, for interwiki group changes this was a UserRightsProxy until 1.40 and is a UserIdentity since 1.41
* @param array &$add The groups that will be added
* @param array &$remove The groups that will be removed
* @return bool|void True or no return value to continue or false to abort
*/
public function onChangeUserGroups( $performer, $user, &$add, &$remove );
}