1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
<?php
namespace MediaWiki\Permissions\Hook;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
use Wikimedia\Message\MessageSpecifier;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "getUserPermissionsErrors" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface GetUserPermissionsErrorsHook {
/**
* Use this hook to add a permissions error when permissions errors are
* checked for. Use instead of userCan for most cases. Return false if the user
* can't do it, and populate $result with the reason in the form of
* [ messagename, param1, param2, ... ] or a MessageSpecifier instance (you
* might want to use ApiMessage to provide machine-readable details for the API).
*
* @since 1.35
*
* @param Title $title Title being checked against
* @param User $user Current user
* @param string $action Action being checked
* @param array|string|MessageSpecifier &$result User permissions error to add. If none, return true.
* For consistency, error messages should be plain text with no special coloring,
* bolding, etc. to show that they're errors; presenting them properly to the
* user as errors is done by the caller.
* @return bool|void True or no return value to continue or false to abort
*/
public function onGetUserPermissionsErrors( $title, $user, $action, &$result );
}
|
