includes/api/Hook/ApiDeprecationHelpHook.php
<?php
namespace MediaWiki\Api\Hook;
use MediaWiki\Message\Message;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "ApiDeprecationHelp" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface ApiDeprecationHelpHook {
/**
* Use this hook to add messages to the 'deprecation-help' warning generated
* from ApiBase::addDeprecation().
*
* @since 1.35
*
* @param Message[] &$msgs Messages to include in the help. Multiple messages will be
* joined with spaces.
* @return bool|void True or no return value to continue or false to abort
*/
public function onApiDeprecationHelp( &$msgs );
}