APIHelpModifyOutputHook.php
No OneTemporary
Actions

Size

892 B

Referenced Files

None

Subscribers

None

APIHelpModifyOutputHook.php
View Options

	<?php

	namespace MediaWiki\Api\Hook;

	use MediaWiki\Api\ApiBase;

	/**
	* This is a hook handler interface, see docs/Hooks.md.
	* Use the hook name "APIHelpModifyOutput" to register handlers implementing this interface.
	*
	* @stable to implement
	* @ingroup Hooks
	*/
	interface APIHelpModifyOutputHook {
	/**
	* Use this hook to modify an API module's help output.
	*
	* @since 1.35
	*
	* @param ApiBase $module
	* @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 SectionMetadata::fromLegacy().
	* @return bool\|void True or no return value to continue or false to abort
	*/
	public function onAPIHelpModifyOutput( $module, &$help, $options, &$tocData );
	}