MediaWiki master
MediaWiki\Message\Hook\MessagePostProcessTextHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onMessagePostProcessText (&$value, $format, $key)
 This hook is called after a message is formatted as a text format.
 

Detailed Description

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

Use the hook name "MessagePostProcessText" to register handlers implementing this interface. If you just want to replace a message, use the MessagesPreLoad hook instead.

Stability: stable
to implement

Definition at line 13 of file MessagePostProcessTextHook.php.

Member Function Documentation

◆ onMessagePostProcessText()

MediaWiki\Message\Hook\MessagePostProcessTextHook::onMessagePostProcessText ( & $value,
$format,
$key )

This hook is called after a message is formatted as a text format.

Use this hook if you wish to post process the message. This hook might not be called for messages constructed early in MW initialization.

Since
1.45
Parameters
string&$valueFormatted value of message.
string$formatEither Message::FORMAT_PLAIN or Message::FORMAT_TEXT.
string$keyMessage key this is for (RawMessage uses value).

Implemented in MediaWiki\HookContainer\HookRunner.


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