MediaWiki REL1_37
Public Member Functions | List of all members
MediaWiki\Api\Hook\APIGetDescriptionMessagesHook Interface Reference
Hooks

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

Inheritance diagram for MediaWiki\Api\Hook\APIGetDescriptionMessagesHook:
Inheritance graph
[legend]

Public Member Functions

 onAPIGetDescriptionMessages ( $module, &$msg)
 Use this hook to modify a module's help message.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 15 of file APIGetDescriptionMessagesHook.php.

Member Function Documentation

◆ onAPIGetDescriptionMessages()

MediaWiki\Api\Hook\APIGetDescriptionMessagesHook::onAPIGetDescriptionMessages (   $module,
&  $msg 
)

Use this hook to modify a module's help message.

Since
1.35
Parameters
ApiBase$module
Message[]&$msg
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: