MediaWiki master
|
This is a hook handler interface, see docs/Hooks.md. More...
Inherited by MediaWiki\HookContainer\HookRunner.
Public Member Functions | |
onParserGetVariableValueSwitch ( $parser, &$variableCache, $magicWordId, &$ret, $frame) | |
This hook is called when the parser needs the value of a custom magic word. | |
This is a hook handler interface, see docs/Hooks.md.
Use the hook name "ParserGetVariableValueSwitch" to register handlers implementing this interface.
Definition at line 15 of file ParserGetVariableValueSwitchHook.php.
MediaWiki\Hook\ParserGetVariableValueSwitchHook::onParserGetVariableValueSwitch | ( | $parser, | |
& | $variableCache, | ||
$magicWordId, | |||
& | $ret, | ||
$frame ) |
This hook is called when the parser needs the value of a custom magic word.
Parser | $parser | |
array | &$variableCache | Array to cache the value; when you return $variableCache[$magicWordId] should be the same as $ret |
string | $magicWordId | Index of the magic word (hook should not mutate it!) |
string | &$ret | Value of the magic word (the hook should set it) |
PPFrame | $frame | PPFrame object to use for expanding any template variables |
Implemented in MediaWiki\HookContainer\HookRunner.