Title: Open Search Document
Author: Matthias Pfefferle
Published: 2007(e)ko ekainaren 24(a)
Last modified: 2026(e)ko irailaren 20(a)
---
Bilatu pluginak
# Open Search Document
[Matthias Pfefferle](https://profiles.wordpress.org/pfefferle/)-(r)en eskutik
[Deskargatu](https://downloads.wordpress.org/plugin/open-search-document.4.2.0.zip)
* [Xehetasunak](https://eu.wordpress.org/plugins/open-search-document/#description)
* [Berrikuspenak](https://eu.wordpress.org/plugins/open-search-document/#reviews)
* [Instalazioa](https://eu.wordpress.org/plugins/open-search-document/#installation)
* [Garapena](https://eu.wordpress.org/plugins/open-search-document/#developers)
[Laguntza](https://wordpress.org/support/plugin/open-search-document/)
## Deskripzioa
Browsers can learn how to search a website if the site tells them. This plugin adds
that information to your WordPress site, in the form of an [OpenSearch](https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md)
description document.
Once activated, visitors can add your site as a search engine in their browser,
or the browser picks it up on its own. Typing a keyword and a search term into the
address bar then searches your site instead of the web.
There is nothing to configure. Install it, activate it, done.
### What visitors get
* **Chrome and Edge**: your site shows up under “Site search” in the browser settings.
After activating it there, visitors type your domain, hit `Tab` and search your
site. Chrome calls this [“Tab to Search”](https://www.chromium.org/tab-to-search/).
* **Firefox**: the address bar offers to add your site as a search engine. Visitors
can also right click the address bar and pick “Add” ([OpenSearch in Firefox](https://developer.mozilla.org/en-US/docs/Web/XML/Guides/OpenSearch)).
* **Safari**: with [“Quick Website Search”](https://developer.apple.com/library/archive/releasenotes/General/WhatsNewInSafari/Articles/Safari_8_0.html)
enabled, Safari remembers your site after the first search and offers it in the
address bar.
* **Search suggestions**: while typing, the browser can show suggestions. The plugin
uses your tags for that.
* **Your site icon** is used as the icon of the search engine, if you have one
set under _Appearance > Customize > Site Identity_.
### What the plugin adds
* The OpenSearch description document at `/wp-json/opensearch/1.1/document`
* A suggestions endpoint at `/wp-json/opensearch/1.1/suggestions?s=…`
* Autodiscovery links in the [HTML head](https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md#autodiscovery-in-htmlxhtml)
and in the [Atom and RSS feeds](https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md#autodiscovery-in-rssatom)
* A search provider entry in the web app manifest, for the [“search_provider” WebExtension](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/chrome_settings_overrides)
setting
* Links in [host-meta](https://wordpress.org/plugins/host-meta/) and [WebFinger](https://wordpress.org/plugins/webfinger/),
if those plugins are installed
* Search URLs for the [Atom and RSS search responses](https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md#examples-of-opensearch-responses)
and the [OpenSearch Suggestions extension](https://github.com/dewitt/opensearch/blob/master/mediawiki/Specifications/OpenSearch/Extensions/Suggestions/1.1/Draft%201.wiki)
## Pantaila-argazkiak
[⌊Firefox OpenSearch plugins⌉⌊Firefox OpenSearch plugins⌉[
Firefox OpenSearch plugins
[⌊Safari Quick Website Search⌉⌊Safari Quick Website Search⌉[
Safari Quick Website Search
[⌊Chrome Tab to Search⌉⌊Chrome Tab to Search⌉[
Chrome Tab to Search
## Instalazioa
1. Install the plugin from the WordPress plugin directory, or upload the `open-search-
document` folder to `/wp-content/plugins/`
2. Activate it through the _Plugins_ menu
3. That’s it, there are no settings
## MEG
### How do I check that it works?
Open `https://yoursite.com/wp-json/opensearch/1.1/document` in your browser. You
should see a short XML file with the name of your site and the search URLs.
### Does it change the search on my site?
No. The plugin only describes the search you already have. The browser sends visitors
to your normal search results page.
### Chrome does not offer my site for “Tab to Search”
Chrome no longer adds sites on its own. Go to `chrome://settings/searchEngines`,
look for your site under “Inactive shortcuts” and activate it. Edge works the same
way under `edge://settings/searchEngines`.
### Where do the suggestions come from?
From your tags. Other plugins can change that with the `open_search_document_suggestions`
filter.
### Can I add query params to the search URLs?
Yes, with the `osd_search_url_template` filter. The second argument tells you which
search URL is filtered: `html`, `atom` or `rss2`.
```
function custom_osd_extend( $url, $type ) {
return add_query_arg( 'mtm_campaign', 'opensearch', $url );
}
add_filter( 'osd_search_url_template', 'custom_osd_extend', 10, 2 );
```
### What are the tags in the document?
The `Tags` element lists the ten most used tags of your site, as keywords for the
search engine. Sites without tags get `WordPress blog`. The `osd_tags` filter lets
you change the list.
### Can I add more elements to the document?
Yes. The `osd_xml` action runs inside the document, right before the closing tag.
The `osd_ns` action lets you add namespaces to the root element.
## Berrikuspenak
### [Works perfectly well (and completely hidden as expected)](https://wordpress.org/support/topic/works-perfectly-well-and-completely-hidden-as-expected/)
[Marc Bernard](https://profiles.wordpress.org/luxxor/) 2020(e)ko apirilaren 10(
a)
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 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
### [thanks for the update, why not used on more webpages?](https://wordpress.org/support/topic/thanks-for-the-update-why-not-used-on-more-webpages/)
[Tobias @Saleswonder.biz](https://profiles.wordpress.org/tobias_conrad/) 2018(e)
ko urtarrilaren 23(a)
Maybe an gif animation for the visitors which is linked to a desccription howto
use would be nice. i would like to translate to german.
### [Perfect](https://wordpress.org/support/topic/perfect-4736/)
[ok2vvv](https://profiles.wordpress.org/ok2vvv/) 2018(e)ko urtarrilaren 17(a)
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.
### [Do what it should](https://wordpress.org/support/topic/do-what-it-should-2/)
[rinma](https://profiles.wordpress.org/rinma/) 2017(e)ko apirilaren 20(a)
This plugin is easy to use. Install it and it works 🙂
[ Irakurri 4 berrikuspenak ](https://wordpress.org/support/plugin/open-search-document/reviews/)
## Laguntzaileak eta Garatzaileak
“Open Search Document” software librea da. Ondoko pertsonek egin dizkiote ekarpenak
plugin honi.
Laguntzaileak
* [ Matthias Pfefferle ](https://profiles.wordpress.org/pfefferle/)
* [ johnnoone ](https://profiles.wordpress.org/johnnoone/)
Open Search Document 1 eskualde-ezarpenera itzuli da. Eskerrik asko [itzultzaileei](https://translate.wordpress.org/projects/wp-plugins/open-search-document/contributors)
beraien ekarpenengatik.
[Itzul zaitez Open Search Document zure hizkuntzara.](https://translate.wordpress.org/projects/wp-plugins/open-search-document)
### Garapena interesatzen zaizu?
[Araka kodea](https://plugins.trac.wordpress.org/browser/open-search-document/),
begiratu [SVN biltegia](https://plugins.svn.wordpress.org/open-search-document/)
edo harpidetu [garapen erregistrora](https://plugins.trac.wordpress.org/log/open-search-document/)
[RSS](https://plugins.trac.wordpress.org/log/open-search-document/?limit=100&mode=stop_on_copy&format=rss)
bidez.
## Aldaketen loga
### 4.2.0
* The REST controller extends the WordPress `WP_REST_Controller` class
* Search suggestions keep spaces and upper case letters in the query
* The document no longer has a stray `null` at the end
* Site name, description and URLs are escaped for XML
* The suggestions URL has `rel="suggestions"` and the document links to itself
with `rel="self"`
* Site icons carry their MIME type
* The `Tags` element lists the most used tags of the site, filterable with `osd_tags`
* Removed the `Contact` element, the spec expects an email address there
* Removed the `Developer` element
* Removed the XRDS-Simple integration, the plugin is closed on WordPress.org
* `url_template()` and `feed_url_template()` are deprecated, use `get_url_template()`
* Requires WordPress 6.4 and PHP 7.4
* Added tests and a new readme
### 4.1.3
* update plugin structure
### 4.1.1
* fix PHP deprecated: strstr(): Passing null to parameter
### 4.1.0
* added [“search_provider” WebExtension](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/chrome_settings_overrides)
support
### 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
* Lehen bertsioa
## Community plugin
Plugin hau komunitateak garatzen du eta euskarria ematen dio. [Contribute to this plugin](https://github.com/pfefferle/wordpress-open-search-document)
## Meta
* Version **4.2.0**
* Azken eguneraketa **duela aste 1**
* Instalazio aktiboak **200+**
* WordPress bertsioa ** 6.4 edo handiagoa **
* **7.1.2** (e)raino probatuta.
* PHP bertsioa ** 7.4 edo handiagoa **
* Hizkuntzak
* [English (US)](https://wordpress.org/plugins/open-search-document/) eta .[German](https://de.wordpress.org/plugins/open-search-document/).
* [Itzuli zure hizkuntzara](https://translate.wordpress.org/projects/wp-plugins/open-search-document)
* Etiketak
* [browser](https://eu.wordpress.org/plugins/tags/browser/)[opensearch](https://eu.wordpress.org/plugins/tags/opensearch/)
[search](https://eu.wordpress.org/plugins/tags/search/)[suggestions](https://eu.wordpress.org/plugins/tags/suggestions/)
* [Ikuspegi aurreratua](https://eu.wordpress.org/plugins/open-search-document/advanced/)
## Balorazioak
5 out of 5 stars.
* [ 4 5-star reviews ](https://wordpress.org/support/plugin/open-search-document/reviews/?filter=5)
* [ 0 4-star reviews ](https://wordpress.org/support/plugin/open-search-document/reviews/?filter=4)
* [ 0 3-star reviews ](https://wordpress.org/support/plugin/open-search-document/reviews/?filter=3)
* [ 0 2-star reviews ](https://wordpress.org/support/plugin/open-search-document/reviews/?filter=2)
* [ 0 1-star reviews ](https://wordpress.org/support/plugin/open-search-document/reviews/?filter=1)
[Your review](https://wordpress.org/support/plugin/open-search-document/reviews/#new-post)
[See all reviews](https://wordpress.org/support/plugin/open-search-document/reviews/)
## Laguntzaileak
* [ Matthias Pfefferle ](https://profiles.wordpress.org/pfefferle/)
* [ johnnoone ](https://profiles.wordpress.org/johnnoone/)
## Laguntza
Zerbait duzu esateko? Laguntza behar?
[Ikusi laguntza foroa](https://wordpress.org/support/plugin/open-search-document/)
## Egizu eskaintza
Plugin honen aurrerabidearen euskarri izan nahi duzu?
[ Egiozu eskaintza plugin honi ](https://notiz.blog/donate/)