CustomEditorHook.php
No OneTemporary
Actions

Size

716 B

Referenced Files

None

Subscribers

None

CustomEditorHook.php
View Options

	<?php

	namespace MediaWiki\Hook;

	use MediaWiki\Page\Article;
	use MediaWiki\User\User;

	/**
	* This is a hook handler interface, see docs/Hooks.md.
	* Use the hook name "CustomEditor" to register handlers implementing this interface.
	*
	* @stable to implement
	* @ingroup Hooks
	*/
	interface CustomEditorHook {
	/**
	* This hook is called when invoking the page editor.
	*
	* @since 1.35
	*
	* @param Article $article Article being edited
	* @param User $user User performing the edit
	* @return bool\|void True or no return value to allow the normal editor to be used.
	* False if implementing a custom editor, e.g. for a special namespace, etc.
	*/
	public function onCustomEditor( $article, $user );
	}