Open Search

Description

The plugin creates an OpenSearch Document for your blog.

It supports Google Chromes “Tab to Search” and “search_provider” WebExtension, Firefox’ “OpenSearch plugins”, Safaris “Quick Website Search”, and “custom searches” for Microsofts Edge browser.

From the spec:

Search clients can use OpenSearch description documents to learn about the public interface of a search engine. These description documents contain parameterized URL templates that indicate how the search client should make search requests. Search engines can use the OpenSearch response elements to add search metadata to results in a variety of content formats.

Other integrations and extensions:

Screenshots

  • Firefox OpenSearch plugins
  • Safari Quick Website Search
  • Chrome Tab to Search

Installation

  1. Upload open-search-document-folder to the /wp-content/plugins/ directory
  2. Activate the plugin through the Plugins menu in WordPress
  3. that’s it 🙂

FAQ

Chromes “Tab to Search” no longer works

Chromes “Tab to Search” is now an opt-in feature. Go to chrome://settings/searchEngines, search for your Website and press the “Activate” button.

How to add query params to the Search-URLs

You can add custom params to the search URL using the osd_search_url_template filter.

function custom_osd_extend( $url, $type ) {
    $url = add_query_arg( 'mtm_campaign', 'opensearch', $url );

    return $url;
}
add_filter( 'osd_search_url_template', 'custom_osd_extend', 10, 2 );

Reviews

April 10, 2020
Thanks for this nifty plugin! Perfect! You might want to add some documentation since it's very hidden how it works. 1) After activating the plugin, a <link rel="search"> tag is added to the header of your webpages. 2) This link points to https://domain.com/wp-json/opensearch/1.1/document and produces an XML document. 3) This document.osdx contains the OpenSearch specification for your website. 4) An additional use case, is downloading this file to your Windows machine. Then you can double-click it to install a search connector to Windows. This lets you search your own website directly from your Windows and Explorer search bars. Just type the first letters of your website name to get it going! Best, Marc
January 17, 2018
Plugin works exactly as it should. I was looking for a plugin that activates on the web in google chrome search using the TAB key. Thanks a lot.
Read all 4 reviews

Contributors & Developers

“Open Search” is open source software. The following people have contributed to this plugin.

Contributors

“Open Search” has been translated into 1 locale. Thank you to the translators for their contributions.

Translate “Open Search” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

4.1.1

  • fix PHP deprecated: strstr(): Passing null to parameter

4.1.0

4.0.1

  • fix broken XML output

4.0.0

  • modernize code
  • added filters for the search URLs in the OSD document

3.0.3

  • fix missing permission callback

3.0.2

  • update requirements

3.0.1

  • added screenshots
  • code improvements

3.0.0

  • moved to WordPress API

2.1.2

  • fixed site icon implementation

2.1.1

  • fixed site icon implementation

2.1.0

  • fixed XML output
  • encapsulated XML data

2.0.0

  • complete refactoring
  • WordPress coding style
  • Site icon support

1.3.1

  • Some smaller fixes

1.3

  • fixed host-meta link
  • added webfinger support

1.2.2

  • Added function to flush rewrite_rules

1.2.1

  • Autodiscovery for host-meta

1.2

  • OpenSearch Suggestions extension

1.1

  • WordPress 2.8.x compatibility
  • Autodiscovery for RSS/Atom and XRDS
  • Profile-Services

1.0

  • Initial release