MediaWiki\Hook\ApiBeforeMainHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onApiBeforeMain (&$main)
	This hook is called before calling ApiMain's execute() method in api.php.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file ApiBeforeMainHook.php.

Member Function Documentation

onApiBeforeMain()

MediaWiki\Hook\ApiBeforeMainHook::onApiBeforeMain

(

&

$main

)

This hook is called before calling ApiMain's execute() method in api.php.

Since

1.35

Parameters

ApiMain

&$main

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

---

The documentation for this interface was generated from the following file:

• includes/Hook/ApiBeforeMainHook.php