Version 5.0.0
ElasticPress 5.0.0 contains some important changes. Make sure to read these highlights before upgrading:
- This version does not require a full reindex but it is recommended, especially for websites using synonyms containing spaces. See #3610.
- Meta keys are not indexed by default anymore. The new Weighting Dashboard allows admin users to mark meta fields as indexables. The new
ep_prepare_meta_allowed_keys
filter allows to add meta keys programmatically. See #3068. - Features now have their fields declared in JSON. Custom features may need to implement the
set_settings_schema()
method to work. See #3655. - The
Users
feature was moved to the ElasticPress Labs plugin and is no longer available in this plugin. If you use this feature, make sure to install and configure EP Labs before upgrading. See #3670. - The
Terms
andComments
features are now hidden by default for sites that do not have them active yet. Check our blog post for more info. See #3691. - New minimum versions (see #3668) are:
Min Max Elasticsearch 5.2 Unset WordPress 6.0+ latest PHP 7.4+ latest
Added
- New Sync page. Props @JakePT, @felipeelia, @apurvrdx1, @brandwaffle, @anjulahettige, @burhandodhy, and @MARQAS via #3657 and #3735.
- New feature settings screen. Props @JakePT, @felipeelia, @apurvrdx1, @brandwaffle, and @anjulahettige via #3712.
- New weighting dashboard with support for making meta fields searchable. Props @JakePT, @mehidi258, and @felipeelia via #3068.
- New Date Filter Block. Props @burhandodhy, @JakePT, and @felipeelia via #3700.
- Sync history to the Sync page. Props @JakePT, @felipeelia, @apurvrdx1, @brandwaffle, and @anjulahettige via #3664.
- Final status of syncs (success, with errors, failed, or aborted.) Props @felipeelia and @JakePT via #3669.
- REST API endpoint at
elasticpress/v1/features
for updating feature settings. Props @JakePT via #3676. - New
ElasticsearchErrorInterpreter
class. Props @felipeelia via #3661. - New
default_search
analyzer to differentiate what is applied during sync and search time. Props @felipeelia and @MARQAS via #3610 and #3703. - The sync page now describes what triggered the current sync, and previous syncs. Props @JakePT via #3722.
- Weighting and Synonyms Dashboards to multisites. Props @felipeelia via #3724.
- No-cache headers to sync calls. Props @felipeelia via #3731.
Changed
- Abstracted Sync page logic into a provider pattern. Props @JakePT via #3630.
- Moved syncing from an
admin-ajax.php
callback to a custom REST API endpoint with support for additional arguments. Props @JakePT via #3643. - Store previous syncs info, changed option name from
ep_last_index
toep_sync_history
. Props @felipeelia and @JakePT via #3647. - Features settings declared as JSON. Props @felipeelia and @JakePT via #3655.
- Tweaked layout and notifications style on the Status Report screen for consistency with the updated Sync page. Props @JakePT via #3662.
- Moved REST API endpoint definitions to controller classes. Props @JakePT via #3650.
- SyncManager array queues are now indexed by the blog ID. Props @sathyapulse and @felipeelia via #3689.
- Comments and Terms are now hidden by default. Props @felipeelia via #3691.
- WooCommerce-related hooks are now removed when switching to a site that does not have WC active. Props @felipeelia and @MARQAS via #3688.
- Run e2e tests against the minimum supported WordPress version. Props @felipeelia via #3540.
- Several tweaks in the Features settings API. Props @JakePT via #3708 and #3709.
- EP Settings are now reverted if it is not possible to connect to the new ES Server. Props @felipeelia, @burhandodhy, and @scottbuscemi via #3684.
- Node packages updated. Props @felipeelia via #3706.
- Updated the labels of feature settings and options for consistency and clarity. Props @JakePT via #3721.
- Depending on the requirements, some feature settings are now saved to be applied after a full sync. Props @felipeelia and @JakePT via #3720.
- Minimum requirements. Props @felipeelia and @brandwaffle via #3668.
- Old features will have their settings displayed based on their default setting values. Props @felipeelia and @JakePT via #3728.
- Radio and checkbox settings were changed from booleans to strings. Props @felipeelia and @JakePT via #3730.
- The troubleshooting article link was updated. Props @felipeelia and @anjulahettige via #3748.
Deprecated
- The
IndexHelper::get_last_index
method was replaced byIndexHelper::get_last_sync
. See #3647. - The
FailedQueries::maybe_suggest_solution_for_es
method was replaced byElasticsearchErrorInterpreter::maybe_suggest_solution_for_es
. See #3661. Weighting::render_settings_section
,Weighting::handle_save
,Weighting::redirect
, andWeighting::save_weighting_configuration
were deprecated in favor of React components. See #3068.
Removed
- Users-related files from the main plugin. Props @felipeelia via #3670.
- Removed mapping files related to older versions of Elasticsearch. Props @MARQAS via #3704.
Fixed
- Docblock for the
ep_facet_renderer_class
filter. Props @misfist via #3696. - Instant Results console warning. Props @burhandodhy via #3687.
- Total fields limit message interpretation. Props @felipeelia @JakePT via #3702.
- End to end tests intermittent failures. Props @felipeelia via #3572.
- React warning on Sync page. Props @burhandodhy via #3718.
- Content was not showing properly on the tooltop on install page. Props @burhandodhy via #3725.
- Redirect to correct sync url after enabling feature that requires a new sync. Props @burhandodhy via #3726.
- Post type setting wasn't respected during sync. Props @burhandodhy via #3727.
- Fix a JS error appearing when sync requests are intentionally stopped. Props @burhandodhy via #3736.
- Features description copy. Props @felipeelia, @burhandodhy, and @MARQAS via #3737.
- Endpoint URL field is not a URL type field. Props @burhandodhy via #3733.
- WooCommerce feature not autoactivating. Props @felipeelia via #3739.
- Elasticsearch errors interpretation. Props @felipeelia via #3741.
- Deactivating a feature via WP-CLI also takes into account draft states. Props @felipeelia via #3749.
See: https://github.com/10up/ElasticPress/milestone/71?closed=1