1	<?php
2
3	namespace MediaWiki\Api\Hook;
4
5	use ApiBase;
6
7	/**
8	* This is a hook handler interface, see docs/Hooks.md.
9	* Use the hook name "APIHelpModifyOutput" to register handlers implementing this interface.
10	*
11	* @stable to implement
12	* @ingroup Hooks
13	*/
14	interface APIHelpModifyOutputHook {
15	/**
16	* Use this hook to modify an API module's help output.
17	*
18	* @since 1.35
19	*
20	* @param ApiBase $module
21	* @param string[] &$help Array of HTML strings to be joined for the output
22	* @param array $options Array of formatting options passed to ApiHelp::getHelp
23	* @param array &$tocData If a TOC is being generated, this array has keys as anchors in
24	*   the page and values as for SectionMetadata::fromLegacy().
25	* @return bool|void True or no return value to continue or false to abort
26	*/
27	public function onAPIHelpModifyOutput( $module, &$help, $options, &$tocData );
28	}