MediaWiki\Output\Hook\OutputPageBeforeHTMLHook Interface Reference

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

Inherited by MediaWiki\Api\ApiHookRunner, and MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onOutputPageBeforeHTML ( $out, &$text)
	This hook is called when a page has been processed by the parser and the resulting HTML is about to be displayed.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file OutputPageBeforeHTMLHook.php.

Member Function Documentation

onOutputPageBeforeHTML()

MediaWiki\Output\Hook\OutputPageBeforeHTMLHook::onOutputPageBeforeHTML	(		$out,
		&	$text )

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

Parameters

OutputPage	$out	OutputPage object that corresponds to the page
string	&$text	Text that will be displayed, in HTML

Returns

bool|void This hook must not abort, it must return true or null.

Implemented in MediaWiki\Api\ApiHookRunner, and MediaWiki\HookContainer\HookRunner.

---

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

• includes/Output/Hook/OutputPageBeforeHTMLHook.php