MediaWiki\Hook\EmailUserCCHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\EmailUserCCHook:

Public Member Functions
	onEmailUserCC (&$to, &$from, &$subject, &$text)
	This hook is called before sending the copy of the email to the author.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file EmailUserCCHook.php.

Member Function Documentation

onEmailUserCC()

MediaWiki\Hook\EmailUserCCHook::onEmailUserCC	(	&	$to,
		&	$from,
		&	$subject,
		&	$text
	)

This hook is called before sending the copy of the email to the author.

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

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