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.
Here is a list of the amazing ElasticPress features included in the plugin:
Search: Instantly find the content you’re looking for. The first time.
WooCommerce: “I want a cotton, woman’s t-shirt, for under $15 that’s in stock.” Faceted product browsing strains servers and increases load times. Your buyers can find the perfect product quickly, and buy it quickly.
Related Posts: ElasticPress understands data in real time, so it can instantly deliver engaging and precise related content with no impact on site performance.
Protected Content: Optionally index all of your content, including private and unpublished content, to speed up searches and queries in places like the administrative dashboard.
Documents: Indexes text inside of popular file types, and adds those files types to search results.
Autosuggest: Suggest relevant content as text is entered into the search field.
Facets: Add controls to your website to filter content by one or more taxonomies.
Users: Improve user search relevancy and query performance.
Please refer to
Github for detailed usage instructions and documentation.
3.5.6
This release fixes some bugs and also adds some new actions and filters.
Security Fix:
-
Updated JS dependencies. Props @felipeelia
Bug Fixes:
-
Fixed document indexing when running index command with nobulk option. Props @Rahmon
- Added an extra check in the iteration over the aggregations. Props @felipeelia
- Fixed no mapping found for [name.sortable] for Elasticsearch version 5. Props @Rahmon
-
Fixed uninstall process to remove all options and transients. Props @Rahmon
Enhancements:
-
Added missing inline JS documentation. Props @JakePT
- Added the filter
ep_autosuggest_http_headers
. Props @Rahmon
- Added terms indexes to the status and stats WP-CLI commands. Props @felipeelia
- The Protected Content feature isn't auto-activated when using ElasticPress.io anymore. Props @felipeelia
- Added the new filter
ep_highlight_should_add_clause
to let developers decide where the highlight clause should be added to the ES query. Props @felipeelia
- Added the new filter
epwr_weight
and changed the default way scores are applied based on post date. Props @Rahmon
3.5.5
This release fixes some bugs and also adds some new actions and filters.
Bug Fixes:
- Fix a problem in autosuggest when highlighting is not active. Props @felipeelia and @Rahmon
- Fix a wrong phrase in the Indexables documentation. Props @jpowersdev
- Fix Facet Term Search for more than one Widget. Props @goaround
-
Fix a Warning that was triggered while using PHP 8. Props @Rahmon
Enhancements:
-
Add an
is-loading
class to the search form while autosuggestions are loading. Props @JakePT
- Add the new
set-algorithm-version
and get-algorithm-version
WP-CLI commands. Props @felipeelia
- Add a new
ep_query_weighting_fields
filter. Props @felipeelia and @tott
- Add two parameters to the
ep_formatted_args_query
filter. Props @felipeelia and @tott
- Add the new
set-algorithm-version
and get-algorithm-version
WP-CLI commands. Props @felipeelia
- Create a new section in documentation called
Theme Integration
. Props @JakePT
- Improvements to contributing documentation and tests. Props @jeffpaul and @felipeelia
- Add the following new actions:
ep_wp_cli_after_index
, ep_after_dashboard_index
, ep_cli_before_set_search_algorithm_version
, ep_cli_after_set_search_algorithm_version
, ep_after_update_feature
, ep_cli_before_clear_index
, and ep_cli_after_clear_index
. Props @felipeelia and @Rahmon
3.5.4
This is primarily a security and bug fix release. PLEASE NOTE that versions 3.5.2 and 3.5.3 contain a vulnerability that allows a userto bypass the nonce check associated with re-sending the unaltered default search query to
ElasticPress.io that is used for providing Autosuggest queries. If you are running version 3.5.2. or 3.5.3 please upgrade to 3.5.4 immediately.
Security Fix:
-
Fixed a nonce check associated with updating the default Autosuggest search query in ElasticPress.io. Props @felipeelia
Bug Fixes:
-
Fix broken click on highlighted element in Autosuggest results. Props @felipeelia
-
Properly cast
from
parameter in $formatted_args
to an integer to prevent errors if empty. Props @CyberCyclone
Enhancements:
-
Add an
ep_is_facetable
filter to enable custom control over where to show or hide Facets. Props [@moraleida]
- Improvements to contributing documentation and tests. Props @jeffpaul and @felipeelia
3.5.3
This is a bug fix release.
Bug Fixes:
- Fixed a bug where the
ep-synonym
post type is updated to a regular post, which can cause it to be accidentally deleted. Props @Rahmon
- Fixed CSS formatting issues in the Settings and Features menus. Props @Rahmon
3.5.2
This is a bug fix release.
Bug Fixes:
- Fixed a typo in elasticpress.pot. Props @alexwoollam
- Don’t use timestamps that cause 5 digit years. Props @brandon-m-skinner
- Fix admin notice on the Synonyms page. Props @Rahmon
- Properly update slider numbers while sliding. Props @Rahmon
- Properly handle error from
get_terms()
. Props @ciprianimike
- Fix incorrect titles page. Props @Rahmon
- Fix linting tests. Props @felipeelia
-
Fix issue with price filter unsetting previous query. Props @oscarssanchez
Enhancements:
-
Added actions that fire after bulk indexing (
ep_after_bulk_index
), in event of an invalid Elasticsearch response (ep_invalid_response
), and before object deletion (ep_delete_{indexable slug}
); added filters ep_skip_post_meta_sync
, pre_ep_index_sync_queue
, ep_facet_taxonomies_size
, epwr_decay_function
, and epwr_score_mode
. Props @brandon-m-skinner
- Added
ep_filesystem_args
filter. Props @pjohanneson
- Add SKU field to Weighting Engine if WooCommerce is active and fix issue with overriding
search_fields
. Props @felipeelia
- Support
author__in
and author__not_in
queries. Props @dinhtungdu
- Update multiple unit tests. Props @petenelson
- Show CLI indexing status in EP dashboard. Props @Rahmon
- Add
ep_query_send_ep_search_term_header
filter and don’t send EP-Search-Term
header if not using ElasticPress.io. Props @felipeelia
3.5.1
A bug fix release.
Bug fixes:
- Fixes highlighting so that full content is returned instead of only snippets.
- Fix empty synonym bug.
-
Only highlight post content, excerpt, and title.
Enhancements:
-
Track CLI index in a headless fashion
3.5
Version 3.5 is a very exciting release as it contains two major new features: a synonym dashboard and search term result highlighting. The synonym dashboard empowerers users to create synonym lists for searches. For example. searching "New York City" would return contain with "NYC". Search term highlighting will underline and add a CSS class to keywords within content that matches the current search.
The new version also 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.
Bug fixes:
- Fix default autosuggest selector.
- Fix facet feature $_GET parameter naming collision.
- Autosuggest a11y fixes. Props amesplant.
- Check $feature type before calling Feature methods. Props pdewouters.
- Ensure trashed post is removed from Elasticsearch. Props edwinsiebel.
- Add default permission callback to REST routes. Props dkotter.
- Hide links to weighting and synonym dashboard if network activated. Props felipeelia.
- Only sync post on allow listed post meta. Props felipeelia.
- Check if site is indexable before syncing in network activated mode.
- Fix facet widget and 3-level deep hierarchical taxonomy. Props dinhtungdu.
-
Make sure AJAX sync is disabled if EP_DASHBOARD is set to false.. Props turtlepod.
Enhancements:
-
Synonym dashboard. Props christianc1.
- Search term highlighting. Props oscarsanchez.
- Search algorithm improvements.
- Improved WP Acceptance tests. Props asharirfan.
- Rename ElasticPress submenu to "Features". Props helen.
- Add functionality for skipping ElasticPress install.
- Increase max supported Elasticsearch version to 7.9.
- Add filter to prepared user meta data. Props g-kanoufi.
- Improve Terms Feature terminology to remove confusion.
- Add filter to facet terms query arguments. Props felipeelia.
3.4.3
Enhancements:
-
Remove jQuery from front end JavaScript dependencies.
Bug Fixes:
-
Fix accessibility bug on autosuggest.
- Fix broken facet search.
3.4.2
Bug fixes:
- uninstall.php: Change the EP_FILE const to its value. Props felipeelia.
- Fix list features WP CLI command. Props felipeelia.
- Add
rel="nofollow"
to facet links. Props mlaroy.
- Facets widget: Move
outside ob_start(). Props kallehauge.
- Load facet scripts and styles only when they are really necessary. Props goaround.
- Index attachments with Protected Content and query for them in media search. Props oscarsanchez.
-
Fixed
Deprecated field [include] used, expected [includes] instead.
. Props dinhtungdu.
Enhancements:
-
Add filter for enabling sticky posts. Props shadyvb.
- Add sync kill filter. Props barryceelen.
- Add timeout filters for bulk_index and index_document. Props @oscarsanchez.
3.4.1
- Make weighting dashboard flex containers to prevent the slider from changing size. Props @mlaroy.
- Fix issue where weightings wouldn't save properly for certain post types. Props mustafauysal.
- Fix bug where terms wouldn't finish syncing in certain scenarios.
- Properly order WooCommerce products using double to account for decimals. Props @oscarsanchez.
- Show current indices in index health dashboard. Props moraleida.
3.4
- Addition of Terms Indexable and Feature. ElasticPress can now integrate with
WP_Term_Query
. Props dkotter.
- Fixes for
WP_User_Query
'fields' parameter. Props petenelson.
- Support all taxonomies in root of
WP_Query
- Readd
ep_retrieve_aggregations
hook for backwards compatibility
- Move indexable posts class registration into a function that runs in the
plugins_loaded
action. Props petenelson.
- Fix author name in weighting and use post_author.display_name for weighted author field search. Props petenelson.
- Add
ep_prepared_*_meta
filters
- Refactor CLI indexing code for simplicity.
- Limit indexed Protected Content post types removing
revision
, oembed_cache
, custom_css
, user_request
, customize_changeset
, and wp_block
.
- Cast taxonomy slug to array in case it's already an array in
WP_Query
.
- Remove unnecessary usage of
--network-wide
CLI paramter.
- Add name, nickname, and display name to fields used for user search.
- Add
clear-transient
WP CLI command.
- Don't make product categories facetable when WooCommerce feature is not active. Props mustafauysal.
3.3
- Officially support Elasticsearch 7.5
- Add optional Google Analytics Autosuggest tracking Event
- Fix single node warning before sync has occurred.
- When
ep_integrate
is set to false, do not apply faceting.
- Fix search ordering error when there are no pointers.
- Add filter
ep_get_hits_from_query
to modify retrieved Elasticsearch hits.
- Make sure
post_type
array does not include keys. Fixes a bbPress issue.
- Pass query object to EP response so we can check for main query. This fixes a faceting bug.
- Add EP-Search-Term header to autosuggest requests to EP.io
- Clean up indexing transient on sigkill
3.2.6
This is a bugfix release
- Under some edge conditions content for autosuggest can be large - don't cache it
3.2.5
This is a bug fix version.
- Fix WP <5.0 fatal error on register_block_type.
3.2.4
This is a bug fix version.
- Fix Gutenberg block initialization
- Fix Autosuggest: remove filter with proper priority in query generation. Props Maxdw.
- Fix Autosuggest: returning WP_Error for non object cache autosuggest queries causes issue. Fallback to transient
3.2.3
This is a bug fix version.
- Ensure query building for Autosuggest does not fallback to WPDB.
3.2.2
This is a bug fix version with some feature additions.
- Fix PHPCS errors. Props mmcachran
- Fix ensuring stats are built prior to requesting information
- Fix related post block enqueue block assets on the frontend
- Fix custom order results change webpack config for externals:lodash
- Fix don't overwrite search fields
- Autosuggest queries generated though PHP instead of JavaScript
- Add WP Acceptance tests
- Add new WP-CLI commands: get_indexes and get_cluster_indexes
3.2.1
This is a bug fix version.
- Fix Gutenberg breaking issue with Related Posts and image blocks. Props adamsilverstein
3.2
ElasticPress 3.2 is a feature release. We've added quite a few useful features including an index health page, the ability to control which sites are indexed in a network activated multisite setup, a related posts Gutenberg block, and more.
- Improve block asset enqueueing: hook on
enqueue_block_editor_assets
. Props adamsilverstein.
- Handle empty search weighting fields bug.
- Integrate WooCommerce default filter by price widget with ES range query.
- Improve messaging for custom result post type.
- Index health page.
- Add tag_in and tag__and support.
- Related posts Gutenberg block.
- Facet widget ordering option. Props psorensen.
- Control Index-ability of individual sites in multisite.
- Integrate WooCommerce default filter by price widget with ES range query.
See
https://github.com/10up/ElasticPress/pulls?utf8=%E2%9C%93&q=is%3Apr+milestone%3A3.2.0+is%3Aclosed+
3.1.4
https://github.com/10up/ElasticPress/pulls?q=is%3Apr+milestone%3A3.1.4+is%3Aclosed
3.1.3
This is a bug fix release.
- Check wpcli transient before integrating with queries
- Fix version comparison bug when comparing Elasticsearch versions
- Use proper taxonomy name for WooCommerce attributes.
- Increase Elasticsearch minimum supported version to 5.0
- Fix product attribute archives
3.1.2
This is a bug fix release with some filter additions.
- Add ep_es_query_results filter.
- Add option to sync prior to shutdown.
- Readme update around WPCLI post syncing. Props @mmcachran
- Ignore sticky posts in
find_related
. Props @columbian-chris
- Weighting dashboard fixes around saving. @oscarsanchez
- Weighting UI improvements. Props @mlaroy
3.1.1
- Ensure taxonomies that are shared among multiple post types show up on the weighting screen
3.1.0
- Support for nested tax queries. Props @dkotter
ep_bulk_index_action_args
filter. Props @fabianmarz
- Add filters to control MLT related posts params.
ep_allow_post_content_filtered_index
filter to bypass filtered post content on indexing.
- Weighting dashboard to control weights of specific fields on a per post type basis
- Search ordering feature. Enables custom results for specific search queries.
- Refactor admin notice, admin screen "resolver", and install path logic
- WordPress.org profile
- New EP settings interface. Props @dkoo
- Delete pagination from facet URL.
- allows WooCommerce product attributes to be facetable in 3.0
- Autosuggest queries now match the search queries performed by WordPress, including weighting and any custom results
- Fix data escaping in WP 4.8.x
- Support order by "type"/"post_type" in EP queries
- Properly redirect after network sync
- User mapping for pre 5.0 Props @mustafauysal
- Avoid multiple reflows in autosuggest. Props @fabianmarz
- 400 error when popularity is default sorting.
- Fixed Facet widget not rendering WC product attribute options. Props @fabianmarz
- Delete wpcli sync option/transient when an error occurs
- Create index/network alias when adding a new site on a network activated installation. Props @elliott-stocks
- Fix WooCommerce order search when WooCommerce module activated but protected content turned off.
3.0.3
- Pass $post_id twice in ep_post_sync_kill for backwards compatibility. Props aaemnnosttv
- Add
ep_search_request_path
filter for backwards compant.
- Add
ep_query_request_path
filter for modifying the query path.
- Fix missing action name in post query integration.
- Properly add date filter to WP_Query.
3.0.2
3.0.2 is a minor bug release version. Here is a list of fixes:
- Fix date query errors
- Readd ep_retrieve_the_{type} filter. Props gassan
- Fix empty autosuggest selector notice
3.0.1
3.0.1 is a minor bug release version. Here is a list of fixes:
wp elasticpress stats
and wp elasticpress status
commands fatal error fixed.
- Add autosuggest selector field default to fix notice.
- Re-add
ep_find_related
as deprecated function.
- Changed max int to use core predefined constant. Props @fabianmarz
- Properly support legacy feature registration callbacks per #1329.
- Properly disable settings as needed on dashboard.
- Don't force document search on REST requests.
3.0 (Requires re-index)
3.0 is a refactor of ElasticPress for modern coding standards (PHP 5.4 required) as well as the introduction to indexables. Indexables abstracts out content types so data types other than post can be indexed and searched. 3.0 includes user indexing and search (integration with WP_User_Query). User features require at least WordPress version 5.1.
The refactor changes a lot of ElasticPress internals. The biggest change is the feature registration API has completely changed. Now, new features should extend the
ElasticPress\Feature
class rather than calling
ep_register_feature
. Older features should be backwards compatible.
Other Features:
- Elasticsearch language setting in admin
Here are a list of filters/actions removed or changed:
Actions Removed:
Filters changed:
ep_post_sync_kill
- Removed $post_args
argument.
Other changes:
posts-per-page
changed to per-page
for WP-CLI index command.
2.8.2
- Enhancement: WooCommerce product attributes as facets.
- Enhancement: Performance Boost for document indexing.
- Bugfix for issue on WP REST API searches.
- Bugfix for case-sensitivity issue with facet search.
2.8.1
- Bugfix for homepage out of chronological order.
- Bugfix for missing meta key. (Props turtlepod)
- Bugfix for bulk indexing default value on settings page.
2.8.0
ElasticPress 2.8 provides some new enhancements and bug fixes.
- Sticky posts support.
- Meta LIKE query adjustment.
- Autosuggest bugfix.
- Autosuggest to abide by plugin settings.
- WooCommerce searches with custom fields.
- Adjustment to
wp elasticpress status
- Add Elasticsearch version in settings. (Props turtlepod)
- Allow user to set number of posts during bulk indexing cycle.
- Facet query string customization (Props ray-lee)
- Removal of logic that determines if blog is public / indexable. (Resolves sync issue.)
- Fix for auto activating sync notices. (Props petenelson)
- Removal of date weighting for protected content admin queries.
- Protected content: filtering of filtered post types.
- Implemented --post-ids CLI option to index only specific posts. (Props dotancohen)
2.7.0 (Requires re-index)
ElasticPress 2.7 provides some new enhancements and bug fixes.
- Prevent indexing when blog is deleted or not public.
- Do not apply absint to comment_status.
- ElasticPress.io credentials bugfix.
- Related posts bugfix.
- Random WooCommerce ordering allowed.
- Query only post IDs when indexing. (Props elliott-stocks)
- Better error notices. (Props petenelson)
2.6.1
- Resolves issue of missing file for wp-cli.
2.6.0
ElasticPress 2.6 provides some new enhancements and bug fixes.
- Ability to set autosuggest endpoint by a constant (EP_AUTOSUGGEST_ENDPOINT).
- Enable WooCommerce products to be included in autosuggest results.
- Support for tax_query operators EXISTS and NOT EXISTS.
- Addition of new filter to change default orderby/sort (ep_set_default_sort).
- Do not search for author_name when searching products in WooCommerce.
2.5.2 (Requires re-index)
This is a small bug fix release.
- Removed unnecessary facet JavaScript
- Fix facet aggregations warning
2.5.1 (Requires re-index)
This if a bug fix release. This version requires a re-index as we change the way data is being sent to Elasticsearch.
It's also worth noting for ElasticPress version 2.5+, the Facets feature, which is on by default, will run post type archive and search page main queries through Elasticsearch. If Elasticsearch is out of sync with your content (possible in rare edge cases), this could result in incorrect content being shown. Turning off Facets would fix the problem.
Bug Fixes
- Don't pre-strip HTML before sending it to Elasticsearch.
- Support PHP 5.2 backwards compat.
- Don't show faceting widget if post type doesn't support taxonomy.
2.5
ElasticPress 2.5 includes a new Facets feature that makes it easy to add high performance content filtering controls to a website.
A new Facets widget enables site administrators to add taxonomy facets to a sidebar (or any widgetized area). When viewing a content list on the front end of the website, the widget will display the name of the taxonomy – e.g. “Categories” – and a checklist with all of its terms. Visitors can narrow down content by selecting terms they are interested in. The Facets feature can be globally configured to narrow results to content that is tagged with any or all of the selected terms. The widget’s front end output contains carefully named CSS classes, so that designers and developers can apply unique styling.
Version 2.5 also includes a number of smaller enhancements and fixes, including official support for Elasticsearch 6.2, and increased functional parity with the WP_Query API.
Here is a detailed list of what's been included in the release:
Enhancements
- Facets feature
--post-ids
CLI option to index only specific posts. Props dotancohen.
- Filter for hiding host setting in dashboard. Props tomdxw.
- Support
WP_Query
meta query not between
comparator.
Bugs
- Disallow duplicated Elasticsearch requests on WooCommerce orders page. Props lukaspawlik
- Fix taxonomy sync object warning. Props eugene-manuilov
true
in is_empty_query
terminates ep_query process when it shouldn't. Props yaronuliel
2.4.2
Version 2.4.2 is a bug fix version.
- Fix related posts not showing up bug.
2.4.1
Version 2.4.1 is a bug fix and maintenance release. Here are a listed of issues that have been resolved:
- Support Elasticsearch 6.1 and properly send Content-Type header with application/json. Props eugene-manuilov.
- Fix autosuggest event target issue bug. Props eugene-manuilov.
- Fix widget init bug. Props eugene-manuilov.
- Fix taxonomy sync parameter warning. Props eugene-manuilov.
- Increase maximum Elasticsearch compatibility to 6.1
2.4
Version 2.4 introduces the Autosuggest feature. When enabled, input fields of type "search" or with the CSS class "search-field" or "ep-autosuggest" will be enhanced with autosuggest functionality. As text is entered into the search field, suggested content will appear below it, based on top search results for the text. Suggestions link directly to the content.
We also added hooks and filters to ElasticPress that make query logging possible. The
Debug Bar ElasticPress plugin now adds a Query Log screen to the ElasticPress admin menu. The Query Log is an extremely powerful tool for diagnosing search and indexing issues.
Here is a comphrensive list of changes:
Enhancements
- Autosuggest feature
- Hooks for query log functionality in Debug Bar ElasticPress
- Support
WP_Query
fields
parameter. Props kallehauge.
- Add setting for enabling/disabling date weighting in search. Props lukaspawlik.
- Remove extra post meta storage key from Elasticsearch
- Add shipping class as indexed WooCommerce taxonomy. Props kallehauge.
- Allow WooCommerce orders to be searched by items. Props kallehauge.
- Support Elasticsearch 5.6
- Add filter to granularly control admin notices. Props mattonomics.
- Support ES 5.5+ strict content type checking. Props sc0ttclark
Bug Fixes
- Fix
author_name
search field. Props ivankristianto.
- Fix unavailable taxonomy issue in WooCommerce. Props ivankristianto.
- Index all publicly queryable taxonomies. Props allan23.
- Resolve case insensitive sorting issues. Props allan23.
- Add escaping per VIP standards. Props jasonbahl.
- Fix WooCommerce post type warnings.
2.3.1, 2.3.2
Version 2.3.1-2.3.2 is a bug fix release. Here are a listed of issues that have been resolved:
- Cache ES plugins request. This is super important. Instead of checking the status of ES on every page load, do it every 5 minutes. If ES isn't available, show admin notification that allows you to retry the host.
- Fix broken upgrade sync notification.
- Properly respect WC product visibility. Props ivankristianto. This requires a re-index if you are using the WooCommerce feature.
2.3
Version 2.3 introduces the Documents feature which indexes text inside of popular file types, and adds those files types to search results. We've also officially added support for Elasticsearch 5.3.
Enhancements
- Documents feature
- Enable multiple feature status messages
- Disable dashboard sync via constant:
define( 'EP_DASHBOARD_SYNC', false );
. Props rveitch.
- Add filter for custom WooCommerce taxonomies. Props kallehauge.
- Support WooCommerce
product_type
taxonomy. Props kallehauge.
Bug Fixes
- Fix WP-CLI
--no-bulk
number of posts indexed message. Props ivankristianto.
- Honor
ep_integrate
in WooCommerce queries. Props ivankristianto.
- Properly check when ES results are empty. Props lukaspawlik
- Incorrect
found_posts
set in query when ES is unavailable. Props lukaspawlik
2.2.1
Version 2.2.1 is a bug fix release. Here are a listed of issues that have been resolved:
- Fix dashboard syncing delayed start issues.
- If plugins endpoint errors, try root endpoint to get the ES version.
- Make sure orderby is correct for default WooCommerce sorting. Props ivankristianto.
- Remove operator=>AND unneed execution code.
- Stop dashboard sync if error occurs in the middle. Props ivankristianto.
- Add
EP_INDEX_PREFIX
constant. If set, index names will be prefixed with the constant. Props allan23.
- Increase total field limit to 5000 and add filter. Props ssorathia.
- Prevent EP from auto-activating a feature that was force deactivated
- Prevent massive field Elasticsearch error when indexing large strings
- Increase max result window size to 1000000 and add filter.
2.2 (Requires re-index)
Version 2.2 rethinks the module process to make ElasticPress a more complete query engine solution. Modules are now auto-on and really just features. Why would anyone want to not use amazing functionality that improves speed and relevancy on their website? Features (previously modules) can of course be overridden and disabled. Features that don't have their minimum requirements met, such as a missing plugin dependency, are auto-disabled.
We've bumped the minimum Elasticsearch version to 1.7 (although we strongly recommend 2+). The maximum tested version of Elasticsearch is version 5.2. If you are running Elasticsearch outside this version range, you will see a warning in the dashboard.
Enhancements
- (Breaking change) Module registration API changed. See
register_module
in classes/class-ep-modules.php
.
- (Breaking change) Related posts are now in a widget instead of automatically being appending to content.
- (Breaking change) Admin module renamed to Protected Content.
- Admin warning if current Elasticsearch version is not between the min/max supported version. Version 2.2 supports versions 1.3 - 5.1.
- Auto-reindex on versions requiring reindex.
- User friendly admin notifications for ElasticPress not set up, first sync needed, and feature auto activation.
- Protected Content feature applies to all features. This means if Protected Content isn't active, search or WooCommerce integration won't happen in the admin.
- Add support for post_mime_type. Props Ritesh-patel
Bug Fixes
- Back compat with old
ep_search
function.
- Respect indexable post types in WooCommerce feature
- New product drafts not showing in WooCommerce admin list
- WooCommerce feature breaking image search in media library. Props Ritesh-patel
- WooCommerce order search broken
- Stop the insansity made private. Props sc0ttclark
- Fix multidimensional meta querys. Props Ritesh-patel.
- Properly show bulk index errors in WP-CLI
- Update ep_delete_post, include $post_type argument. Props Ritesh-patel
- Fix post_type product getting set in any WP_Query if tax_query is provided in WooCommerce feature. Props Ritesh-patel
- Adds 'number' param to satisfy WP v4.6+ fixing get_sites call. Props rveitch
- Order by proper relevancy in WooCommerce product search. Props ivankristianto
- Fix recursion fatal error due to oembed discovery during syncing. Props ivankristianto
2.1.2 (Requires re-index)
- Separate mapping for ES 5.0+
- Fix some unit tests
2.1.1
- Fix PHP 5.3 errors
- Properly show syncing button module placeholder during sync
2.1
- Redo UI
- Make plugin modular
- Remove unnecessary back up hosts code
- Bundle existing modules into plugin
- Support
meta_key
and meta_value
- Order by
meta_value_num
- Properly support
post_parent = 0
. Props tuanmh
- Add search scope file. Props rveitch
- Support WP_Query
post_status
. Props sc0ttclark
Backward compat breaks:
- Move ep_admin_wp_query_integration to search integration only. EP integration by default is available everywhere.
- Remove
keep alive
setting
- Remove setting to integrate with search (just activate the module instead)
- Back up hosts code removed
- Remove active/inactive state. Rather just check if an index is going on our not.
Bug fixes
- Fix
post__in
support
- Fix
paged
overwriting offset
- Fix integer and comma separated string
sites
WP_Query processing. Props jaisgit.
2.0.1
Bug fixes
- Don't load settings on front end. This fixes a critical bug causing ElasticPress to check the Elasticsearch connection on the front end.
2.0
10up ships ElasticPress 2.0 with
radical search algorithm improvements and a
more comprehensive integration of WP_Query. ElasticPress is now even closer to supporting the complete WP_Query API. This version also improves upon post syncing ensuring that post meta updates are synced to Elasticsearch, adds a number of important hooks, and, of course, fixes some pesky bugs.
Enhancements
- Radical search algorithm improvements for more relevant results (see #508 for details)
- Support meta
BETWEEN
queries.
- Improve GUI by disabling index status meta box text and improving instructions. Props ivanlopez
- Support
OR
relation for tax queries.
- Sync post to Elasticsearch when meta is added/updated.
- Support all taxonomies as root WP_Query arguments. Props tuanmh
- Add
ID
field to Elasticsearch mapping
- Support
post_parent
WP_Query arguments. Props tuanmh
- Add filter to disable printing of post index status. Props tuanmh
- Add useful CLI hooks
- Add a filter to bypass permission checking on sync (critical for front end updates)
Bugs
- Consider all remote request 20x responses as successful. Props tuanmh
- Fix plugin localization. Props mustafauysal
- Do query logging by default. Props lukaspawlik
- Fix cannot redeclare class issue. Props tuanmh
- Fix double querying Elasticsearch by ignoring
category_name
when tax_query
is present.
- Fix post deletion endpoint URL. Props lukaspawlik
A special thanks goes out to Tuan Minh Huynh and everyone else for contributions to version 2.0.
1.9.1
Quick bug fix version to address the GUI not working properly when plugin is not network enabled within multisite. Props to
Ivan Lopez
1.9
ElasticPress 1.9 adds in an admin UI, where you can set your Elasticsearch Host and run your index command, without needing to us WP-CLI. Version 1.9 also adds in some performance improvements to reduce memory consumption during indexing. Full list of enhancements and bug fixes:
Enhancements:
- Add in an Admin GUI to handle indexing. Props ChrisWiegman.
- Add option to not disable ElasticPress while indexing. Props lukaspawlik.
- Allow filtering of which post types we want to search for. Props rossluebe.
- Remove composer.lock from the repo. Props ChrisWiegman.
- Ensure both PHPUnit and WP-CLI are available in the development environment. Props ChrisWiegman.
- User lower-case for our composer name, so packagist can find us. Props johnpbloch.
- Check query_vars, not query to determine status. Props ChrisWiegman.
- Improve memory usage during indexing and fix unnecessary cache flushes. Props cmmarslender.
- Further reduce memory usage during indexing. Props lukaspawlik.
- Add post__in and post__not_in documentation. Props mgibbs189.
- Add Elasticsearch Shield authentication headers if constant is set. Props rveitch.
Bugs:
- Fix the --no-bulk indexing option. Props lukaspawlik.
- Fixed an error that occurs if no Elasticsearch host is running. Props petenelson.
- Fixed an exception error. Props dkotter.
- Fixed the WP-CLI status command. Props dkotter.
1.8 (Mapping change, requires reindex)
ElasticPress 1.8 adds a bunch of mapping changes for accomplishing more complex WP_Query functions such as filtering by term id and sorting by any Elasticsearch property. Version 1.8 also speeds up post syncing dramatically through non-blocking queries. Full list of enhancements and bug fixes:
Enhancements:
- Add a filter around the search fuzziness argument. Props dkotter.
- Make post indexing a non-blocking query. Props cmmarslender.
- Log queries for debugging. Makes ElasticPress Debug Bar plugin possible.
- Make
posts_per_page = -1
possible.
- Support term id and name tax queries.
- Add raw/sortable to property to term mapping. Props sc0ttkclark
- Add raw/sortable property to meta mapping. Props sc0ttkclark
- Add raw/sortable to author display name and login
Bugs:
- Fix post deletion. Props lukaspawlik.
- Properly flush cache with
wp_cache_flush
. Props jstensved
- When directly comparing meta values in a meta query, use the
raw
property instead of value
.
- Support arbitrary document paths in orderby. Props sc0ttkclark.
1.7 (Mapping change, requires reindex)
ElasticPress 1.7 restructures meta mapping for posts for much more flexible meta queries. The
post_meta
Elasticsearch post property has been left for backwards compatibility. As of this version, post meta will be stored in the
meta
Elasticsearch property.
meta
is structured as follows:
meta.value
(string)
meta.raw
(unanalyzed string)
meta.long
(unanalyzed number)
meta.double
(unanalyzed number)
meta.boolean
(unanalyzed number)
meta.date
(unanalyzed yyyy-MM-dd date)
meta.datetime
(unanalyzed yyyy-MM-dd HH:mm:ss datetime)
time
(unanalyzed HH:mm:ss time)
When querying posts, you will get back
meta.value
. However, if you plan to mess with the new post mapping, it's important to understand the intricacies.
The real implications of this is in
meta_query
. You can now effectively search by meta types. See the new section in
README.md for details on this.
1.7 also contains the following bugs/enhancements:
- (Bug) Prevent missed post indexing when duplicate post dates. Props lukaspawlik
- (Bug) Complex meta types are automatically serialized upon storage.
- (Enhancement) Index posts according to post type. Props sc0ttkclark
1.6.2 (Mapping change, requires reindex)
ElasticPress 1.6.2 fixes ALL backwards compatibility issues with Elasticsearch 2.0:
- Removes
fuzzy_like_this
query and uses multi_match
instead.
- Uses string instead of array for post type term when there is only one term.
1.6.1 (Mapping change, requires reindex)
ElasticPress 1.6.1 fixes mapping backwards compatibility issues with Elasticsearch 2.0:
- Removes the fields field type from object typed fields as they should be called properties.
- Remove path from object field types.
1.6
ElasticPress 1.6 contains a number of important enhancements and bug fixes. Most notably, we now support Elasticsearch fallback hosts and the indexing of attachments.
Bug Fixes:
- Clean up PHP Code Sniffer errors. Props chriswiegman
- Properly document Elasticsearch version
- Abide by
exclude_from_search
instead of public
when indexing post types. Props allan23 and ghosttoast.
- Allow posts to be indexed with invalid date values. Props tuanmh
- Support
ep_post_sync_kill
filter in bulk indexing. Props Stayallive
Enhancements:
- Add blog id to
ep_index_name
filter. Props kovshenin
- Support post caching in search
- Add recursive term indexing for heirarchal taxonomies. Props tuanmh
- Enable indexing of attachments
- Support fallback hosts in case main EP host is unavailable. Props chriswiegman
- Add
ep_retrieve_the_post
filter to support relevancy score manipulation. Props matthewspencer
- Make search results filterable. Props chriswiegman
1.5.1
Bug Fixes:
- Prevent notices from being thrown when non-existent index properties are accessed. This was happening for people how upgraded to 1.5 without doing a re-index. Props allan23
1.5
Bug Fixes:
Enhancements:
- Add support for category_name WP_Query parameter. Props ocean90
- Support limiting sites in network wide commands. Props bordoni
- Add support for method to un-integrate WP_Query. Props kingkool68
- Support
cache_results
in WP_Query
- Add action prior to starting WP-CLI index command
- Add missing headers to WP_CLI commands. Props chriswiegman
- Improve error reporting in bulk indexing during bad ES requests.
- Fix is_search check notice. Props allenmoore and allan23
- Added a filter to modify request headers. Props tuanmh
- Prevent bulk index from sending useless error emails. Props cmmarslender
- Add --offset parameter to cli indexing command. Stayallive
- Change the syncing hook to play better with plugins. Props jonathanbardo
- Support like query in post meta. Props tuanmh
- Sanitization fixes for PHPCS. Props mphillips
- Added filter to set default sort order. Props HKandulla
- MySQL DB completely removed from integrated ElasticPress WP Query. Props EduardMaghakyan and crebacz
1.4
Bug Fixes:
- Duplicate sync post hooks separated. Props superdummy
- Don't send empty index error emails. Props cmmarslender
- Remove default shard and indices configuration numbers but maintain backwards compatibility. Props zamoose
- Fix wrong author ID in post data. Props eduardmaghakyan
Enhancements:
date_query
and date parameters now supported in WP_Query. Props joeyblake and eduardmaghakyan
- Make all request headers filterable
- Add EP API key to all requests as a header if a constant is defined. Props zamoose
- Add index exists function; remove indexes on blog deletion/deactivation. Props joeyblake
- Refactor wp-cli stats for multisite. Props jaace
- Index mappings array moved to separate file. Props mikaelmattsson
- Support meta inequality comparisons. Props psorensen
1.3.1
- Support
date
in WP_Query orderby
. Props psorensen
1.3
- Support
meta_query
in WP_Query integration
- Improved documentation. Each WP-CLI command has been documented
- Add
elasticsearch
property to global post object to assist in debugging
ep_integrate
param added to allow for WP_Query integration without search. (Formally called ep_match_all)
- Filter added for post statuses (defaults to
publish
). Change the sync mechanism to make sure it takes all post statuses into account. Props jonathanbardo
- Bug fix: check if failed post exists in indexing. Props elliot-stocks
- Bug fix: properly check if setup is defined in indexing. Props elliot-stocks
- Bug fix: add WP_Query integration on init rather than plugins loaded. Props adamsilverstein
- Bug fix: Properly set global post object post type in loop. Props tott
- Bug fix: Do not check if index exists on every page load. Refactor so we can revert to MySQL after failed ES ping.
- Bug fix: Make sure we check
is_multisite()
if --network-wide
is provided. Props ivankruchkoff
- Bug fix: Abide by the
exclude_from_search
flag from post type when running search queries. Props ryanboswell
- Bug fix: Correct mapping of
post_status
to not_analyzed
to allow for filtering of the search query (will require a re-index). Props jonathanbardo
1.2
- Allow number of shards and replicas to be configurable.
- Improved searching algorithm. Favor exact matches over fuzzy matches.
- Query stack implementation to allow for query nesting.
- Filter and disable query integration on a per query basis.
- Support orderby
parameter in
WP_Query
- (Bug) We don't want to add the like_text query unless we have a non empty search string. This mimcs the behavior of MySQL or WP which will return everything if s is empty.
- (Bug) Change delete action to action_delete_post instead of action_trash_post
- (Bug) Remove _boost from mapping. _boost is deprecated by Elasticsearch.
- Improve unit testing for query ordering.
1.1
- Refactored
is_alive
, is_activated
, and is_activated_and_alive
. We now have functions is_activated
, elasticsearch_alive
, index_exists
, and is_activated
. This refactoring helped us fix #150.
- Add support for post_title and post_name orderby parameters in
WP_Query
integration. Add support for order parameters.
1.0
- Support
search_fields
parameter. Support author, title, excerpt, content, taxonomy, and meta within this parameter.
- Move all management functionality to WP-CLI commands
- Remove ES_Query and support everything through WP_Query
- Disable sync during import
- Check for valid blog ids in index names
- Improved bulk error handling
- No need for
ep_last_synced
meta
- No need for syncing taxonomy
- Improved unit test coverage
sites
WP_Query parameter to allow for search only on specific blogs
0.1.2
- Only index public taxonomies
- Support ES_Query parameter that designates post meta entries to be searched
- Escape post ID and site ID in API calls
- Fix escaping issues
- Additional tests
- Translation support
- Added is_alive function for checking health status of Elasticsearch server
- Renamed
statii
to status
0.1.0