The OpenSearchServer Search Plugin enables OpenSearchServer full-text search in WordPress-based websites.
OpenSearchServer is an high-performance search engine that includes spell-check, facets, filters, phonetic search, and auto-completion.
This plugin automatically replaces the WordPress built-in search function.
- Full-text search with phonetic support,
- Queries can be fully customized and the relevancy of each field (title, author, …) can be precisely tuned,
- Search results can be filtered using facets,
- Automatic search suggestions through autocompletion,
- Spell-checking with automatic substitution,
- Search into your files: .docx, .doc, .pdf, .rtf, etc. The plugin will extract text from your attachments and index it.
- Automatic indexing of content as soon as it gets published, edited or deleted,
- Can index and search through all type of content,
- Can index and search every taxonomies,
- Can be easily set up and tweaked through web form page
- Supports multi-sites installation,
- Supports a WPML plugin for translation,
- Includes several filters and actions to allow for more customization via other plugins or themes.
See the screenshots page for more!
- WordPress 3.0.1 or higher
- A running instance of OpenSearchServer 1.3 or higher (OpenSearchServer 1.5.11 is required for searching into attachments)
Installing an OpenSearchServer instance
There are two ways to get an OpenSearchServer instance:
- Deploy it on your own server as explained in the OpenSearchServer documentation
- Or use an OpenSearchServer SaaS instance OpenSearchServer Software as a Service instances
Installing the plugin
- Verify that you have a running OpenSearchServer instance
- Uncompress the plugin archive in the wp-content/plugins folder for your WordPress installation.
- Activate the OpenSearchServer Search plugin via WordPress settings.
- Open the OpenSearchServer settings page (in the Plugins menu) and fill the form with your desired settings
- Choose the types of content and the taxonomies to index, save your Index Settings.
- Create your index by clicking on the “(Re-)Create the index” button
- New and modified content from WordPress can be pushed into your newly created index by clicking the “Synchronize / Re-index” button.
- What is OpenSearchServer?
Open Search Server is a search engine developed under the GPL v3 open source licence. Read more on http://www.open-search-server.com
- How to update the search index?
Use the Reindex-Site button in the OpenSearchServer Settings page. By default the OpenSearchServer plugin automatically indexes any new post or page
- When I click the Create-index/Save button or the Reindex button I got an exception saying “Bad credential”
Check that the credentials entered in the plugin page match the ones entered in your OpenSearchServer instance, under the Privileges tab.
- I get an error when I install Opensearchserver. “Fatal error: OSS_API won’t work without curl extension in “opensearchserver-search\OSS_API.class.php” on line 23″
Check whether the CURL extension for PHP is enabled on your server, and install it if necessary.
- How to customize/style the search page?
Copy the opensearchserver_search.php file from the wp-content/plugins/opensearchserver-search directory to your current theme folder (for instance wp-content/themes/twentyfourteen).
Customize the layout as needed.
- Will this plugin work with a multi-sites installation?
Yes, this plugin supports multi-sites installation.
- I already manage my OpenSearchServer index in another way (using web crawler). Can I use this plugin to plug my WordPress search page into my existing index?
Yes you can: enable the “Search only” mode to stop sending data (chiefly new posts and pages) from WordPress to OpenSearchServer.
Warning: you may first need to create your index using the OSS WordPress plugin before enabling the “Search only mode”. This ensures that the necessary fields are all created in the schema of your index.
- I get the following PHP warning when saving my query settings: “Warning: OSS Returned an error: “Error com.jaeksoft.searchlib.web.ServletException: com.jaeksoft.searchlib.SearchLibException: Returned field: The field: thumbnail_url does not exist”
You probably updated to a recent version without re-creating your index. You need to re-create your index and re-synchronize data.
- What are the available filters and actions?
Learn everything about the available filters and actions in our documentation center.
- The indexing process crashes before it can send all documents to OpenSearchServer
Fully re-indexing can hit the memory quite hard. If your server does not allow for that much memory to be used by PHP, try indexing your content in smaller spans. To do so, use the ‘From document’ and ‘to document’ input fields located above the ‘Re-index / Synchronize’ button and determine through trial and error how many documents your server will let you process in one go.
- How can I translate the plugin
lang/opensearchserver-fr_FR.pofile, rename it with your country code and translate its content. Feel free to submit us your translated files!
Serbian translation provided by Ogi Djuraskovic – http://firstsiteguide.com.
Contributors & Developers
“OpenSearchServer Search” is open source software. The following people have contributed to this plugin.Contributors
Interested in development?
1.5.10 – 05/05/2015
- Fixed bug on auto indexing (content types limitations were not fully followed)
1.5.9 – 20/04/2015
- Fixed bug on autocomplete feature for IE < 9
1.5.8 – 08/04/2015
- Deleted unnecessary call to a CSS file
1.5.7 – 07/04/2015
- Fixed a PHP Warning that sometimes occured when parsing attachments
1.5.6 – 01/04/2015
- Added some filters and actions when indexing a document
1.5.5 – 04/03/2015
- Added feature to index content from attachments (use OSS’s parsers)
1.5.4 – 02/03/2015
- Fixed bug when indexing attachment
- Forced default query for getting total number of docs in the index
1.5.3 – 27/02/2015
- Added a feature to re-index full data using WordPress CRON
1.5.2 – 16/02/2015
- Fixed bugs
- Improved facets
- Updated FR translation
1.5.1 – 05/02/2015
- Added a feature to select an existing query template from OSS rather than using queries configured in WordPress.
- Improved facets use: added a small search form, hierarchical facets, and some other imrpovements
1.5 – 30/12/2014
- Improved the indexing of Custom Fields.
- Additional help texts for Query and Facets management.
- ==> Re-creating and synchronizing the index may be needed if you are indexing Custom Fields. Please re-configure which Custom Fields to index in the “Index settings” section.
1.4.2 – 16/12/2014
- Updated the indexing process
1.4.1 – 07/11/2014
- Fixed a bug occurring when there only was a single exclusive facet
1.4 – 04/11/2014
- Added filters and actions, updated the README.
1.3.9 – 14/10/2014
- Added translation labels for the following strings: Next, Previous, First, Last
1.3.8 – 04/09/2014
- Added a plugin icon for WordPress 4.0
- Added autocompletion on the main search input – it’s no longer limited to the search page
- Changed facet behavior: there is now a standard behavior and an advanced behavior
- The advanced behavior allows for selecting exclusive or multiple facets
- Added configurable URL slugs for facets
- Improved autocompletion suggestions
- Added some WordPress filters
- ==> Index re-creation and synchronization may be needed upon updating the plugin
- Indexing of content thumbnails
- Indexing of multiple taxonomies
- Categories are now indexed like any other taxonomy
- The chosen content type can now be automatically indexed when added / edited / deleted
- Used STYLESHEETPATH instead of TEMPLATEPATH, which makes it possible to override the template in a Child Theme
- Added handling of OpenSearchServer logging
- ==> Index re-creation and synchronization may be needed upon updating the plugin
- UI enhancements
- ‘Sort by date’ feature.
- Added a search only mode
- Added an option to either send query settings to OSS or to save them locally
- Custom labels and values for facets
- Search results can now be filtered by year and month.
- Various bug fixes
- Various bug fixes.
- Added support for multi-sites installation
- Improved admin page
- Search result can now also be filtered by tags
- Users can define their own special character to clean the query.
- Fixed issues with multiple categories.
- Improved the search result display.
- New autocompletion REST API
- Added a function to select which type of post will be indexed
- Added an option to display user, type and category in search result
- Added multiple facets support.
- New feature – facet behavior.
- Fixed the spell check when no field is selected.
- Upgrade to the latest OpenSearchServer PHP library
- Added the possibility to index a range of documents
- Now supporting 17 languages
- Now providing spelling corrections
- Tested with OpenSearchServer 1.3-rc2
- Added phonetic search
- Added custom fields support
- Added facets and filters on categories
- Improved the OpenSearchServer settings page
- SpellCheck feature added to the search page
- AutoCompletion feature added to the search page
- OpenSearchServer client library upgrade (to 1.3)
- Search results now have a template file.
- Fixed a document indexing bug
- Fixed paging issues in the current page.
- Updated the batch-indexing process.
- OpenSearchServer client library upgrade.
- Fixed a bug that added two blank lines at the top of the HTML page.
- Fixed images in search results.
- Added a deletion feature to the OSS plugin
- Implemented the override of WordPress search by OpenSearchServer search