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

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

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

• cookie-bg-picker

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.