chrome.contentSettings

Description: Use the chrome.contentSettings API to change settings that control whether websites can use features such as cookies, JavaScript, and plug-ins. More generally speaking, content settings allow you to customize Chrome's behavior on a per-site basis instead of globally.
Availability: Since Chrome 16.
Permissions: "contentSettings"

Manifest

You must declare the "contentSettings" permission in your extension's manifest to use the API. For example:

      {
        "name": "My extension",
        ...
        "permissions": [
          "contentSettings"
        ],
        ...
      }
      

Content setting patterns

You can use patterns to specify the websites that each content setting affects. For example, http://*.youtube.com/* specifies youtube.com and all of its subdomains. The syntax for content setting patterns is the same as for match patterns, with a few differences:

  • For http, https, and ftp URLs, the path must be a wildcard (/*). For file URLs, the path must be completely specified and must not contain wildcards.
  • In contrast to match patterns, content setting patterns can specify a port number. If a port number is specified, the pattern only matches websites with that port. If no port number is specified, the pattern matches all ports.

Pattern precedence

When more than one content setting rule applies for a given site, the rule with the more specific pattern takes precedence.

For example, the following patterns are ordered by precedence:

  1. http://www.example.com/*
  2. http://*.example.com/* (matching example.com and all subdomains)
  3. <all_urls> (matching every URL)

Three kinds of wildcards affect how specific a pattern is:

  • Wildcards in the port (for example http://www.example.com:*/*)
  • Wildcards in the scheme (for example *://www.example.com:123/*)
  • Wildcards in the hostname (for example http://*.example.com:123/*)

If a pattern is more specific than another pattern in one part but less specific in another part, the different parts are checked in the following order: hostname, scheme, port. For example, the following patterns are ordered by precedence:

  1. http://www.example.com:*/*
    Specifies the hostname and scheme.
  2. *:/www.example.com:123/*
    Not as high, because although it specifies the hostname, it doesn't specify the scheme.
  3. http://*.example.com:123/*
    Lower because although it specifies the port and scheme, it has a wildcard in the hostname.

Primary and secondary patterns

The URL taken into account when deciding which content setting to apply depends on the content type. For example, for contentSettings.notifications settings are based on the URL shown in the omnibox. This URL is called the "primary" URL.

Some content types can take additional URLs into account. For example, whether a site is allowed to set a contentSettings.cookies is decided based on the URL of the HTTP request (which is the primary URL in this case) as well as the URL shown in the omnibox (which is called the "secondary" URL).

If multiple rules have primary and secondary patterns, the rule with the more specific primary pattern takes precedence. If there multiple rules have the same primary pattern, the rule with the more specific secondary pattern takes precedence. For example, the following list of primary/secondary pattern pairs is ordered by precedence:

PrecedencePrimary patternSecondary pattern
1 http://www.moose.com/*, http://www.wombat.com/*
2 http://www.moose.com/*, <all_urls>
3 <all_urls>, http://www.wombat.com/*
4 <all_urls>, <all_urls>

Resource identifiers

Resource identifiers allow you to specify content settings for specific subtypes of a content type. Currently, the only content type that supports resource identifiers is contentSettings.plugins, where a resource identifier identifies a specific plug-in. When applying content settings, first the settings for the specific plug-in are checked. If there are no settings found for the specific plug-in, the general content settings for plug-ins are checked.

For example, if a content setting rule has the resource identifier adobe-flash-player and the pattern <all_urls>, it takes precedence over a rule without a resource identifier and the pattern http://www.example.com/*, even if that pattern is more specific.

You can get a list of resource identifiers for a content type by calling the contentSettings.ContentSetting.getResourceIdentifiers method. The returned list can change with the set of installed plug-ins on the user's machine, but Chrome tries to keep the identifiers stable across plug-in updates.

Examples

You can find samples of this API on the sample page.

Summary

Types
ResourceIdentifier
ContentSetting
Properties
cookies
images
javascript
location
plugins
popups
notifications
fullscreen
mouselock
microphone
camera
unsandboxedPlugins
automaticDownloads

Types

ResourceIdentifier

The only content type using resource identifiers is contentSettings.plugins. For more information, see Resource Identifiers.
properties
string id

The resource identifier for the given content type.

string (optional) description

A human readable description of the resource.

ContentSetting

methods

clear

ContentSetting.clear(object details, function callback)

Clear all content setting rules set by this extension.

Parameters
object details
enum of "regular", or "incognito_session_only" (optional) scope

Where to clear the setting (default: regular). One of
regular: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),
incognito_session_only: setting for incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular settings).

function (optional) callback

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

get

ContentSetting.get(object details, function callback)

Gets the current content setting for a given pair of URLs.

Parameters
object details
string primaryUrl

The primary URL for which the content setting should be retrieved. Note that the meaning of a primary URL depends on the content type.

string (optional) secondaryUrl

The secondary URL for which the content setting should be retrieved. Defaults to the primary URL. Note that the meaning of a secondary URL depends on the content type, and not all content types use secondary URLs.

ResourceIdentifier (optional) resourceIdentifier

A more specific identifier of the type of content for which the settings should be retrieved.

boolean (optional) incognito

Whether to check the content settings for an incognito session. (default false)

function callback

The callback parameter should be a function that looks like this:

function(object details) {...};
object details
any setting

The content setting. See the description of the individual ContentSetting objects for the possible values.

set

ContentSetting.set(object details, function callback)

Applies a new content setting rule.

Parameters
object details
string primaryPattern

The pattern for the primary URL. For details on the format of a pattern, see Content Setting Patterns.

string (optional) secondaryPattern

The pattern for the secondary URL. Defaults to matching all URLs. For details on the format of a pattern, see Content Setting Patterns.

ResourceIdentifier (optional) resourceIdentifier

The resource identifier for the content type.

any setting

The setting applied by this rule. See the description of the individual ContentSetting objects for the possible values.

enum of "regular", or "incognito_session_only" (optional) scope

Where to set the setting (default: regular). One of
regular: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),
incognito_session_only: setting for incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular settings).

function (optional) callback

If you specify the callback parameter, it should be a function that looks like this:

function() {...};

getResourceIdentifiers

ContentSetting.getResourceIdentifiers(function callback)

Parameters
function callback

The callback parameter should be a function that looks like this:

function(array of ResourceIdentifier resourceIdentifiers) {...};
array of ResourceIdentifier (optional) resourceIdentifiers

A list of resource identifiers for this content type, or undefined if this content type does not use resource identifiers.

Properties

ContentSetting chrome.contentSettings.cookies Whether to allow cookies and other local data to be set by websites. One of
allow: Accept cookies,
block: Block cookies,
session_only: Accept cookies only for the current session.
Default is allow.
The primary URL is the URL representing the cookie origin. The secondary URL is the URL of the top-level frame.
ContentSetting chrome.contentSettings.images Whether to show images. One of
allow: Show images,
block: Don't show images.
Default is allow.
The primary URL is the URL of the top-level frame. The secondary URL is the URL of the image.
ContentSetting chrome.contentSettings.javascript Whether to run JavaScript. One of
allow: Run JavaScript,
block: Don't run JavaScript.
Default is allow.
The primary URL is the URL of the top-level frame. The secondary URL is not used.
ContentSetting chrome.contentSettings.location

Since Chrome 42. Warning: this is the current Dev channel. Learn more.

Whether to allow Geolocation. One of
allow: Allow sites to track your physical location,
block: Don't allow sites to track your physical location,
ask: Ask before allowing sites to track your physical location.
Default is ask.
The primary URL is the URL of the document which requested location data. The secondary URL is the URL of the top-level frame (which may or may not differ from the requesting URL).
ContentSetting chrome.contentSettings.plugins Whether to run plug-ins. One of
allow: Run plug-ins automatically,
block: Don't run plug-ins automatically.
Default is allow.
The primary URL is the URL of the top-level frame. The secondary URL is not used.
ContentSetting chrome.contentSettings.popups Whether to allow sites to show pop-ups. One of
allow: Allow sites to show pop-ups,
block: Don't allow sites to show pop-ups.
Default is block.
The primary URL is the URL of the top-level frame. The secondary URL is not used.
ContentSetting chrome.contentSettings.notifications Whether to allow sites to show desktop notifications. One of
allow: Allow sites to show desktop notifications,
block: Don't allow sites to show desktop notifications,
ask: Ask when a site wants to show desktop notifications.
Default is ask.
The primary URL is the URL of the document which wants to show the notification. The secondary URL is not used.
ContentSetting chrome.contentSettings.fullscreen

Since Chrome 42. Warning: this is the current Dev channel. Learn more.

Whether to allow sites to toggle the fullscreen mode. One of
allow: Allow sites to toggle the fullscreen mode,
ask: Ask when a site wants to toggle the fullscreen mode.
Default is ask.
The primary URL is the URL of the document which requested to toggle the fullscreen mode. The secondary URL is the URL of the top-level frame (which may or may not differ from the requesting URL).
ContentSetting chrome.contentSettings.mouselock

Since Chrome 42. Warning: this is the current Dev channel. Learn more.

Whether to allow sites to disable the mouse cursor. One of
allow: Allow sites to disable the mouse cursor,
block: Don't allow sites to disable the mouse cursor,
ask: Ask when a site wants to disable the mouse cursor.
Default is ask.
The primary URL is the URL of the top-level frame. The secondary URL is not used.
ContentSetting chrome.contentSettings.microphone

Since Chrome 42. Warning: this is the current Dev channel. Learn more.

Whether to allow sites to access the microphone. One of
allow: Allow sites to access the microphone,
block: Don't allow sites to access the microphone,
ask: Ask when a site wants to access the microphone.
Default is ask.
The primary URL is the URL of the document which requested microphone access. The secondary URL is not used.
ContentSetting chrome.contentSettings.camera

Since Chrome 42. Warning: this is the current Dev channel. Learn more.

Whether to allow sites to access the camera. One of
allow: Allow sites to access the camera,
block: Don't allow sites to access the camera,
ask: Ask when a site wants to access the camera.
Default is ask.
The primary URL is the URL of the document which requested camera access. The secondary URL is not used.
ContentSetting chrome.contentSettings.unsandboxedPlugins

Since Chrome 42. Warning: this is the current Dev channel. Learn more.

Whether to allow sites to run plug-ins unsandboxed. One of
allow: Allow sites to run plug-ins unsandboxed,
block: Don't allow sites to run plug-ins unsandboxed,
ask: Ask when a site wants to run a plug-in unsandboxed.
Default is ask.
The primary URL is the URL of the top-level frame. The secondary URL is not used.
ContentSetting chrome.contentSettings.automaticDownloads

Since Chrome 42. Warning: this is the current Dev channel. Learn more.

Whether to allow sites to download multiple files automatically. One of
allow: Allow sites to download multiple files automatically,
block: Don't allow sites to download multiple files automatically,
ask: Ask when a site wants to download files automatically after the first file.
Default is ask.
The primary URL is the URL of the top-level frame. The secondary URL is not used.