Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
1 | <?php |
2 | |
3 | namespace MediaWiki\Hook; |
4 | |
5 | use MediaWiki\Parser\ParserOutput; |
6 | use ParserOptions; |
7 | use WikiPage; |
8 | |
9 | /** |
10 | * This is a hook handler interface, see docs/Hooks.md. |
11 | * Use the hook name "RejectParserCacheValue" to register handlers implementing this interface. |
12 | * |
13 | * @stable to implement |
14 | * @ingroup Hooks |
15 | */ |
16 | interface RejectParserCacheValueHook { |
17 | /** |
18 | * Use this hook to reject an otherwise usable cached value from the Parser cache. |
19 | * NOTE: CARELESS USE OF THIS HOOK CAN HAVE CATASTROPHIC CONSEQUENCES |
20 | * FOR HIGH-TRAFFIC INSTALLATIONS. USE WITH EXTREME CARE. |
21 | * |
22 | * @since 1.35 |
23 | * |
24 | * @param ParserOutput $parserOutput ParserOutput value |
25 | * @param WikiPage $wikiPage |
26 | * @param ParserOptions $parserOptions |
27 | * @return bool|void True or no return value to continue, or false to reject |
28 | * an otherwise usable cached value from the Parser cache |
29 | */ |
30 | public function onRejectParserCacheValue( $parserOutput, $wikiPage, |
31 | $parserOptions |
32 | ); |
33 | } |