includes/api/Hook/APIGetAllowedParamsHook.php

   1 <?php
   2
   3 namespace MediaWiki\Api\Hook;
   4
   5 use MediaWiki\Api\ApiBase;
   6
   7 /**
   8  * This is a hook handler interface, see docs/Hooks.md.
   9  * Use the hook name "APIGetAllowedParams" to register handlers implementing this interface.
  10  *
  11  * @stable to implement
  12  * @ingroup Hooks
  13  */
  14 interface APIGetAllowedParamsHook {
  15         /**
  16          * Use this hook to modify a module's parameters.
  17          *
  18          * @since 1.35
  19          *
  20          * @param ApiBase $module
  21          * @param array &$params Array of parameters
  22          * @param int $flags Zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
  23          * @return bool|void True or no return value to continue or false to abort
  24          */
  25         public function onAPIGetAllowedParams( $module, &$params, $flags );
  26 }