MediaWiki  master
MediaWiki\Api\Hook\APIHelpModifyOutputHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\Api\Hook\APIHelpModifyOutputHook:

Public Member Functions

 onAPIHelpModifyOutput ( $module, &$help, $options, &$tocData)
 Use this hook to modify an API module's help output. More...
 

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "APIHelpModifyOutput" to register handlers implementing this interface.

Stable to implement

Definition at line 14 of file APIHelpModifyOutputHook.php.

Member Function Documentation

◆ onAPIHelpModifyOutput()

MediaWiki\Api\Hook\APIHelpModifyOutputHook::onAPIHelpModifyOutput (   $module,
$help,
  $options,
$tocData 
)

Use this hook to modify an API module's help output.

Since
1.35
Parameters
ApiBase$module
string[]&$helpArray of HTML strings to be joined for the output
array$optionsArray of formatting options passed to ApiHelp::getHelp
array&$tocDataIf a TOC is being generated, this array has keys as anchors in the page and values as for Linker::generateTOC().
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\Api\ApiHookRunner.


The documentation for this interface was generated from the following file: