wiki.techinc.nl/includes/user/Hook/UserCanSendEmailHook.php
Umherirrender 4469addf9e Fix documentation for hook error in UserCanSendEmailHook
Use the documentation for EmailUserPermissionsErrorsHook,
because both are called with the same argument on SpecialEmailUser

Rename variable to match all usages

Change-Id: Ie1f4a9ad15da3818632141b84b3dfdf6aa4f076c
2021-03-09 00:16:12 +01:00

26 lines
715 B
PHP

<?php
namespace MediaWiki\User\Hook;
use User;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "UserCanSendEmail" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface UserCanSendEmailHook {
/**
* Use this hook to override User::canSendEmail() permission check.
*
* @since 1.35
*
* @param User $user User (object) whose permission is being checked
* @param bool|string|array &$hookErr Out-param for the error. Passed as the parameters to
* OutputPage::showErrorPage.
* @return bool|void True or no return value to continue or false to abort
*/
public function onUserCanSendEmail( $user, &$hookErr );
}