1<?php
2
3namespace MediaWiki\Api\Hook;
4
5// phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
6use ApiMain;
7use Throwable;
8
9/**
10 * This is a hook handler interface, see docs/Hooks.md.
11 * Use the hook name "ApiMain::onException" to register handlers implementing this interface.
12 *
13 * @stable to implement
14 * @ingroup Hooks
15 */
16interface ApiMain__onExceptionHook {
17	/**
18	 * This hook is called by ApiMain::executeActionWithErrorHandling() when
19	 * an exception is thrown during API action execution.
20	 *
21	 * @since 1.35
22	 *
23	 * @param ApiMain $apiMain Calling ApiMain instance
24	 * @param Throwable $e
25	 * @return bool|void True or no return value to continue or false to abort
26	 */
27	public function onApiMain__onException( $apiMain, $e );
28}
29