c44488f725
Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
23 lines
531 B
PHP
23 lines
531 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Api\Hook;
|
|
|
|
use Message;
|
|
|
|
/**
|
|
* @stable for implementation
|
|
* @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 );
|
|
}
|