webNavigation.onBeforeNavigate

Fired when the browser is about to start a navigation event.

Syntax

chrome.webNavigation.onBeforeNavigate.addListener(
  function(details) {...}     // function
  filter                      // optional object
)
chrome.webNavigation.onBeforeNavigate.removeListener(listener)
chrome.webNavigation.onBeforeNavigate.hasListener(listener)

This API is also available as browser.webNavigation.onBeforeNavigate.*.

Events have three functions:

addListener(callback)

Adds a listener to this event.

removeListener(listener)

Stop listening to this event. The listener argument is the listener to remove.

hasListener(listener)

Check whether listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

callback

Function that will be called when this event occurs. The function will be passed the following arguments:

details

object. Details about the navigation event.

filterOptional

object. An object containing a single property url, which is an Array of events.UrlFilter objects. If you include this parameter, then the event will fire only for transitions to URLs which match at least one UrlFilter in the array. If you omit this parameter, the event will fire for all transitions. Note that filter is not supported in Firefox.

Additional objects

details

tabId

integer. The ID of the tab in which the navigation is about to occur.

url

string. The URL to which the given frame will navigate.

processId

integer. The ID of the process in which this tab is being rendered.

frameId

integer. Frame in which the navigation is about to occur. 0 indicates that navigation happens in the tab's top-level browsing context, not in a nested iframe. A positive value indicates that navigation happens in a nested iframe. Frame IDs are unique for a given tab and process.

parentFrameId

integer. ID of this frame's parent. Set to -1 if this is a top-level frame.

timeStamp

number. The time when the browser is about to start the navigation, in milliseconds since the epoch.

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.

Compatibility notes

Chrome

• If the filter parameter is empty, Chrome matches all URLs.

Edge

• Filtering is not supported.

Firefox

• Filtering is supported from version 50.
• If the filter parameter is empty, Firefox raises an exception.

Firefox for Android

• Filtering is supported from version 50.
• If the filter parameter is empty, Firefox raises an exception.

Opera

• If the filter parameter is empty, Opera matches all URLs.

Examples

Logs the target URLs for onBeforeNavigate, if the target's hostname contains "example.com" or starts with "developer".

var filter = {
  url:
  [
    {hostContains: "example.com"},
    {hostPrefix: "developer"}
  ]
}

function logOnBefore(details) {
  console.log("onBeforeNavigate to: " + details.url);
}

chrome.webNavigation.onBeforeNavigate.addListener(logOnBefore, filter);

// 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.