MediaWiki\Hook\AlternateEditPreviewHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\AlternateEditPreviewHook:

Public Member Functions
	onAlternateEditPreview ( $editPage, &$content, &$previewHTML, &$parserOutput)
	This hook is called before generating the preview of the page when editing ( EditPage::getPreviewText() ).

Detailed Description

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

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

Stability: stable

to implement

Definition at line 16 of file AlternateEditPreviewHook.php.

Member Function Documentation

onAlternateEditPreview()

MediaWiki\Hook\AlternateEditPreviewHook::onAlternateEditPreview	(		$editPage,
		&	$content,
		&	$previewHTML,
		&	$parserOutput
	)

This hook is called before generating the preview of the page when editing ( EditPage::getPreviewText() ).

Since

1.35

Parameters

EditPage	$editPage
Content	&$content	Content object for the text field from the edit page
string	&$previewHTML	Text to be placed into the page for the preview
ParserOutput	&$parserOutput	ParserOutput object for the preview

Returns

bool|void True or no return value to continue, or false and set $previewHTML and $parserOutput to output custom page preview HTML

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/Hook/AlternateEditPreviewHook.php