bookmarks.search()

The bookmarks.search() function searches for bookmarks matching the given query. Matching bookmarks are passed into the specified callback function asbgh an array of bookmarks.BookmarkTreeNode objects.

This function throws an exception if any of the input parameters are invalid or are not of an appropriate type; look in the console for the error message. The exceptions don't have error IDs, and the messages themselves may change, so don't write code that tries to interpret them.

Syntax

chrome.bookmarks.search(
  query,                  // string or object
  function(               // function
    results                 // array of BookmarkTreeNode objects
  ) {...}
)

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

Parameters

query

A string or object describing the query to perform.

If query is a string, it consists of zero or more search terms. Search terms are space-delimited and may be enclosed in quotes to allow multiple-word phrases to be searched against. Each search term matches if it matches any substring in the bookmark's URL or title. Matching is case-insensitive. For a bookmark to match the query, all the query's search terms must match.

If query is an object, it has zero or more of the following 3 properties: query, title, and url, which are described below. For a bookmark to match the query, all provided properties terms must match the specified values.

query Optional

A string specifying one or more terms to match against; the format is identical to the string form of the query parameter. If this isn't a string, an exception is thrown.

url Optional

A string which must exactly match the bookmark's URL. Matching is case-insensitive, and trailing slashes are ignored.

If you pass an invalid URL here, the function will throw an exception.

title Optional

A string This must exactly match the bookmark's title. Matching is case-sensitive.

callback

A function to be called when the query results have been retrieved. The function is passed the following arguments:

results

An array of bookmarks.BookmarkTreeNode objects, each representing a single matching bookmark. The array is empty if no results were found.

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.

Example

This example logs the IDs of all bookmarks:

function onGot(bookmarkItems) {
  for (item of bookmarkItems) {
    console.log(item.id);
  }
}

chrome.bookmarks.search({}, onGot);

This example looks to see if the currently active tab is bookmarked:

function onGot(bookmarkItems) {
  if (bookmarkItems.length) {
    console.log("active tab is bookmarked");
  } else {
    console.log("active tab is not bookmarked");
  }
}

function checkActiveTab(tab) {
  chrome.bookmarks.search({url: tab.url}, onGot);
}

chrome.browserAction.onClicked.addListener(checkActiveTab);

Example add-ons

• Bookmark it!

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