includes/Hook/EditFormPreloadTextHook.php

   1 <?php
   2
   3 namespace MediaWiki\Hook;
   4
   5 use MediaWiki\Title\Title;
   6
   7 /**
   8  * This is a hook handler interface, see docs/Hooks.md.
   9  * Use the hook name "EditFormPreloadText" to register handlers implementing this interface.
  10  *
  11  * @stable to implement
  12  * @ingroup Hooks
  13  */
  14 interface EditFormPreloadTextHook {
  15         /**
  16          * Use this hook to populate the edit form when creating pages.
  17          *
  18          * @since 1.35
  19          *
  20          * @param string &$text Text to preload with
  21          * @param Title $title Page being created
  22          * @return bool|void True or no return value to continue or false to abort
  23          */
  24         public function onEditFormPreloadText( &$text, $title );
  25 }