Jump to content

Manual:Hooks/ApiQueryCheckCanExecute

From mediawiki.org
ApiQueryCheckCanExecute
Available from version 1.44.0 (Gerrit change 1100198)
called during the beginning of ApiQuery::execute()
Define function:
public static function onApiQueryCheckCanExecute( array $modules, MediaWiki\Permissions\Authority $authority, MessageSpecifier | string | array &$message ) { ... }
Attach hook: In extension.json:
{
	"Hooks": {
		"ApiQueryCheckCanExecute": "MediaWiki\\Extension\\MyExtension\\Hooks::onApiQueryCheckCanExecute"
	}
}
Called from: File(s): api/ApiQuery.php
Interface: ApiQueryCheckCanExecuteHook.php

For more information about attaching hooks, see Manual:Hooks .
For examples of extensions using this hook, see Category:ApiQueryCheckCanExecute extensions.


This hook can be used to prevent execution of query submodules.