MediaWiki\User\Hook\UserModifyCreateAccountEmailHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onUserModifyCreateAccountEmail (User $user, User $performer, Message &$subject, Message &$body)
	This hook runs when a user account is being created on behalf of another user, such as when using Special:CreateAccount when already logged in.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 15 of file UserModifyCreateAccountEmailHook.php.

Member Function Documentation

onUserModifyCreateAccountEmail()

MediaWiki\User\Hook\UserModifyCreateAccountEmailHook::onUserModifyCreateAccountEmail	(	User	$user,
		User	$performer,
		Message &	$subject,
		Message &	$body )

This hook runs when a user account is being created on behalf of another user, such as when using Special:CreateAccount when already logged in.

This allows overriding, wrapping, or otherwise modifying both the subject and the body of the email being sent to $user.

This can be used, for example, by extensions to add additional information to the email body.

Since

1.47

Parameters

User	$user	The user account being created
User	$performer	The user account performing the creation on behalf of $user
Message	&$subject	The email subject
Message	&$body	The email body

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/User/Hook/UserModifyCreateAccountEmailHook.php