MediaWiki REL1_35
Public Member Functions | List of all members
MediaWiki\Api\Hook\ApiCheckCanExecuteHook Interface Reference
Hooks

Stable to implement. More...

Inheritance diagram for MediaWiki\Api\Hook\ApiCheckCanExecuteHook:
Inheritance graph
[legend]

Public Member Functions

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

Detailed Description

Stable to implement.

Definition at line 14 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$moduleModule object
User$userCurrent user
IApiMessage | Message | string | array&$messageAPI message to die with. Specific values accepted depend on the MediaWiki version:
  • 1.29+: IApiMessage, Message, string message key, or key+parameters array to pass to ApiBase::dieWithError().
  • 1.27+: IApiMessage, or a key or key+parameters in ApiBase::$messageMap.
  • Earlier: A key or key+parameters in ApiBase::$messageMap.
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: