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

26 lines
719 B
PHP

<?php
namespace MediaWiki\Hook;
use OutputPage;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "OutputPageBeforeHTML" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface OutputPageBeforeHTMLHook {
/**
* This hook is called when a page has been processed by the parser and the
* resulting HTML is about to be displayed.
*
* @since 1.35
*
* @param OutputPage $out OutputPage object that corresponds to the page
* @param string &$text Text that will be displayed, in HTML
* @return bool|void This hook must not abort, it must return true or null.
*/
public function onOutputPageBeforeHTML( $out, &$text );
}