MediaWiki\User\Hook\EmailConfirmedHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\User\Hook\EmailConfirmedHook:

Public Member Functions
	onEmailConfirmed ( $user, &$confirmed)
	This hook is called when checking that the user's email address is "confirmed".

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "EmailConfirmed" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 14 of file EmailConfirmedHook.php.

Member Function Documentation

onEmailConfirmed()

MediaWiki\User\Hook\EmailConfirmedHook::onEmailConfirmed	(		$user,
		&	$confirmed
	)

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

Parameters

User	$user	User being checked
bool	&$confirmed	Whether or not the email address is confirmed

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

---

The documentation for this interface was generated from the following file:

• includes/user/Hook/EmailConfirmedHook.php