MDN wants to learn about developers like you: https://qsurvey.mozilla.com/s3/MDN-dev-survey

Add-ons

i18n.getMessage()

Gets the localized string for the specified message.

Syntax

browser.i18n.getMessage(
  messageName,  // string
  substitutions // optional any
)

Parameters

messageName
string. The name of the message, as specified in the messages.json file. If the message can't be found in messages.json:
  • Firefox returns "" and logs an error.
  • Chrome returns "" and does not log an error.
substitutionsOptional
string or array of string. A single substitution string, or an array of substitution strings.
In Chrome, if you supply more than 9 substitution strings, getMessage() will return undefined.

Return value

string. Message localized for current locale.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic support17Yes 1 2454815
1. Throws an exception instead returning an empty string if the message does not exist.
2. Expects substitutions to be strings, while other browsers allow any value which is then converted to a string.

Examples

Get the localized string for "messageContent", with target.url substituted:

var message = browser.i18n.getMessage("messageContent", target.url);
console.log(message);

This would work with a _locales/en/messages.json file containing:

{
  "messageContent": {
    "message": "You clicked $URL$.",
    "description": "Tells the user which link they clicked.",
    "placeholders": {
      "url" : {
        "content" : "$1",
        "example" : "https://developer.mozilla.org"
      }
    }
  }
}

If target.url is "https://developer.mozilla.org", then the value of message, in the "en" locale, would be:

"You clicked https://developer.mozilla.org."

Example extensions

Acknowledgements

This API is based on Chromium's chrome.i18n API. This documentation is derived from i18n.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: yfdyh000, wbamberg, Makyen
 Last updated by: yfdyh000,