2020-03-03 22:50:34 +00:00
|
|
|
<?php
|
|
|
|
|
|
2024-02-06 17:22:55 +00:00
|
|
|
namespace MediaWiki\Output\Hook;
|
2020-03-03 22:50:34 +00:00
|
|
|
|
2023-09-05 17:31:53 +00:00
|
|
|
use MediaWiki\Output\OutputPage;
|
2020-03-16 23:31:05 +00:00
|
|
|
|
2020-03-03 22:50:34 +00:00
|
|
|
/**
|
2020-09-26 13:18:43 +00:00
|
|
|
* This is a hook handler interface, see docs/Hooks.md.
|
|
|
|
|
* Use the hook name "OutputPageBeforeHTML" to register handlers implementing this interface.
|
|
|
|
|
*
|
2020-07-13 09:05:49 +00:00
|
|
|
* @stable to implement
|
2020-03-03 22:50:34 +00:00
|
|
|
* @ingroup Hooks
|
|
|
|
|
*/
|
|
|
|
|
interface OutputPageBeforeHTMLHook {
|
|
|
|
|
/**
|
2020-03-16 23:31:05 +00:00
|
|
|
* This hook is called when a page has been processed by the parser and the
|
2020-03-03 22:50:34 +00:00
|
|
|
* resulting HTML is about to be displayed.
|
|
|
|
|
*
|
|
|
|
|
* @since 1.35
|
|
|
|
|
*
|
2020-03-16 23:31:05 +00:00
|
|
|
* @param OutputPage $out OutputPage object that corresponds to the page
|
|
|
|
|
* @param string &$text Text that will be displayed, in HTML
|
2020-03-03 22:50:34 +00:00
|
|
|
* @return bool|void This hook must not abort, it must return true or null.
|
|
|
|
|
*/
|
|
|
|
|
public function onOutputPageBeforeHTML( $out, &$text );
|
|
|
|
|
}
|
2024-02-06 17:22:55 +00:00
|
|
|
|
2024-07-05 16:16:27 +00:00
|
|
|
/** @deprecated class alias since 1.42 */
|
2024-02-06 17:22:55 +00:00
|
|
|
class_alias( OutputPageBeforeHTMLHook::class, 'MediaWiki\Hook\OutputPageBeforeHTMLHook' );
|