MediaWiki\Hook\UserMailerTransformContentHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\UserMailerTransformContentHook:

Public Member Functions
	onUserMailerTransformContent ( $to, $from, &$body, &$error)
	This hook is called in UserMailer::send() to change email contents.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file UserMailerTransformContentHook.php.

Member Function Documentation

onUserMailerTransformContent()

MediaWiki\Hook\UserMailerTransformContentHook::onUserMailerTransformContent	(		$to,
			$from,
		&	$body,
		&	$error
	)

This hook is called in UserMailer::send() to change email contents.

Since

1.35

Parameters

MailAddress[]	$to	Array of addresses of the targets
MailAddress	$from	Address of the sender
string | array	&$body	Email body, either a string (for plaintext emails) or an array with 'text' and 'html' keys
string	&$error	Error message

Returns

bool|void True or no return value to continue, or false and set $error to block sending the email

Implemented in MediaWiki\HookContainer\HookRunner.

---

The documentation for this interface was generated from the following file:

• includes/mail/Hook/UserMailerTransformContentHook.php