includes/api/Hook/ApiDeprecationHelpHook.php

   1 <?php
   2
   3 namespace MediaWiki\Api\Hook;
   4
   5 use MediaWiki\Message\Message;
   6
   7 /**
   8  * This is a hook handler interface, see docs/Hooks.md.
   9  * Use the hook name "ApiDeprecationHelp" to register handlers implementing this interface.
  10  *
  11  * @stable to implement
  12  * @ingroup Hooks
  13  */
  14 interface ApiDeprecationHelpHook {
  15         /**
  16          * Use this hook to add messages to the 'deprecation-help' warning generated
  17          * from ApiBase::addDeprecation().
  18          *
  19          * @since 1.35
  20          *
  21          * @param Message[] &$msgs Messages to include in the help. Multiple messages will be
  22          *   joined with spaces.
  23          * @return bool|void True or no return value to continue or false to abort
  24          */
  25         public function onApiDeprecationHelp( &$msgs );
  26 }