c44488f725
Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
30 lines
787 B
PHP
30 lines
787 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Hook;
|
|
|
|
use ParserOptions;
|
|
use ParserOutput;
|
|
use WikiPage;
|
|
|
|
/**
|
|
* @stable for implementation
|
|
* @ingroup Hooks
|
|
*/
|
|
interface RejectParserCacheValueHook {
|
|
/**
|
|
* Use this hook to reject an otherwise usable cached value from the Parser cache.
|
|
* NOTE: CARELESS USE OF THIS HOOK CAN HAVE CATASTROPHIC CONSEQUENCES
|
|
* FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH EXTREME CARE.
|
|
*
|
|
* @since 1.35
|
|
*
|
|
* @param ParserOutput $parserOutput ParserOutput value
|
|
* @param WikiPage $wikiPage
|
|
* @param ParserOptions $parserOptions
|
|
* @return bool|void True or no return value to continue, or false to reject
|
|
* an otherwise usable cached value from the Parser cache
|
|
*/
|
|
public function onRejectParserCacheValue( $parserOutput, $wikiPage,
|
|
$parserOptions
|
|
);
|
|
}
|