Manual:Hooks/ApiBeforeMain

From Linux Web Expert

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
ApiBeforeMain
<translate> Available from <tvar name=1><translate> version <tvar (Gerrit change 100996)</tvar></translate>
Occurs before ApiMain's execute is called to process the request.
<translate> Define function:</translate>
public static function onApiBeforeMain( &$main ) { ... }
<translate> Attach hook:</translate> <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
	"Hooks": {
		"ApiBeforeMain": "MediaWiki\\Extension\\MyExtension\\Hooks::onApiBeforeMain"
	}
}
<translate> Called from:</translate> <translate> File(s):</translate> ../api.php
<translate> Interface:</translate> ApiBeforeMainHook.php

<translate> For more information about attaching hooks, see <tvar name=1>Manual:Hooks </tvar>.</translate>
<translate> For examples of extensions using this hook, see <tvar name=cat>Category:ApiBeforeMain extensions</tvar>.</translate>


Details

  • &$main: ApiMain being used for request

See also