Manual:Hooks/APIGetParamDescription

Category:MediaWiki hooks#APIGetParamDescription Category:Hooks added in MediaWiki 1.14.0#APIGetParamDescription Category:MediaWiki deprecated or obsolete features#APIGetParamDescription Category:Hooks removed in MediaWiki 1.33.0#APIGetParamDescription Category:Hooks deprecated in MediaWiki 1.25.0#APIGetParamDescription
APIGetParamDescription
Available from version 1.14.0
Removed in version 1.33.0 (Gerrit change 465665)Category:Removed hooks#APIGetParamDescription
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": "MediaWiki\\Extension\\MyExtension\\Hooks::onAPIGetParamDescription"
	}
}
Called from: File(s): api/ApiBase.phpCategory:MediaWiki hooks included in ApiBase.php#APIGetParamDescription
Interface: APIGetParamDescriptionHook.php

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

Details

  • &$module: ApiBase object
  • $desc: Array of parameter descriptions
Category:Hooks added in MediaWiki 1.14.0 Category:Hooks deprecated in MediaWiki 1.25.0 Category:Hooks removed in MediaWiki 1.33.0 Category:MediaWiki deprecated or obsolete features Category:MediaWiki hooks Category:MediaWiki hooks included in ApiBase.php Category:Removed hooks