Developer Documentation

Theme Integration

Through its several filters, ElasticPress allows developers to change its look-and-feel. Here is a list of (some) features and how to change them:

Compatibility

ElasticPress requirements can be found in the Requirements section in our README. If your solution relies on a different server or version, you may find additional information in this document. OpenSearch ElasticPress does not officially support OpenSearch…

Development

Developing for ElasticPress is easy. We provide tools that give you everything you need to test ElasticPress features and create Pull Requests. The first thing you’ll want to do is set up a local development…

Did You Mean

ElasticPress’ “Did You Mean” feature intelligently understands and handles typos in search keywords. When a user enters a search term with a typo, ElasticPress analyzes the search query, compares it to a database of indexed…

Feature API

Since ElasticPress 3.0, to register a feature you will need to extend the Feature class. Here is a code example: The Feature class is an abstract class, which means it is required to implement some methods: Optionally,…

Indexables

In ElasticPress 3.0, we’ve introduced the concept of Indexables. In the past, ElasticPress integrated with WordPress’ WP_Query API, which enabled redirection of WP_Query queries through Elasticsearch instead of MySQL. Indexables takes this a step further,…

Sync Process

If after reading the What is the ElasticPress Sync? article you are curious to understand how the process works behind the scenes, this article is for you. Index, Reindex, and Sync are some of the…

React Components

Are you looking to integrate ElasticPress into your React application or headless WordPress website? ElasticPress has a React component library. Install via npm:

Customizing Autosuggest

Connecting Autosuggest to Your Theme’s Search Bar When enabled, ElasticPress Autosuggest will automatically add itself to any input[type=”search”] elements on the page, as well as any elements with the .ep-autosuggest or .search-field classes. You can add Autosuggest to additional elements yourself…

Understanding the default ElasticPress/Elasticsearch search query

For both the Post search and Autosuggest Features, ElasticPress performs the same default Elasticsearch query. This query can be filtered by changing the settings in the ElasticPress -> Weighting Engine menu in the WordPress Dashboard…