MediaWiki  master
MediaWiki\Hook\PageRenderingHashHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\PageRenderingHashHook:

Public Member Functions

 onPageRenderingHash (&$confstr, $user, &$forOptions)
 NOTE: Consider using ParserOptionsRegister instead. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file PageRenderingHashHook.php.

Member Function Documentation

◆ onPageRenderingHash()

MediaWiki\Hook\PageRenderingHashHook::onPageRenderingHash ( $confstr,
  $user,
$forOptions 
)

NOTE: Consider using ParserOptionsRegister instead.

Use this hook to alter the parser cache option hash key. A parser extension which depends on user options should install this hook and append its values to the key.

Since
1.35
Parameters
string&$confstrReference to a hash key string which can be modified
User$userUser requesting the page
array&$forOptionsArray of options the hash is for
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


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