Version 5.1.4

Added

• New filter ep_facet_selected_filters. Props @burhandodhy via #3953.
• New filter ep_disable_query_logging to disable query logging. Props @davidsword and @rebeccahum via #4019.
• New setting to Protect Content to use WP default order in admin. Props @felipeelia and @realrellek via #4028.

Changed

• Apply ElasticPress filters to the requests in status and stats CLI commands. Props @edpittol via #4000.
• Autosuggest Endpoint field explanation. Props @burhandodhy and @felipeelia via #4009.
• Alignment of custom search results action icons. Props @felipeelia and @anjulahettige via #4020.
• Update all of our blocks apiVersion from 2 to 3, to indicate support for working in an iframed editor. Props @dkotter and @JakePT via #4029.
• If using the new way to index meta, avoid querying distinct meta fields in the sync page. Props @felipeelia and @majiix via #4033.
• Updated several composer and node packages. Node 20 is now the default version. Props @felipeelia via #4039 and #4043.
• Improve readability of sync output (MB/GB) and number formatting on the Health Status page. Props @columbian-chris via #4042.

Fixed

• Hardcoded tmp path replaced with a dynamic value. Props @burhandodhy via #3962.
• Variable names and descriptions in the docblocks for ep_formatted_args and ep_post_formatted_args. Props @barryceelen via #3977.
• Remove 'None' from Highlight tag list. Props @burhandodhy via #3979.
• [Facets] Incorrect link on description when not using a block theme. Props @felipeelia and @burhandodhy via #3997.
• Deprecation warning in strtotime() call. Props @felipeelia and @barryceelen via #3998.
• Special characters like \ in search terms for both Autosuggest and Instant Results. Props @felipeelia and @burhandodhy via #3999.
• [WooCommerce] Incompatibility when "Enable table usage" was enabled to filter the product catalog. Props @felipeelia and @burhandodhy via #4002.
• Deprecation warning related to PluginPostStatusInfo. Props @burhandodhy and @felipeelia via #4008.
• [Custom Results] Inconsistent Reordering Issue. Props @felipeelia, @anjulahettige, @burhandodhy via #4018 and #4045.
• Update supported document file types in Documents feature summary. Props @burhandodhy via #4024.
• "Exclude from search results" to work in AJAX contexts. Props @felipeelia and @burhandodhy via #4025.
• Retain CR & RD Labels Upon Saving Custom Search Result Posts. Props @felipeelia and @anjulahettige via #4020.
• Typo in "All filters" text domain. Props @felipeelia and @arturomonge via #4031.
• Autosuggest GA tracking to work when ad blocks are enabled. The dataLayer.push() call now pushes a custom event called ep_autosuggest_click with ep_autosuggest_search_term and ep_autosuggest_clicked_url as custom parameters. Props @felipeelia and @anjulahettige via #4032.
• Delay load_plugin_textdomain to init and set a Domain Path. Props @felipeelia via #4036.
• Only display the Exclude From Search checkbox if the post type supports custom-fields. Props @felipeelia and @maartenhunink via #4040.
• JS error when submit button is clicked without selecting a date. Props @burhandodhy via #4044.
• Deprecated warnings for margin style. Props @burhandodhy via #4046.

Security

• Bumped composer/composer from 2.7.0 to 2.7.8. Props @dependabot via #3972.
• Bumped symfony/process from 6.4.8 to 6.4.14. Props @dependabot via #3996.

Developer

• Tests use ES 8 by default. Props @felipeelia via #4017.
• Update E2E tests to work properly with the iframed block editor. Props @dkotter via #4029.
• E2e tests for WP 6.6. Props @felipeelia via #3959.
• E2e tests for WP 6.7. Props @felipeelia via #4010.
• Unit Tests: Fail faster on requests we know will fail. Props @felipeelia via #4047.
• E2e tests: Fix the debug-bar-elasticpress dependency of ElasticPress. Props @felipeelia via #4048.

See: https://github.com/10up/ElasticPress/milestone/88?closed=1

Version 5.1.3

Fixed

• Missing nonces on some sync trigger URLs, making them require a manual interaction from the user. Props @felipeelia via #3933.

See: https://github.com/10up/ElasticPress/milestone/86?closed=1

Version 5.1.2

This is a security release affecting all previous versions of ElasticPress.

Security

• Missing nonce verification for the sync triggered during activation of some features. Props @felipeelia and @dhakalananda via #3929.
• Missing nonce verification for retrying the EP connection and fixed PHPCS linting rules. Props @felipeelia via #3932.

See: https://github.com/10up/ElasticPress/milestone/85?closed=1

