includes/Hook/EditPage__showReadOnlyForm_initialHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 // phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
   6 use MediaWiki\EditPage\EditPage;
   7 use OutputPage;
   8
   9 /**
  10  * This is a hook handler interface, see docs/Hooks.md.
  11  * Use the hook name "EditPage::showReadOnlyForm:initial" to register handlers implementing this interface.
  12  *
  13  * @stable to implement
  14  * @ingroup Hooks
  15  */
  16 interface EditPage__showReadOnlyForm_initialHook {
  17         /**
  18          * This hook is similar to EditPage::showEditForm:initial
  19          * but for the read-only 'view source' variant of the edit form.
  20          *
  21          * @since 1.35
  22          *
  23          * @param EditPage $editor
  24          * @param OutputPage $out OutputPage instance to write to
  25          * @return bool|void Return value is ignored; this hook should always return true
  26          */
  27         public function onEditPage__showReadOnlyForm_initial( $editor, $out );
  28 }