Add-ons

tabs.query()

Gets all tabs that have the specified properties, or all tabs if no properties are specified.

This is an asynchronous function that returns a Promise.

Syntax

var querying = browser.tabs.query(
  queryInfo             // object
)

Parameters

queryInfo
object. The query() function will only get tabs whose properties match the properties included here. To learn more about these properties, see the tabs.Tab documentation.
activeOptional
boolean. Whether the tabs are active in their windows.
audibleOptional
boolean. Whether the tabs are audible.
autoDiscardableOptional
boolean. Whether the tabs can be discarded automatically by the browser when resources are low.
cookieStoreId Optional
string. Use this to return only tabs whose cookie store ID is cookieStoreId. This option is only available if the extension has the "cookies" permission.
currentWindowOptional
boolean. Whether the tabs are in the current window.
discardedOptional
boolean. Whether the tabs are discarded. A discarded tab is one whose content has been unloaded from memory, but is still visible in the tab strip. Its content gets reloaded the next time it's activated.
highlightedOptional
boolean. Whether the tabs are highlighted.
indexOptional
integer. The position of the tabs within their windows.
mutedOptional
boolean. Whether the tabs are muted.
lastFocusedWindowOptional
boolean. Whether the tabs are in the last focused window.
openerTabIdOptional
integer. The ID of the tab that opened this tab.
pinnedOptional
boolean. Whether the tabs are pinned.
statusOptional
tabs.TabStatus. Whether the tabs have completed loading.
titleOptional
string. Match page titles against a pattern.
urlOptional
string or array of string. Match tabs against one or more match patterns. Note that fragment identifiers are not matched.
windowIdOptional
integer. The ID of the parent window, or windows.WINDOW_ID_CURRENT for the current window.
windowTypeOptional
tabs.WindowType. The type of window the tabs are in.

Return value

A Promise that will be fulfilled with an array of tabs.Tab objects, containing infomation about each matching tab. If any error occurs, the promise will be rejected with an error message.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic support Yes Yes14554 Yes
queryInfo.active Yes Yes4554 Yes
queryInfo.audible45 No455432
queryInfo.autoDiscardable54 No No No41
queryInfo.cookieStoreId No No52 No No
queryInfo.currentWindow19 Yes455415
queryInfo.discarded54 No575741
queryInfo.highlighted Yes No4554 Yes
queryInfo.index18 Yes455415
queryInfo.lastFocusedWindow19 Yes455415
queryInfo.muted45 No455432
queryInfo.openerTabId Yes No57 No Yes
queryInfo.pinned Yes No4554 Yes
queryInfo.status Yes Yes4554 Yes
queryInfo.title Yes Yes4554 Yes
queryInfo.url Yes Yes452 3542 3 Yes
queryInfo.windowId Yes Yes4554 Yes
queryInfo.windowType Yes Yes4554 Yes

1. The panel, app, devtools and popup values for WindowType are not supported.

2. Fails if the extension doesn't have the tabs permission.

3. Before Firefox 56, moz-extension:// URLs were not allowed.

Examples

Get all tabs:

function logTabs(tabs) {
  for (let tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({});
querying.then(logTabs, onError);

Get all tabs in the current window:

function logTabs(tabs) {
  for (let tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({currentWindow: true});
querying.then(logTabs, onError);

Get the active tab in the current window:

function logTabs(tabs) {
  for (let tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({currentWindow: true, active: true});
querying.then(logTabs, onError);

Get tabs for all HTTP and HTTPS URLs under "mozilla.org" or any of its subdomains:

function logTabs(tabs) {
  for (let tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({url: "*://*.mozilla.org/*"});
querying.then(logTabs, onError);

Get tabs for all moz-extension:// URLs:

function logTabs(tabs) {
  console.log(tabs);
  for (let tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({url: "moz-extension://*/*"});
querying.then(logTabs, onError);

Get tabs for this extension's URL:

function logTabs(tabs) {
  console.log(tabs);
  for (let tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({url: browser.extension.getURL("*")});
querying.then(logTabs, onError);

Example extensions

Acknowledgements

This API is based on Chromium's chrome.tabs API. This documentation is derived from tabs.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: wbamberg, andrewtruongmoz, snoack, serv-inc, craue, Makyen, baku, Jeremie
 Last updated by: wbamberg,