MediaWiki  master
MediaWiki\User\Hook\UserGetEmailHook Interface Reference

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

Inheritance diagram for MediaWiki\User\Hook\UserGetEmailHook:

Public Member Functions

 onUserGetEmail ( $user, &$email)
 This hook is called when getting an user email address. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file UserGetEmailHook.php.

Member Function Documentation

◆ onUserGetEmail()

MediaWiki\User\Hook\UserGetEmailHook::onUserGetEmail (   $user,
$email 
)

This hook is called when getting an user email address.

Since
1.35
Parameters
User$user
string&$emailEmail, change this to override local email
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: