MediaWiki\Api\Hook\ApiDeprecationHelpHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\Api\ApiHookRunner.

Public Member Functions
	onApiDeprecationHelp (&$msgs)
	Use this hook to add messages to the 'deprecation-help' warning generated from ApiBase::addDeprecation().

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "ApiDeprecationHelp" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 14 of file ApiDeprecationHelpHook.php.

Member Function Documentation

onApiDeprecationHelp()

MediaWiki\Api\Hook\ApiDeprecationHelpHook::onApiDeprecationHelp

(

&

$msgs

)

Use this hook to add messages to the 'deprecation-help' warning generated from ApiBase::addDeprecation().

Since

1.35

Parameters

Message[]

&$msgs

Messages to include in the help. Multiple messages will be joined with spaces.

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\Api\ApiHookRunner.

---

The documentation for this interface was generated from the following file:

• includes/api/Hook/ApiDeprecationHelpHook.php