MediaWiki master
MediaWiki\Api\Hook\APIGetAllowedParamsHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\Api\ApiHookRunner.

Public Member Functions

 onAPIGetAllowedParams ( $module, &$params, $flags)
 Use this hook to modify a module's parameters.
 

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "APIGetAllowedParams" to register handlers implementing this interface.

Stability: stable
to implement

Definition at line 14 of file APIGetAllowedParamsHook.php.

Member Function Documentation

◆ onAPIGetAllowedParams()

MediaWiki\Api\Hook\APIGetAllowedParamsHook::onAPIGetAllowedParams ( $module,
& $params,
$flags )

Use this hook to modify a module's parameters.

Since
1.35
Parameters
ApiBase$module
array&$paramsArray of parameters
int$flagsZero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\Api\ApiHookRunner.


The documentation for this interface was generated from the following file: