Manual:Hooks/ApiBeforeMain

From MediaWiki.org
Jump to navigation Jump to search
ApiBeforeMain
Available from version 1.23.0 (Gerrit change 100996)
Occurs before ApiMain's execute is called to process the request.
Define function:
public static function onApiBeforeMain( &$main ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"ApiBeforeMain": "MyExtensionHooks::onApiBeforeMain"
	}
}

For MediaWiki ≤1.25:

$wgHooks['ApiBeforeMain'][] = 'MyExtensionHooks::onApiBeforeMain';
Called from:File(s): ../api.php

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

Details[edit]

  • &$main: ApiMain being used for request

See also[edit]