Open main menu

Manual:Hooks/APIGetAllowedParams

< Manual:Hooks
APIGetAllowedParams
Available from version 1.14.0
Use this hook to modify a module's parameters
Define function:
public static function onAPIGetAllowedParams( ApiBase &$module, array &$params, int $flags ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"APIGetAllowedParams": "MyExtensionHooks::onAPIGetAllowedParams"
	}
}

For MediaWiki ≤1.25:

$wgHooks['APIGetAllowedParams'][] = 'MyExtensionHooks::onAPIGetAllowedParams';
Called from:File(s): api/ApiBase.php

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:APIGetAllowedParams extensions.

DetailsEdit

  • $module: ApiBase object
  • $params: Array of parameters
  • $flags: int zero or OR-ed flags like ApiBase::GET_VALUES_FOR_HELP