MediaWiki master
MediaWiki\Hook\GetBlockErrorMessageKeyHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onGetBlockErrorMessageKey (Block $block, string &$key)
 This hook is called in BlockErrorFormatter to allow extensions to override the message that will be displayed to the user.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 14 of file GetBlockErrorMessageKeyHook.php.

Member Function Documentation

◆ onGetBlockErrorMessageKey()

MediaWiki\Hook\GetBlockErrorMessageKeyHook::onGetBlockErrorMessageKey ( Block $block,
string & $key )

This hook is called in BlockErrorFormatter to allow extensions to override the message that will be displayed to the user.

Since
1.40
Parameters
Block$block
string&$key
Returns
bool|void True or no return value to continue or false to abort

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