wiki.techinc.nl/includes/parser/Hook/RejectParserCacheValueHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

33 lines
936 B
PHP

<?php
namespace MediaWiki\Hook;
use ParserOptions;
use ParserOutput;
use WikiPage;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "RejectParserCacheValue" to register handlers implementing this interface.
*
* @stable to implement
* @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
);
}