Open main menu

Manual:Hooks/APIGetParamDescription

APIGetParamDescription
Available from version 1.14.0
Removed in version 1.33.0
Use this hook to modify a module's parameter descriptions
Define function:
public static function onAPIGetParamDescription( ApiBase &$module, array &$desc ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"APIGetParamDescription": "MyExtensionHooks::onAPIGetParamDescription"
	}
}

For MediaWiki ≤1.25:

$wgHooks['APIGetParamDescription'][] = 'MyExtensionHooks::onAPIGetParamDescription';
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:APIGetParamDescription extensions.

DetailsEdit

  • &$module: ApiBase object
  • $desc: Array of parameter descriptions