Extension:Translate/Hooks/TranslateGetAPIMessageGroupsParameterDescs

From mediawiki.org
Jump to navigation Jump to search
TranslateGetAPIMessageGroupsParameterDescs
Available from version ??? (Gerrit change 19457)
Removed in version gerrit:272711
Provides an opportunity to document any parameters added with 'TranslateGetAPIMessageGroupsParameterList'.
Define function:
public static function onTranslateGetAPIMessageGroupsParameterDescs( &$paramDescs, $p ) { ... }
Attach hook:
$wgHooks['TranslateGetAPIMessageGroupsParameterDescs'][] = 'MyExtensionHooks::onTranslateGetAPIMessageGroupsParameterDescs';
Called from:File(s): Translate / api/ApiQueryMessageGroups.php
Function(s): getParamDescription

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

Details[edit]

  • array &$paramDescs: An associative array of parameters, name => description.
  • string $p: The prefix for action=query&meta=messagegroups (currently mg, but could change), useful for documentation