MediaWiki  master
MediaWiki\Hook\EmailUserPermissionsErrorsHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\EmailUserPermissionsErrorsHook:

Public Member Functions

 onEmailUserPermissionsErrors ( $user, $editToken, &$hookErr)
 Use this hook to retrieve permissions errors for emailing a user. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file EmailUserPermissionsErrorsHook.php.

Member Function Documentation

◆ onEmailUserPermissionsErrors()

MediaWiki\Hook\EmailUserPermissionsErrorsHook::onEmailUserPermissionsErrors (   $user,
  $editToken,
$hookErr 
)

Use this hook to retrieve permissions errors for emailing a user.

Since
1.35
Parameters
User$userThe user who is trying to email another user.
string$editTokenThe user's edit token.
bool | string | array&$hookErrOut-param for the error. Passed as the parameters to OutputPage::showErrorPage.
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: