c44488f725
Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
25 lines
738 B
PHP
25 lines
738 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Api\Hook;
|
|
|
|
use ApiBase;
|
|
|
|
/**
|
|
* @stable for implementation
|
|
* @ingroup Hooks
|
|
*/
|
|
interface APIHelpModifyOutputHook {
|
|
/**
|
|
* Use this hook to modify an API module's help output.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param ApiBase $module Module object
|
|
* @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 Linker::generateTOC().
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onAPIHelpModifyOutput( $module, &$help, $options, &$tocData );
|
|
}
|