MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

meta=messagegroups (mg)

(main | query | messagegroups)

This module requires read rights.
Source: Translate
License: GPL-2.0-or-later

Return information about message groups.

Note that the uselang parameter affects the output of language dependent parts.

Specific parameters:

Other general parameters are available.

mgdepth

When using the tree format, limit the depth to this many levels. Value 0 means that no subgroups are shown. If the limit is reached, the output includes a "groupcount" value, which states the number of direct children.

Type: integer

Default: 100

mgfilter

Only return messages with IDs that match one or more of the inputs given (case-insensitive, separated by pipes, * wildcard).

Separate values with | or alternative.

Maximum number of values is 50 (500 for clients that are allowed higher limits).

Default: (empty)

mgformat

In the tree format message groups can exist in multiple places in the tree.

One of the following values: flat, tree

Default: flat

mgiconsize

Preferred size of rasterised group icon.

Type: integer

Default: 64

mgprop

What translation-related information to get:

id: Include ID of the group.
label: Include label of the group.
description: Include description of the group.
class: Include class name of the group.
namespace: Include namespace of the group. Not all groups belong to a single namespace.
exists: Include self-calculated existence property of the group.
icon: Include URLs to icon of the group.
priority: Include priority status like discouraged.
prioritylangs: Include preferred languages. If not set, this returns false.
priorityforce: Include priority status - is the priority languages setting forced.
workflowstates: Include the workflow states for the message group.
sourcelanguage: Include the source language for the message group.

Values (separate with | or alternative): class, description, exists, icon, id, label, namespace, priority, priorityforce, prioritylangs, sourcelanguage, workflowstates

Default: id|label|description|class|exists

mgroot

When using the tree format, instead of starting from top level start from the given message group, which must be an aggregate message group. When using flat format only the specified group is returned.

Default: (empty)

mglanguageFilter

Only return message groups that can be translated to the given language.

Default: (empty)

Example:

Show message groups: api.php?action=query&meta=messagegroups [open in sandbox]