MediaWiki master
MediaWiki\Api\Hook\ApiMain__onExceptionHook Interface Reference

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

Inherited by MediaWiki\Api\ApiHookRunner.

Public Member Functions

 onApiMain__onException ( $apiMain, $e)
 This hook is called by ApiMain::executeActionWithErrorHandling() when an exception is thrown during API action execution.
 

Detailed Description

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

Use the hook name "ApiMain::onException" to register handlers implementing this interface.

Stability: stable
to implement

Definition at line 16 of file ApiMain__onExceptionHook.php.

Member Function Documentation

◆ onApiMain__onException()

MediaWiki\Api\Hook\ApiMain__onExceptionHook::onApiMain__onException (   $apiMain,
  $e 
)

This hook is called by ApiMain::executeActionWithErrorHandling() when an exception is thrown during API action execution.

Since
1.35
Parameters
ApiMain$apiMainCalling ApiMain instance
Throwable$e
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\Api\ApiHookRunner.


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