Manual:Hooks/APIGetParamDescriptionMessages
| APIGetParamDescriptionMessages | |
|---|---|
| Available from version 1.25.0 (Gerrit change 160798) Allows to modify a module's parameter descriptions | |
| Define function: | public static function onAPIGetParamDescriptionMessages( ApiBase $module, array &$messages ) { ... }
|
| Attach hook: | In extension.json:
{
"Hooks": {
"APIGetParamDescriptionMessages": "MediaWiki\\Extension\\MyExtension\\Hooks::onAPIGetParamDescriptionMessages"
}
}
|
| Called from: | File(s): api/ApiBase.php Function(s): getFinalParamDescription |
| Interface: | APIGetParamDescriptionMessagesHook.php |
For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:APIGetParamDescriptionMessages extensions.
Details[edit]
$module- ApiBase object&$messages- Array of Message objects