Skip to content

A developer-focused interface to enabling experimental ElasticPress plugin features.

License

Notifications You must be signed in to change notification settings

10up/ElasticPressLabs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ElasticPress Labs

A developer-focused interface to enabling experimental ElasticPress plugin features.

Support Level Tests Linting Release Version WordPress tested up to version GPLv2 License

Please note: trunk is the stable branch

Overview

This plugin provides a developer-focused interface to commonly used filters without the need of being fully accessible and skipping the need of providing a streamlined user experience. It's meant to be an easy way to solve common issues without code changes.

Documentation

ElasticPress Labs acts as an ElasticPress feature and registers its methods through the ElasticPress Feature API. In this way the features added to this plugin will be immediately available in the ElasticPress interface.

This plugin provides a simple interface to enable and disable features.

Requirements

Features

Boolean Search Operators

Allow users to search using boolean operators such as AND, OR, NOT, and double quotes.

Co-Authors Plus

If using the Co-Authors Plus plugin and the Protected Content feature, enable this feature to see correct results when listing posts by author name in the Admin Post List screen.

External Content

List meta keys containing a path or a URL, and ElasticPress will index the content of that path or URL. For example, for a meta key called meta_key with https://wordpress.org/news/wp-json/wp/v2/posts/16837 as its value, the JSON returned by that REST API endpoint will be indexed in a meta key called ep_external_content_meta_key.

Geo Location

Allow users to search for posts based on their location. Optionally, set a Google Maps API key and easily store coordinates related to your content.

Meta Key Pattern

Allow and deny meta fields from being indexed using regular expressions.

Search Algorithm Version

Change the search algorithm used by your site. Current options are:

  • Default: Use a fuzzy match approach which includes results that have misspellings, and also includes matches on only some of the words in the search.
  • Version 3.5: Search for the existence of all words in the search first, then return results based on how closely those words appear.
  • Version 4.0: Search for all search terms in one field first, then prioritize them over search terms matched in different fields. Used by default on ElasticPress 4.0+.

Search Templates

Search templates are Elasticsearch queries stored in ElasticPress.io servers used by the Search API.

Users

Improve user search relevancy and query performance.

WooCommerce Admin Subscription Search

Integration with the WooCommerce Subscriptions plugin.

Screenshots

  1. Settings to allow boolean search operators in search queries.

  2. Settings to add Co-Authors Plus plugin support.

  3. Settings to include or exclude meta key patterns.

  4. Settings to change the version of the search algorithm between default, 3.5, and 4.0.

  5. Settings to index external content.

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 Labs are documented in CHANGELOG.md.

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 Labs.

Like what you see?