MediaWiki master
MediaWiki\Mail\Hook\EmailUserAuthorizeSendHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onEmailUserAuthorizeSend (Authority $sender, StatusValue $status)
 This hook is called when checking whether a user is allowed to send emails.
 

Detailed Description

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

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

Stability: stable
to implement
Since
1.41

Definition at line 16 of file EmailUserAuthorizeSendHook.php.

Member Function Documentation

◆ onEmailUserAuthorizeSend()

MediaWiki\Mail\Hook\EmailUserAuthorizeSendHook::onEmailUserAuthorizeSend ( Authority $sender,
StatusValue $status )

This hook is called when checking whether a user is allowed to send emails.

Parameters
Authority$sender
StatusValue$statusAdd any error here
Returns
bool|void True or no return value to continue, false to abort, which also requires adding a fatal error to $status.

Implemented in MediaWiki\HookContainer\HookRunner.


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