Jump to content

Manual:$wgMessagesDirs

From mediawiki.org
Extensions: $wgMessagesDirs
Extension messages directories.
Introduced in version:1.24.0 (Gerrit change 102957; git #2f7b68ff)
Removed in version:Still in use
Allowed values:(array)
Default value:[]

A configurable global variable pointing to the path of a directory that contains message files. It works with associative arrays as demonstrated below. The message files are expected to be JSON files named for their language code, e.g. en.json, de.json, etc. Extensions with messages in multiple places may specify an array of message directories.

The modern approach that is recommended for extensions is not to use $wgMessagesDirs directly but to use the equivalent key in extension.json.

Examples

A simple example:

PHP extension.json
$wgMessagesDirs['ConfirmEdit'] = __DIR__ . '/i18n';
"MessagesDirs": {
 "ConfirmEdit": [
  "i18n"
 ]
}

An example using multiple directories:

PHP extension.json
$wgMessagesDirs['VisualEditor'] = [
    __DIR__ . '/i18n',
    __DIR__ . '/modules/ve-core/i18n',
    __DIR__ . '/modules/qunit/localisation',
    __DIR__ . '/modules/oojs-ui/messages',
];
"MessagesDirs": {
 "VisualEditor": [
  "i18n",
  "modules/ve-core/i18n",
  "modules/qunit/localisation",
  "modules/oojs-ui/messages"
 ]
}

$wgMessagesDirs can co-exist with $wgExtensionMessagesFiles ; both should be set, if you want to preserve compatibility when converting old PHP l10n files.

See also