includes/api/Hook/APIGetDescriptionMessagesHook.php

   1 <?php
   2
   3 namespace MediaWiki\Api\Hook;
   4
   5 use MediaWiki\Api\ApiBase;
   6 use MediaWiki\Message\Message;
   7
   8 /**
   9  * This is a hook handler interface, see docs/Hooks.md.
  10  * Use the hook name "APIGetDescriptionMessages" to register handlers implementing this interface.
  11  *
  12  * @stable to implement
  13  * @ingroup Hooks
  14  */
  15 interface APIGetDescriptionMessagesHook {
  16         /**
  17          * Use this hook to modify a module's help message.
  18          *
  19          * @since 1.35
  20          *
  21          * @param ApiBase $module
  22          * @param Message[] &$msg
  23          * @return bool|void True or no return value to continue or false to abort
  24          */
  25         public function onAPIGetDescriptionMessages( $module, &$msg );
  26 }