MediaWiki master
|
This is a hook handler interface, see docs/Hooks.md. More...
Inherited by MediaWiki\Api\ApiHookRunner.
Public Member Functions | |
onAPIHelpModifyOutput ( $module, &$help, $options, &$tocData) | |
Use this hook to modify an API module's help output. | |
This is a hook handler interface, see docs/Hooks.md.
Use the hook name "APIHelpModifyOutput" to register handlers implementing this interface.
Definition at line 14 of file APIHelpModifyOutputHook.php.
MediaWiki\Api\Hook\APIHelpModifyOutputHook::onAPIHelpModifyOutput | ( | $module, | |
& | $help, | ||
$options, | |||
& | $tocData ) |
Use this hook to modify an API module's help output.
ApiBase | $module | |
string[] | &$help | Array of HTML strings to be joined for the output |
array | $options | Array of formatting options passed to ApiHelp::getHelp |
array | &$tocData | If a TOC is being generated, this array has keys as anchors in the page and values as for SectionMetadata::fromLegacy(). |
Implemented in MediaWiki\Api\ApiHookRunner.