wiki.techinc.nl/includes/parser/Hook/ParserGetVariableValueSwitchHook.php
daniel e6e0ad2472 Replace "@stable for implementation" with "@stable to implement"
For compliance with the new version of the table interface policy
(T255803).

This patch was created by an automated search & replace operation
on the includes/ directory.

Bug: T257789
Change-Id: I17e5e92e24c708ffc846945a136347670a3a20c7
2020-07-13 11:05:49 +02:00

30 lines
865 B
PHP

<?php
namespace MediaWiki\Hook;
use Parser;
use PPFrame;
/**
* @stable to implement
* @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
);
}