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

28 lines
806 B
PHP

<?php
namespace MediaWiki\User\Hook;
use User;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "EmailConfirmed" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface EmailConfirmedHook {
/**
* This hook is called when checking that the user's email address is "confirmed".
*
* This runs before the other checks, such as anonymity and the real check; return
* true to allow those checks to occur, and false if checking is done.
*
* @since 1.35
*
* @param User $user User being checked
* @param bool &$confirmed Whether or not the email address is confirmed
* @return bool|void True or no return value to continue or false to abort
*/
public function onEmailConfirmed( $user, &$confirmed );
}