Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

cookies.remove()

The remove() method of the cookies API deletes a cookie, given its name and URL.

The call succeeds only if you include the "cookies" API permission in your manifest.json file, as well as host permissions for the given URL specified in its manifest.

Syntax

chrome.cookies.remove(
  details,                // object
  function(details) {...} // optional callback function
)

This API is also available as browser.cookies.remove() in a version that returns a promise.

Parameters

details
An object containing information to identify the cookie to remove. It contains the following properties:
url
A string representing the URL associated with the cookie. If the add-on does not have host permissions for this URL, the API call will fail.
name
A string representing the name of the cookie to remove.
storeIdOptional
A string representing the ID of the cookie store to find the cookie in. If unspecified, the cookie is looked for by default in the current execution context's cookie store.
callbackOptional
A callback function, which is passed acookies.Cookie object containing details about the cookie that's been removed. If the call fails for any reason, this will be given a value of null, and runtime.lastError will be set.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 45.0 48.0 33

Examples

In the following snippet (taken from the cookie-bg-picker example), we are removing a cookie containing background customization preferences when a reset button is clicked. When the button is clicked, we:

  • get the current tab using tabs.query().
  • send a message to the extension's content script using tabs.sendMessage() to tell it to remove any background customizations from the current page.
  • empty the contents of the cookieVal object, which is simply a local representation of the cookie's current value for the current page.
  • remove the actual cookie using a call to remove().
reset.onclick = function() {
  chrome.tabs.query({active: true, currentWindow: true}, function(tabs) {
    chrome.tabs.sendMessage(tabs[0].id, {reset: true});

    cookieVal = { image : '',
                  color : '' };
    chrome.cookies.remove({
      url: tabs[0].url,
      name: "bgpicker"
    })
  });
}

Example add-ons

Acknowledgements

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