wiki.techinc.nl/includes/parser/Hook/PageRenderingHashHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

29 lines
887 B
PHP

<?php
namespace MediaWiki\Hook;
use User;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "PageRenderingHash" to register handlers implementing this interface.
*
* @stable to implement
* @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 );
}