Manual:Hooks/UserMailerSplitTo

From MediaWiki.org
Jump to navigation Jump to search
UserMailerSplitTo
Available from version 1.27.0 (Gerrit change 242791)
Called in UserMailer::send() to give extensions a chance to split up an email with multiple of the To: field into separate emails.
Define function:
public static function onUserMailerSplitTo( array &$to ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"UserMailerSplitTo": "MyExtensionHooks::onUserMailerSplitTo"
	}
}

For MediaWiki ≤1.25:

$wgHooks['UserMailerSplitTo'][] = 'MyExtensionHooks::onUserMailerSplitTo';
Called from:File(s): mail/UserMailer.php
Function(s): send

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:UserMailerSplitTo extensions.

Details[edit]

  • &$to: array of MailAddress objects; unset the ones which should be mailed separately