Open main menu

Manual:Hooks/APIGetParamDescription

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

In extension.json:

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

For MediaWiki ≤1.25:

$wgHooks['APIGetParamDescription'][] = 'MyExtensionHooks::onAPIGetParamDescription';
Called from:File(s): 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 Module object
  • $desc: Array of parameter descriptions