Add-ons

extension.getBackgroundPage()

Alias for runtime.getBackgroundPage().

Note: This method cannot be used in Private Browsing mode — it always returns an empty array. For more info see bug 1329304.

Syntax

var page = browser.extension.getBackgroundPage()

Parameters

None.

Return value

object. Window of the background page.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic support Yes Yes4548 Yes

Examples

Suppose a background script defines a function foo():

// background.js

function foo() {
  console.log("I'm defined in background.js");
}

A script running in a popup can call this function directly like this:

// popup.js

var page = browser.extension.getBackgroundPage();
page.foo(); // -> "I'm defined in background.js"

Example extensions

Acknowledgements

This API is based on Chromium's chrome.extension API. This documentation is derived from extension.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: andymckay-github, wbamberg, Makyen
 Last updated by: andymckay-github,