MediaWiki\User\Hook\UserSetEmailHook Interface Reference

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

Inheritance diagram for MediaWiki\User\Hook\UserSetEmailHook:

Public Member Functions
	onUserSetEmail ( $user, &$email)
	This hook is called when changing user email address.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file UserSetEmailHook.php.

Member Function Documentation

onUserSetEmail()

MediaWiki\User\Hook\UserSetEmailHook::onUserSetEmail	(		$user,
		&	$email
	)

This hook is called when changing user email address.

Since

1.35

Parameters

User	$user
string	&$email	new email, change this to override new email address

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/UserSetEmailHook.php