MediaWiki\Api\Hook\ApiCheckCanExecuteHook Interface Reference

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

Inherited by MediaWiki\Api\ApiHookRunner.

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

Detailed Description

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

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

Stability: 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	$user	Current user
IApiMessage | Message | string | array	&$message	API 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:

• includes/api/Hook/ApiCheckCanExecuteHook.php