MediaWiki  master
MediaWiki\Hook\GetMagicVariableIDsHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\GetMagicVariableIDsHook:

Public Member Functions

 onGetMagicVariableIDs (&$variableIDs)
 Use this hook to modify the list of magic variables. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 12 of file GetMagicVariableIDsHook.php.

Member Function Documentation

◆ onGetMagicVariableIDs()

MediaWiki\Hook\GetMagicVariableIDsHook::onGetMagicVariableIDs ( $variableIDs)

Use this hook to modify the list of magic variables.

Magic variables are localized with the magic word system, and this hook is called by MagicWordFactory.

Since
1.35
Parameters
string[]&$variableIDsarray of magic word identifiers
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


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