Developer Documentation

Instant Results – Post Search API

In this article, you will find all the endpoints and parameters of the Post Search API, the ElasticPress.io API that powers the Instant Result feature. Generally, the ElasticPress plugin will handle everything for you, but…

Related Posts API

ElasticPress understands data in real-time, so it can instantly deliver engaging and precise related content with no impact on site performance. In addition to the Related Posts block, it is also possible to list related…

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

To develop for ElasticPress you will need a local development environment (the same you would use to work on a WordPress site) and an Elasticsearch instance — either directly installed in your machine, a docker…

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 at least the…

Indexables

In ElasticPress 3.0, we’ve introduced the concept of Indexables, a way to enable indexing, search, and queries on any queryable object in WordPress, such as Posts or Comments, for example. ElasticPress ships with the following…

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: