MediaWiki\Hook\EditPage__showEditForm_initialHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\EditPage__showEditForm_initialHook:

Public Member Functions
	onEditPage__showEditForm_initial ( $editor, $out)
	This hook is called before showing the edit form.

Detailed Description

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

Use the hook name "EditPage::showEditForm:initial" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 16 of file EditPage__showEditForm_initialHook.php.

Member Function Documentation

onEditPage__showEditForm_initial()

MediaWiki\Hook\EditPage__showEditForm_initialHook::onEditPage__showEditForm_initial	(		$editor,
			$out )

This hook is called before showing the edit form.

Since

1.35

Parameters

EditPage	$editor
OutputPage	$out	OutputPage instance to write to

Returns

bool|void True or no return value without altering $error to allow the edit to continue. Modifying $error and returning true will cause the contents of $error to be echoed at the top of the edit form as wikitext. Return false to halt editing; you'll need to handle error messages, etc. yourself.

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/Hook/EditPage__showEditForm_initialHook.php