Version 5.1.1

Changed

• Update Support Article URLs. Props @felipeelia via #3919.

Fixed

• Status report page when indexable post types is an empty array. Props @furai via #3910.

See: https://github.com/10up/ElasticPress/milestone/84?closed=1

Version 5.1.0

Added

• [Filters] New ep_facet_enabled_in_editor filter to enabled facet blocks in the post editor. Props @JiveDig and @felipeelia via #3845.
• Official support to Elasticsearch 8.x. Props @felipeelia via #3854.
• A new Sync errors tab, with errors grouped by type and links to support documentation when available. Props @JakePT and @apurvrdx1 via #3803.
• [WooCommerce] HPOS compatibility notice for WooCommerce Orders. Props @felipeelia via #3861.
• [Synonyms] A new settings screen with the the ability to bulk delete synonyms, support for many-to-many replacements, and a new type of synonym for terms with a hierarchical relationship, called hyponyms. Props @JakePT and @apurvrdx1 via #3814.
• Infinite loop when using excerpt highlighting with posts that use blocks that print an excerpt. Props @felipeelia and @JakePT via #3867.
• Context parameter to the get_capability() function. Props @felipeelia and @selim13 via #3866.
• A tooltip for meta keys to the weighting screen to allow seeing the full key if it has been truncated. Props @JakePT via #3865.
• New ep_weighting_options filter to modify the weighting dashboard options. Props @burhandodhy via #3827.
• New ep_post_test_meta_value filter. Props @felipeelia via #3850.
• New message related to indices limits on ElasticPress.io. Props @felipeelia via #3898.

Changed

• Acknowledge all Elasticsearch modules, making the Documents feature available in ES 8 installations by default. Props @felipeelia, @Serverfox, and @jerasokcm via #3844.
• [Documents] Index CSV and TXT file contents. Props @felipeelia via #3885.
• [Documents] Only set documents-related parameters if no post type was set or if the list already contains attachments. Props @felipeelia via #3889.
• Automatically open the error log when a sync completes with errors. Props @JakePT and @felipeelia via #3895.
• Aggregations created with the 'aggs' WP_Query parameter, are now retrievable using $query->query_vars['ep_aggregations']. Props @felipeelia via #3847.
• Major refactor of the Term::format_args() method and conditionally set search fields for term queries in REST API requests. Props @felipeelia and @mgurtzweiler via #3869.
• Replaced lee-dohm/no-response with actions/stale to help with closing no-response/stale issues. Props @jeffpaul via #3870.
• Bumped actions/upload-artifact from v3 to v4. Props @iamdharmesh via #3897.
• Required node version. Props @oscarssanchez via #3896.

Fixed

• [Autosuggest] Hide the Autosuggest Endpoint URL field for EP.io users. Props @felipeelia and @JakePT via #3835.
• [Autosuggest] Google Analytics integration gtag call. Props @felipeelia and @JakePT via #3835.
• [Autosuggest] Link click when using a touchpad. Props @romanberdnikov via #3818.
• [Autosuggest] Pressing Enter to select an Autosuggest suggestion would instead open Instant Results. Props @JakePT via #3864.
• [Synonyms] Fatal error when saving synonyms if an index does not exist. Props @felipeelia, @MARQAS, @randallhedglin, and @bispldeveloper via #3846.
• [Synonyms] Fix Synonyms case sensitive issue. Props @burhandodhy via #3857.
• [Documents] Media search returns no result in admin dashboard. Props @felipeelia and @burhandodhy via #3837 and #3871.
• [WooCommerce] E2e tests. Props @felipeelia via #3848.
• [Instant Results] A default post type filter set by a field in the search form was cleared if a new search term was entered. Props @JakePT and @burhandodhy via #3891.
• Inconsistent search results when calling the same function via PHP and Ajax. Props @burhandodhy via #3875.
• Unit test related to blog creation. Props @felipeelia and @burhandodhy via #3839.
• Correct PHPdoc return type for Elasticsearch::index_document and related methods. Props @ictbeheer via #3881.
• Unnecessary horizontal scroll for the <pre> tag on the status report page. Props @burhandodhy via #3894.

Security

• Bumped composer/composer from 2.6.5 to 2.7.0. Props @dependabot via #3831

See: https://github.com/10up/ElasticPress/milestone/79?closed=1

Version 5.0.2

Changed

• [Terms] Counts are now calculated with wp_count_terms() in query_db. Props @rebeccahum via #3791.
• Composer and npm files are now part of the final package. Props @felipeelia via #3810.

Fixed

