wiki.techinc.nl/includes/api/Hook/APIHelpModifyOutputHook.php
daniel e6e0ad2472 Replace "@stable for implementation" with "@stable to implement"
For compliance with the new version of the table interface policy
(T255803).

This patch was created by an automated search & replace operation
on the includes/ directory.

Bug: T257789
Change-Id: I17e5e92e24c708ffc846945a136347670a3a20c7
2020-07-13 11:05:49 +02:00

25 lines
732 B
PHP

<?php
namespace MediaWiki\Api\Hook;
use ApiBase;
/**
* @stable to implement
* @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 );
}