c44488f725
Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
30 lines
871 B
PHP
30 lines
871 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Hook;
|
|
|
|
use Parser;
|
|
use PPFrame;
|
|
|
|
/**
|
|
* @stable for implementation
|
|
* @ingroup Hooks
|
|
*/
|
|
interface ParserGetVariableValueSwitchHook {
|
|
/**
|
|
* This hook is called when the parser needs the value of a
|
|
* custom magic word.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param Parser $parser
|
|
* @param array &$variableCache Array to cache the value; when you return
|
|
* $variableCache[$magicWordId] should be the same as $ret
|
|
* @param string $magicWordId Index of the magic word (hook should not mutate it!)
|
|
* @param string &$ret Value of the magic word (the hook should set it)
|
|
* @param PPFrame $frame PPFrame object to use for expanding any template variables
|
|
* @return bool|void True or no return value to continue or false to abort
|
|
*/
|
|
public function onParserGetVariableValueSwitch( $parser, &$variableCache,
|
|
$magicWordId, &$ret, $frame
|
|
);
|
|
}
|