• [WooCommerce] Not use a hard-coded list of order post types. Props @felipeelia via #3807.
• [Autosuggest] Stop calling the get-autosuggest-allowed endpoint to build the REST API schema. Props @felipeelia via #3809.

Security

• Bumped follow-redirects from 1.15.3 to 1.15.4. Props @dependabot via #3808.

See: https://github.com/10up/ElasticPress/milestone/83?closed=1

Version 5.0.1

Added

• Failed queries in the Index Health page will now be outputted with their error messages. Props @felipeelia and @pvnanini via #3776.

Fixed

• Queries failing due to a "request body is required" error. Props @felipeelia via #3770.
• Fatal error when site has a bad cookie. Props @burhandodhy via #3778.
• Broken i18n of some strings. Props @felipeelia and @iazema via #3780.
• PHP Warning on term archive pages when the term was not found. Props @felipeelia and @Igor-Yavych via #3777.
• PHP warning when using block themes. Props @felipeelia and @tropicandid via #3781.
• Several typos. Props @szepeviktor via #3750.
• Index cleanup process - offset being zeroed too late. Props @pknap via #3765.
• PHP warning in site health page. Props @turtlepod via #3758.
• ReactDOM.render is no longer supported in React 18. Props @burhandodhy and @felipeelia via #3686.
• E2e tests with WordPress 6.4. Props @felipeelia via #3771.
• PHP Setup in GitHub Actions. Props @felipeelia via #3784.

See: https://github.com/10up/ElasticPress/milestone/82?closed=1

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 and Comments 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 to ep_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 by IndexHelper::get_last_sync. See #3647.
• The FailedQueries::maybe_suggest_solution_for_es method was replaced by ElasticsearchErrorInterpreter::maybe_suggest_solution_for_es. See #3661.
• Weighting::render_settings_section, Weighting::handle_save, Weighting::redirect, and Weighting::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 vi...

Version 4.7.2

Note that starting from the ElasticPress 5.0.0 release the Users feature will be moved to the ElasticPress Labs plugin. The Terms and Comments features will remain in ElasticPress but will be available only if enabled via code. Check our blog post for more info.

Added

• New ep_highlight_number_of_fragments filter. Props @dgnorrod and @felipeelia via #3681.

• =PHP 7.0 version check. Props @bmarshall511 and @felipeelia via #3641.

• GitHub action to automatically open a new issue when a new version of WordPress is released. Props @felipeelia via #3666.

Removed

• Unnecessary aliases in use statements. Props @felipeelia via #3671.

Fixed

• Calls to ep_woocommerce_default_supported_post_types were ignored. Props @felipeelia and @MARQAS via #3679.
• WooCommerce Orders search field disappearing when Orders Autosuggest receives an unexpected response from ElasticPress.io. Props @JakePT and @anjulahettige via #3682.
• Call composer while building docs. Props @felipeelia via #3625.
• Make sure post__not_in and post_status are translated into arrays, not objects. Props @felipeelia via #3652 and #3680.
• Updated phpDoc entries. Props @renatonascalves via #3635.
• Docblock for Utils\get_option return type. Props @felipeelia via #3653.
• Docblock for ep_capability and ep_network_capability filters. Props @burhandodhy via #3685.
• PHP warning related to the Autosuggest template generation. Props @felipeelia via #3651.
• WooCommerce unit tests running multiple times. Props @felipeelia via #3656.
• Display the meta range facet block in versions prior to WP 6.1. Props @felipeelia and @MARQAS via #3658.
• Number of expected arguments for add_attachment and edit_attachment. Props @burhandodhy via #3690.
• Error while running composer install on PHP 8. Props @burhandodhy via #3683.

Security

• Bumped composer/composer from 2.5.8 to 2.6.4. Props @dependabot via #3672.

See: https://github.com/10up/ElasticPress/milestone/78?closed=1

Version 4.7.1

Note that starting from the ElasticPress 5.0.0 release the Users feature will be moved to the ElasticPress Labs plugin. The Terms and Comments features will remain in ElasticPress but will be available only if enabled via code. Check our blog post for more info.

Added

• Synonyms and weighting settings added to the status report. Props @felipeelia via #3609.

Changed

• Composer packages are namespaced by Strauss. Props @felipeelia and @junaidbhura via #3621.
• E2e tests now log the formatted query info from Debug Bar ElasticPress. Props @felipeelia via #3613.

Fixed

• WooCommerce products sorted by popularity are now always sorted in a descending order. Props @felipeelia and @burhandodhy via #3619.
• E2e tests with WordPress 6.3. Props @felipeelia via #3599.

See: https://github.com/10up/ElasticPress/milestone/77?closed=1