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\User\Hook;
4
5use MediaWiki\User\User;
6
7/**
8 * This is a hook handler interface, see docs/Hooks.md.
9 * Use the hook name "UserAddGroup" to register handlers implementing this interface.
10 *
11 * @stable to implement
12 * @ingroup Hooks
13 */
14interface UserAddGroupHook {
15    /**
16     * This hook is called when adding a group or changing a group's expiry.
17     *
18     * @since 1.35
19     *
20     * @param User $user The user that is to have a group added
21     * @param string &$group The group to add; can be modified
22     * @param string|null &$expiry The expiry time in TS_MW format, or null if the group is not to
23     *   expire; can be modified
24     * @return bool|void True or no return value to continue or false to abort (not add the group)
25     */
26    public function onUserAddGroup( $user, &$group, &$expiry );
27}