wiki.techinc.nl/includes/Hook/EditPage__showEditForm_initialHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

30 lines
955 B
PHP

<?php
namespace MediaWiki\Hook;
// phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
use EditPage;
use OutputPage;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "EditPage::showEditForm:initial" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface EditPage__showEditForm_initialHook {
/**
* This hook is called before showing the edit form.
*
* @since 1.35
*
* @param EditPage $editor
* @param OutputPage $out OutputPage instance to write to
* @return 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.
*/
public function onEditPage__showEditForm_initial( $editor, $out );
}