Manual:Hooks/APIHelpModifyOutput
| APIHelpModifyOutput | |
|---|---|
| Available from version 1.25.0 (Gerrit change 160798) Allows to modify an API module's help output | |
| Define function: | public static function onAPIHelpModifyOutput( ApiBase $module, array &$help, array $options, array &$toc ) { ... }
|
| Attach hook: | In extension.json:
{
"Hooks": {
"APIHelpModifyOutput": "MediaWiki\\Extension\\MyExtension\\Hooks::onAPIHelpModifyOutput"
}
}
|
| Called from: | File(s): api/ApiHelp.php Function(s): getHelpInternal |
| Interface: | APIHelpModifyOutputHook.php |
For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:APIHelpModifyOutput extensions.
Details[edit]
$module- ApiBase object&$help- Array of HTML strings to be joined for the output$options- Array of options passed toApiBase::getHelp()&$toc- If a TOC is being generated, this array has keys as anchors in the page and values as forLinker::generateTOC().