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;
use MediaWiki\Api\ApiBase;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "APIHelpModifyOutput" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface APIHelpModifyOutputHook {
/**
* Use this hook to modify an API module's help output.
*
* @since 1.35
*
* @param ApiBase $module
* @param string[] &$help Array of HTML strings to be joined for the output
* @param array $options Array of formatting options passed to ApiHelp::getHelp
* @param array &$tocData If a TOC is being generated, this array has keys as anchors in
* the page and values as for SectionMetadata::fromLegacy().
* @return bool|void True or no return value to continue or false to abort
*/
public function onAPIHelpModifyOutput( $module, &$help, $options, &$tocData );
}
|
