MediaWiki\Hook\EditPageGetPreviewContentHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\EditPageGetPreviewContentHook:

Public Member Functions
	onEditPageGetPreviewContent ( $editPage, &$content)
	Use this hook to modify the wikitext that will be previewed.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 15 of file EditPageGetPreviewContentHook.php.

Member Function Documentation

onEditPageGetPreviewContent()

MediaWiki\Hook\EditPageGetPreviewContentHook::onEditPageGetPreviewContent	(		$editPage,
		&	$content
	)

Use this hook to modify the wikitext that will be previewed.

Note that it is preferable to implement previews for different data types using the ContentHandler facility.

Since

1.35

Parameters

EditPage	$editPage
Content	&$content	Content object to be previewed (may be replaced by hook function)

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/Hook/EditPageGetPreviewContentHook.php