MediaWiki\Hook\EmailUserHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

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

Detailed Description

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

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

Deprecated

since 1.41 Handle the EmailUserSendEmail hook instead.

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	&$to	MailAddress object of receiving user
MailAddress	&$from	MailAddress object of sending user
string	&$subject	subject of the mail
string	&$text	text of the mail
bool | Status | MessageSpecifier | array	&$error	Out-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:

• includes/specials/Hook/EmailUserHook.php