wiki.techinc.nl/includes/parser/Hook/PageRenderingHashHook.php
apaskulin c44488f725 docs: Hook interface doc comment review
Edited doc comments for hook interfaces to improve
consistency and add type hints.

Bug: T246855
Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
2020-04-21 09:10:08 +10:00

26 lines
743 B
PHP

<?php
namespace MediaWiki\Hook;
use User;
/**
* @stable for implementation
* @ingroup Hooks
*/
interface PageRenderingHashHook {
/**
* 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
*
* @param string &$confstr Reference to a hash key string which can be modified
* @param User $user User requesting the page
* @param array &$forOptions Array of options the hash is for
* @return bool|void True or no return value to continue or false to abort
*/
public function onPageRenderingHash( &$confstr, $user, &$forOptions );
}