Manual:Hooks/RejectParserCacheValue

From MediaWiki.org
Jump to navigation Jump to search
RejectParserCacheValue
Available from version 1.26.0 (Gerrit change I660679a48c)
Return false to reject an otherwise usable cached value from the Parser cache.
Define function:
public static function onRejectParserCacheValue( $parserOutput, $wikiPage, $parserOptions ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"RejectParserCacheValue": "MyExtensionHooks::onRejectParserCacheValue"
	}
}

For MediaWiki ≤1.25:

$wgHooks['RejectParserCacheValue'][] = 'MyExtensionHooks::onRejectParserCacheValue';
Called from:File(s): ParserCache.php

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:RejectParserCacheValue extensions.

Summary[edit]

Warning Warning: Misuse of this hook can effectively disable the parser cache, with serious consequences for high-traffic installations. Use with extreme care.

This hook allows extensions to reject an otherwise-successful parser cache lookup. The intent is to allow extensions to manage the eviction of archaic HTML output from the cache.

Details[edit]

  • $parserOutput: ParserOutput value.
  • $wikiPage: WikiPage object.
  • $parserOptions: ParserOptions object.