MediaWiki  master
MediaWiki\Hook\EmailUserHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\EmailUserHook:

Public Member Functions

 onEmailUser (&$to, &$from, &$subject, &$text, &$error)
 This hook is called before sending email from one user to another. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 16 of file EmailUserHook.php.

Member Function Documentation

◆ onEmailUser()

MediaWiki\Hook\EmailUserHook::onEmailUser ( $to,
$from,
$subject,
$text,
$error 
)

This hook is called before sending email from one user to another.

Since
1.35
Parameters
MailAddress&$toMailAddress object of receiving user
MailAddress&$fromMailAddress object of sending user
MailAddress&$subjectsubject of the mail
string&$texttext of the mail
bool | Status | MessageSpecifier | array&$errorOut-param for an error. Should be set to a Status object or boolean false.
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: