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

27 lines
787 B
PHP

<?php
namespace MediaWiki\User\Hook;
use User;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "UserAddGroup" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface UserAddGroupHook {
/**
* This hook is alled when adding a group or changing a group's expiry.
*
* @since 1.35
*
* @param User $user The user that is to have a group added
* @param string &$group The group to add; can be modified
* @param string|null &$expiry The expiry time in TS_MW format, or null if the group is not to
* expire; can be modified
* @return bool|void True or no return value to continue or false to abort (not add the group)
*/
public function onUserAddGroup( $user, &$group, &$expiry );
}