includes/api/Hook/ApiMain__onExceptionHook.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

<?php

namespace MediaWiki\Api\Hook;

// phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
use MediaWiki\Api\ApiMain;
use Throwable;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "ApiMain::onException" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface ApiMain__onExceptionHook {
	/**
	 * This hook is called by ApiMain::executeActionWithErrorHandling() when
	 * an exception is thrown during API action execution.
	 *
	 * @since 1.35
	 *
	 * @param ApiMain $apiMain Calling ApiMain instance
	 * @param Throwable $e
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onApiMain__onException( $apiMain, $e );
}