README

A fast and flexible search and query engine for WordPress.

• Check out the ElasticPress Docs

Please note: as of ElasticPress 4.0.0 trunk is the stable branch, built assets were removed from the develop branch, a ZIP with the plugin and its built assets are available on the GitHub Releases page, and will include a build script should you want to build assets from a branch. As such, please ensure you have updated any references you have from master to trunk or to GitHub releases depending on whether you require built assets or not.

Overview

ElasticPress, a fast and flexible search and query engine for WordPress, enables WordPress to find or “query” relevant content extremely fast through a variety of highly customizable features. WordPress out-of-the-box struggles to analyze content relevancy and can be very slow. ElasticPress supercharges your WordPress website making for happier users and administrators. The plugin even contains features for popular plugins.

Documentation

• Support site with FAQs, tutorials, and docs ☞
• Security Policy ☞

Requirements and Compatibility

Requirements

ElasticPress requires these software with the following versions:

• Elasticsearch 5.2+
• WordPress 6.0+
• PHP 7.4+

Compatibility

The WooCommerce feature is compatible with the last two major versions of the WooCommerce plugin.

Building Assets

Simply downloading the repository files is not enough to have the plugin working, as CSS and JavaScript files are built during the release process. If you want to use a development version of the plugin you will to run:

npm install && npm run build

Node.js (v18) and npm (v8) are required.

React Components

Interested in integrating ElasticPress in your headless WordPress website? Check out ElasticPress React.

Issues

If you identify any errors or have an idea for improving the plugin, please open an issue. We're excited to see what the community thinks of this project, and we would love your input!

Support Level

Active: 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.

Changelog

A complete listing of all notable changes to ElasticPress are documented in CHANGELOG.md.

Upgrade notices

3.5

Search Algorithm Upgrade Notice: Version 3.5 includes a revamp of the search algorithm. This is a backwards compatibility break. If you'd like to revert to the old search algorithm, you can use the following code: add_filter( 'ep_search_algorithm_version', function() { return '3.4'; } );. The new algorithm offers much more relevant search results and removes fuzziness which results in mostly unwanted results for most people. If you are hooking in and modifying the search query directly, it's possible this code might break and you might need to tweak it.

4.0.0

Note that ElasticPress 4.0.0 release removes built assets from the develop branch, replaced master with trunk, added a ZIP with the plugin and its built assets in the GitHub Releases page, and included a build script should you want to build assets from a branch. As such, please plan to update any references you have from master to trunk or to GitHub Releases depending on whether you require built assets or not.

Contributing

Please read CODE_OF_CONDUCT.md for details on our code of conduct, CONTRIBUTING.md for details on the process for submitting pull requests to us, and CREDITS.md for a listing of maintainers of, contributors to, and libraries used by ElasticPress.

Like what you see?