Jump to content

Manual:Hooks/APIGetAllowedParams

From mediawiki.org
APIGetAllowedParams
Available from version 1.14.0
Use this hook to modify an API module's parameters
Define function:
public static function onAPIGetAllowedParams( ApiBase $module, array &$params, int $flags ) { ... }
Attach hook: In extension.json:
{
	"Hooks": {
		"APIGetAllowedParams": "MediaWiki\\Extension\\MyExtension\\Hooks::onAPIGetAllowedParams"
	}
}
Called from: File(s): api/ApiBase.php
Interface: APIGetAllowedParamsHook.php

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


Details

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