MediaWiki  master
MediaWiki\Api\Hook\ApiCheckCanExecuteHook Interface Reference

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

Inheritance diagram for MediaWiki\Api\Hook\ApiCheckCanExecuteHook:

Public Member Functions

 onApiCheckCanExecute ( $module, $user, &$message)
 This hook is called during ApiMain::checkCanExecute. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 17 of file ApiCheckCanExecuteHook.php.

Member Function Documentation

◆ onApiCheckCanExecute()

MediaWiki\Api\Hook\ApiCheckCanExecuteHook::onApiCheckCanExecute (   $module,
  $user,
$message 
)

This hook is called during ApiMain::checkCanExecute.

Use this hook to further authenticate and authorize API clients before executing the module.

Since
1.35
Parameters
ApiBase$module
User$userCurrent user
IApiMessage | Message | string | array&$messageAPI message to die with. Specific values accepted depend on the MediaWiki version:
Returns
bool|void True or no return value to continue, or false and set a message to cancel the request

Implemented in MediaWiki\Api\ApiHookRunner.


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