MediaWiki  master
MediaWiki\Hook\RejectParserCacheValueHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inheritance diagram for MediaWiki\Hook\RejectParserCacheValueHook:

Public Member Functions

 onRejectParserCacheValue ( $parserOutput, $wikiPage, $parserOptions)
 Use this hook to reject an otherwise usable cached value from the Parser cache. More...
 

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "RejectParserCacheValue" to register handlers implementing this interface.

Stable to implement

Definition at line 16 of file RejectParserCacheValueHook.php.

Member Function Documentation

◆ onRejectParserCacheValue()

MediaWiki\Hook\RejectParserCacheValueHook::onRejectParserCacheValue (   $parserOutput,
  $wikiPage,
  $parserOptions 
)

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
Parameters
ParserOutput$parserOutputParserOutput value
WikiPage$wikiPage
ParserOptions$parserOptions
Returns
bool|void True or no return value to continue, or false to reject an otherwise usable cached value from the Parser cache

Implemented in MediaWiki\HookContainer\HookRunner.


The documentation for this interface was generated from the following file: