This is a hook handler interface, see docs/Hooks.md. More...
Public Member Functions | |
| onGetUserPermissionsErrorsExpensive ( $title, $user, $action, &$result) | |
| This hook is equal to getUserPermissionsErrors, but it is called only if expensive checks are enabled. | |
Detailed Description
This is a hook handler interface, see docs/Hooks.md.
Use the hook name "getUserPermissionsErrorsExpensive" to register handlers implementing this interface.
- Stability: stable
- to implement
Definition at line 16 of file GetUserPermissionsErrorsExpensiveHook.php.
Member Function Documentation
◆ onGetUserPermissionsErrorsExpensive()
| MediaWiki\Permissions\Hook\GetUserPermissionsErrorsExpensiveHook::onGetUserPermissionsErrorsExpensive | ( | $title, | |
| $user, | |||
| $action, | |||
| & | $result ) |
This hook is equal to getUserPermissionsErrors, but it is called only if expensive checks are enabled.
Use this hook to add a permissions error when permissions errors are checked for. 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
- Parameters
-
Title $title Title being checked against User $user Current user string $action Action being checked 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.
- 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:
- includes/Permissions/Hook/GetUserPermissionsErrorsExpensiveHook.php
