events.UrlFilter

Filters URLs for various criteria. If any of the given criteria match, then the whole filter matches.

All criteria are case sensitive.

Type

Values of this type are objects. They contain the following properties:

hostContainsOptional
string. Matches if the hostname of the URL contains the given string.
  • To test whether a hostname component starts with "foo", use ".foo". This matches "www.foobar.com" and "foo.com", because an implicit dot is added at the beginning of the hostname.
  • To test whether a hostname component ends with "foo", use "foo.".
  • To test whether a hostname component exactly matches "foo", use ".foo.".

However, note that these last two patterns will not match the last component of the hostname, because no implicit dot is added at the end of the hostname. So for example, "org." will match "https://borg.com" but not "https://example.org". To match these patterns, use hostSuffix.

hostEqualsOptional
string. Matches if the hostname of the URL is equal to a specified string.
hostPrefixOptional
string. Matches if the hostname of the URL starts with a specified string.
hostSuffixOptional
string. Matches if the hostname of the URL ends with a specified string.
pathContainsOptional
string. Matches if the path segment of the URL contains a specified string.
pathEqualsOptional
string. Matches if the path segment of the URL is equal to a specified string.
pathPrefixOptional
string. Matches if the path segment of the URL starts with a specified string.
pathSuffixOptional
string. Matches if the path segment of the URL ends with a specified string.
queryContainsOptional
string. Matches if the query segment of the URL contains a specified string.
queryEqualsOptional
string. Matches if the query segment of the URL is equal to a specified string.
queryPrefixOptional
string. Matches if the query segment of the URL starts with a specified string.
querySuffixOptional
string. Matches if the query segment of the URL ends with a specified string.
urlContainsOptional
string. Matches if the URL (without fragment identifier) contains a specified string. Port numbers are stripped from the URL if they match the default port number.
urlEqualsOptional
string. Matches if the URL (without fragment identifier) is equal to a specified string. Port numbers are stripped from the URL if they match the default port number.
urlMatchesOptional
string. Matches if the URL (without fragment identifier) matches a specified regular expression. Port numbers are stripped from the URL if they match the default port number.
originAndPathMatchesOptional
string. Matches if the URL without query segment and fragment identifier matches a specified regular expression. Port numbers are stripped from the URL if they match the default port number.
urlPrefixOptional
string. Matches if the URL (without fragment identifier) starts with a specified string. Port numbers are stripped from the URL if they match the default port number.
For example: "https://developer" matches "https://developer.mozilla.org/" and "https://developers.facebook.com/".
urlSuffixOptional
string. Matches if the URL (without fragment identifier) ends with a specified string. Port numbers are stripped from the URL if they match the default port number. Note that an implicit forward slash "/" is added after the host, so "com/" matches "https://example.com", but "com" does not.
schemesOptional
array of string. Matches if the scheme of the URL is equal to any of the schemes specified in the array. Because schemes are always converted to lowercase, this should always be given in lowercase or it will never match.
For example: ["https"] will match only HTTPS URLs.
portsOptional
array of (integer or array of integer). An array which may contain integers and arrays of integers. Integers are interpreted as port numbers, while arrays of integers are interpreted as port ranges. Matches if the port of the URL matches any port numer or is contained in any ranges.
For example: [80, 443, [1000, 1200]] matches all requests on ports 80, 443, and in the range 1000-1200.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 50.0 50.0 33

Acknowledgements

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