wiki.techinc.nl/includes/parser/Hook/RejectParserCacheValueHook.php
James D. Forrester 9bfb75ff90 Namespace ParserOutput
Most used non-namespaced class!

Bug: T353458
Change-Id: I4c2cbb0a808b3881a4d6ca489eee5d8c8ebf26cf
2023-12-14 14:57:34 -05:00

33 lines
953 B
PHP

<?php
namespace MediaWiki\Hook;
use MediaWiki\Parser\ParserOutput;
use ParserOptions;
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
);
}