ElasticPress

Changelog

5.2.0 – 2025-04-10

This version bumps the minimum WordPress version to 6.2+.

Added:

• New ACF Repeater Field Compatibility feature. Props @felipeelia.
• Add new filter ep.InstantResults.filter.taxonomy.terms. Props @burhandodhy and @syedc.
• Support to “number” fields in the Features Settings API. Props @felipeelia.
• Add include, exclude, upper-limit-object-id, and lower-limit-object-id support for the term and comment indexable. Props @burhandodhy.
• Ability to display results on focus back + cached autosuggest results on same query. Props @oscarssanchezz, @JakePT, and @felipeelia.
• Document status displayed in the admin bar. Props @felipeelia, @tott, and @burhandodhy.

Changed:

• Minimum required version of WordPress (from 6.0 to 6.2). Props @felipeelia.
• ElasticPress\Feature\RelatedPosts::get_related_query(), ElasticPress\Feature\RelatedPosts::find_related() parameter name change to $post_return. Props @oscarssanchez and @felipeelia.
• The ep_remote_request action to also run on non-blocking requests. Props @felipeelia.
• Potentially resource intensive status reports are loaded on demand with AJAX. Props @oscarssanchezz, @felipeelia, and @archon810.
• If a feature doesn’t have all its requirements fulfilled, prevent it to run its setup method. Props @felipeelia.

Fixed:

• PHP warning: Attempt to read property “base” on null. Props @burhandodhy and @yarovikov.
• Notice not displayed while updating a term. Props @burhandodhy and @MARQAS.
• PHP Notice: Function _load_textdomain_just_in_time was called incorrectly. Props @burhandodhy.
• PHP 8.4: Implicitly marking parameter $woocommerce as nullable is deprecated. Props @BrookeDot.
• WP-CLI sync timer resetting after 16 minutes. Props @felipeelia and @columbian-chris.
• Cannot get outside of autosuggest list pressing up on first item. Props @oscarssanchezz, @JakePT, and @felipeelia.
• Prevent other code from modifying the ORDERBY clause in Post and Term indexable queries. Props @burhandodhy and @felipeelia.
• Date Query returns no result when the before and after range is the same and inclusive is set to true. Props @burhandodhy and @ErikBrendel.
• Warning for undefined “post_type” array key. Props @econscript.
• Delete a post from the index if it had a password added. Props @felipeelia and @dtakken.
• [Synonyms] Linebreaks being wrongly replaced in Windows Systems. Props @nymwo.
• Deprecated 36px default size is deprecated warnings. Props @burhandodhy.
• The Sync Complete message being displayed when the log is cleared. Props @felipeelia and @burhandodhy.
• Selecting a value in the date filter not redirecting users back to page 1. Props @felipeelia and @burhandodhy.
• Discard Changes button coming back when saving the feature twice. Props @felipeelia and @burhandodhy.
• WooCommerce Orders Incompatibility not appearing when plugin is activated network wide. Props @burhandodhy.

Security:

• Bumped serialize-javascript from 6.0.1 to 6.0.2, jsdoc from 3.6.11 to 4.0.4, and taffydb. Props @dependabot.
• Bumped tar-fs from from 3.0.6 to 3.0.8. Props @dependabot.

Developer:

• Trufflehog GitHub Action to detect secrets leak. Props @felipeelia and @tott.
• Install Unit Tests without relying on SVN. Props @felipeelia.
• Remove the setup step from the build-with-vendor-prefixed.yml and standardize the use of Node Version. Props @burhandodhy.
• Fixed E2E tests. Props @burhandodhy.
• PHP, JS and Style lint fixes. Props @oscarssanchez and @felipeelia.
• Several node and composer packages updated. Props @felipeelia.
• Updated the chart.js library. Props @felipeelia.

5.1.4 – 2024-12-12

Added:

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

Changed:

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

Fixed:

• Hardcoded tmp path replaced with a dynamic value. Props @burhandodhy.
• Variable names and descriptions in the docblocks for ep_formatted_args and ep_post_formatted_args. Props @barryceelen.
• Remove ‘None’ from Highlight tag list. Props @burhandodhy.
• [Facets] Incorrect link on description when not using a block theme. Props @felipeelia and @burhandodhy.
• Deprecation warning in strtotime() call. Props @felipeelia and @barryceelen.
• Special characters like \ in search terms for both Autosuggest and Instant Results. Props @felipeelia and @burhandodhy.
• [WooCommerce] Incompatibility when “Enable table usage” was enabled to filter the product catalog. Props @felipeelia and @burhandodhy.
• Deprecation warning related to PluginPostStatusInfo. Props @burhandodhy and @felipeelia.
• [Custom Results] Inconsistent Reordering Issue. Props @felipeelia, @anjulahettige, @burhandodhy.
• Update supported document file types in Documents feature summary. Props @burhandodhy.
• “Exclude from search results” to work in AJAX contexts. Props @felipeelia and @burhandodhy.
• Retain CR & RD Labels Upon Saving Custom Search Result Posts. Props @felipeelia and @anjulahettige.
• Typo in “All filters” text domain. Props @felipeelia and @arturomonge.
• 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.
• Delay load_plugin_textdomain to init and set a Domain Path. Props @felipeelia.
• Only display the Exclude From Search checkbox if the post type supports custom-fields. Props @felipeelia and @maartenhunink.
• JS error when submit button is clicked without selecting a date. Props @burhandodhy.
• Deprecated warnings for margin style. Props @burhandodhy.

Security:

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

Developer:

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

5.1.3 – 2024-06-11

Fixed:

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

5.1.2 – 2024-06-11

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.
• Missing nonce verification for retrying the EP connection and fixed PHPCS linting rules. Props @felipeelia.

5.1.1 – 2024-05-27

Changed:

• Update Support Article URLs. Props @felipeelia.

Fixed:

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

5.1.0 – 2024-04-29

Added:

• [Filters] New ep_facet_enabled_in_editor filter to enabled facet blocks in the post editor. Props @JiveDig and @felipeelia.
• Official support to Elasticsearch 8.x. Props @felipeelia.
• A new Sync errors tab, with errors grouped by type and links to support documentation when available. Props @JakePT and @apurvrdx1.
• [WooCommerce] HPOS compatibility notice for WooCommerce Orders. Props @felipeelia.
• [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.
• Infinite loop when using excerpt highlighting with posts that use blocks that print an excerpt. Props @felipeelia and @JakePT.
• Context parameter to the get_capability() function. Props @felipeelia and @selim13.
• A tooltip for meta keys to the weighting screen to allow seeing the full key if it has been truncated. Props @JakePT.
• New ep_weighting_options filter to modify the weighting dashboard options. Props @burhandodhy.
• New ep_post_test_meta_value filter. Props @felipeelia.
• New message related to indices limits on ElasticPress.io. Props @felipeelia.

Changed:

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

Fixed:

• [Autosuggest] Hide the Autosuggest Endpoint URL field for EP.io users. Props @felipeelia and @JakePT.
• [Autosuggest] Google Analytics integration gtag call. Props @felipeelia and @JakePT.
• [Autosuggest] Link click when using a touchpad. Props @romanberdnikov.
• [Autosuggest] Pressing Enter to select an Autosuggest suggestion would instead open Instant Results. Props @JakePT.
• [Synonyms] Fatal error when saving synonyms if an index does not exist. Props @felipeelia, @MARQAS, @randallhedglin, and @bispldeveloper.
• [Synonyms] Fix Synonyms case sensitive issue. Props @burhandodhy.
• [Documents] Media search returns no result in admin dashboard. Props @felipeelia and @burhandodhy via #3837.
• [WooCommerce] E2e tests. Props @felipeelia.
• [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.
• Inconsistent search results when calling the same function via PHP and Ajax. Props @burhandodhy.
• Unit test related to blog creation. Props @felipeelia and @burhandodhy.
• Correct PHPdoc return type for Elasticsearch::index_document and related methods. Props @ictbeheer.
• 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.

5.0.2 – 2024-01-16

Changed:

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

Fixed:

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

Security:

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

5.0.1 – 2023-12-12

Added:

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

Fixed:

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

5.0.0 – 2023-11-01

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.
• 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.
• Features now have their fields declared in JSON. Custom features may need to implement the set_settings_schema() method to work.
• 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.
• 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.
• New minimum versions are:
  • Elasticsearch: 5.2
  • WordPress: 6.0
  • PHP: 7.4

Added:

• New Sync page. Props @JakePT, @felipeelia, @apurvrdx1, @brandwaffle, @anjulahettige, @burhandodhy, and @MARQAS.
• New feature settings screen. Props @JakePT, @felipeelia, @apurvrdx1, @brandwaffle, and @anjulahettige.
• New weighting dashboard with support for making meta fields searchable. Props @JakePT, @mehidi258, and @felipeelia.
• New Date Filter Block. Props @burhandodhy, @JakePT, and @felipeelia.
• Sync history to the Sync page. Props @JakePT, @felipeelia, @apurvrdx1, @brandwaffle, and @anjulahettige.
• Final status of syncs (success, with errors, failed, or aborted.) Props @felipeelia and @JakePT.
• REST API endpoint at elasticpress/v1/features for updating feature settings. Props @JakePT.
• New ElasticsearchErrorInterpreter class. Props @felipeelia.
• New default_search analyzer to differentiate what is applied during sync and search time. Props @felipeelia and @MARQAS.
• The sync page now describes what triggered the current sync, and previous syncs. Props @JakePT.
• Weighting and Synonyms Dashboards to multisites. Props @felipeelia.
• No-cache headers to sync calls. Props @felipeelia.

Changed:

• Abstracted Sync page logic into a provider pattern. Props @JakePT.
• Moved syncing from an admin-ajax.php callback to a custom REST API endpoint with support for additional arguments. Props @JakePT.
• Store previous syncs info, changed option name from ep_last_index to ep_sync_history. Props @felipeelia and @JakePT.
• Features settings declared as JSON. Props @felipeelia and @JakePT.
• Tweaked layout and notifications style on the Status Report screen for consistency with the updated Sync page. Props @JakePT.
• Moved REST API endpoint definitions to controller classes. Props @JakePT.
• SyncManager array queues are now indexed by the blog ID. Props @sathyapulse and @felipeelia.
• Comments and Terms are now hidden by default. Props @felipeelia.
• WooCommerce-related hooks are now removed when switching to a site that does not have WC active. Props @felipeelia and @MARQAS.
• Run e2e tests against the minimum supported WordPress version. Props @felipeelia.
• Several tweaks in the Features settings API. Props @JakePT via #3708.
• EP Settings are now reverted if it is not possible to connect to the new ES Server. Props @felipeelia, @burhandodhy, and @scottbuscemi.
• Node packages updated. Props @felipeelia.
• Updated the labels of feature settings and options for consistency and clarity. Props @JakePT.
• Depending on the requirements, some feature settings are now saved to be applied after a full sync. Props @felipeelia and @JakePT.
• Minimum requirements. Props @felipeelia and @brandwaffle.
• Old features will have their settings displayed based on their default setting values. Props @felipeelia and @JakePT.
• Radio and checkbox settings were changed from booleans to strings. Props @felipeelia and @JakePT.
• The troubleshooting article link was updated. Props @felipeelia and @anjulahettige.

Deprecated:

• The IndexHelper::get_last_index method was replaced by IndexHelper::get_last_sync.
• The FailedQueries::maybe_suggest_solution_for_es method was replaced by ElasticsearchErrorInterpreter::maybe_suggest_solution_for_es.
• Weighting::render_settings_section, Weighting::handle_save, Weighting::redirect, and Weighting::save_weighting_configuration were deprecated in favor of React components.

Removed:

• Users-related files from the main plugin. Props @felipeelia.
• Removed mapping files related to older versions of Elasticsearch. Props @MARQAS.

Fixed:

• Docblock for the ep_facet_renderer_class filter. Props @misfist.
• Instant Results console warning. Props @burhandodhy.
• Total fields limit message interpretation. Props @felipeelia @JakePT.
• End to end tests intermittent failures. Props @felipeelia.
• React warning on Sync page. Props @burhandodhy.
• Content was not showing properly on the tooltop on install page. Props @burhandodhy.
• Redirect to correct sync url after enabling feature that requires a new sync. Props @burhandodhy.
• Post type setting wasn’t respected during sync. Props @burhandodhy.
• Fix a JS error appearing when sync requests are intentionally stopped. Props @burhandodhy.
• Features description copy. Props @felipeelia, @burhandodhy, and @MARQAS.
• Endpoint URL field is not a URL type field. Props @burhandodhy.
• WooCommerce feature not autoactivating. Props @felipeelia.
• Elasticsearch errors interpretation. Props @felipeelia.
• Deactivating a feature via WP-CLI also takes into account draft states. Props @felipeelia.

4.7.2 – 2023-10-10

Added:

• New ep_highlight_number_of_fragments filter. Props @dgnorrod and @felipeelia.
• >=PHP 7.0 version check. Props @bmarshall511 and @felipeelia.
• GitHub action to automatically open a new issue when a new version of WordPress is released. Props @felipeelia.

Removed:

• Unnecessary aliases in use statements. Props @felipeelia.

Fixed:

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

Security:

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

4.7.1 – 2023-08-31

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.

Changed:

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

Fixed:

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

4.7.0 – 2023-08-10

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:

• Exclude Media Attachments from search results. Props @burhandodhy.
• New Default to Site Language option in the language dropdown in ElasticPress’ settings page. Props @felipeelia.
• Compatibility with block themes for the Facet meta blocks. Props @felipeelia.
• Integrate Did You Mean feature in the Instant Results. Props @burhandodhy and @JakePT.
• All blocks now support styling features in themes that support them. Props @JakePT.
• Descriptions and keywords have been added to all blocks. Props @JakePT.
• New ep_stop filter, that changes the stop words used according to the language set. Props @felipeelia.
• New get-index-settings WP-CLI command. Props @felipeelia.
• New ep_facet_tax_special_slug_taxonomies filter. Props @oscarssanchez.
• New --stop-on-error flag to the sync command. Props @oscarssanchez.
• New get WP-CLI command. Props @felipeelia.
• Transient utility functions. Props @felipeelia.
• Indices’ language settings in status reports. Props @felipeelia.
• Initial changes to implement a DI Container. Props @felipeelia and @tott.
• New $only_indexable parameter to the Utils\get_sites() function. Props @felipeelia.

Changed:

• WooCommerce feature only integrates with queries that are the main query, a search, or have ep_integrate set as true. Props @felipeelia.
• Miscellaneous changes to all blocks, including their category, names, and code structure. Props @JakePT, @oscarssanchez, and @felipeelia.
• The Facets feature was renamed to Filters. Props @JakePT and @felipeelia.
• The WooCommerce feature was refactored, separating code related to products and orders. Props @felipeelia.
• Transients deletion during uninstall. Props @felipeelia.
• Bump Elasticsearch version to 7.10.2 for E2E tests. Props @burhandodhy.
• Refactor get_settings() usage inside ElasticPress features. Props @oscarssanchez and @felipeelia.
• In a multisite, if a site is indexable or not is now stored in site meta, instead of a blog option. Props @felipeelia.
• Autosuggest authenticated requests are not cached anymore and are only sent during the sync process or when the weighting dashboard is saved. Props @felipeelia and @kovshenin.
• Use createRoot instead of render to render elements. Props @oscarssanchez, @burhandodhy, @JakePT, and @felipeelia.
• Moved methods to abstract Facet classes. Props @oscarssanchez and @felipeelia.
• Only display available languages in the Settings screen. Props @felipeelia and @JakePT.
• WooCommerce feature description. Props @brandwaffle, @felipeelia, and @JakePT.

Deprecated:

• Autosuggest::delete_cached_query() was deprecated without a replacement. See #3566.
• EP_Uninstaller::delete_related_posts_transients() and EP_Uninstaller::delete_total_fields_limit_transients() was merged into EP_Uninstaller::delete_transients_by_name. See #3548.
• The ep_woocommerce_default_supported_post_types filter was split into ep_woocommerce_orders_supported_post_types and ep_woocommerce_products_supported_post_types. See #3502.
• The ep_woocommerce_supported_taxonomies filter is now ep_woocommerce_products_supported_taxonomies. See #3502.
• All old WooCommerce\Orders methods were migrated to the new WooCommerce\OrdersAutosuggest class. See #3502.
• The Elasticsearch::clear_total_fields_limit_cache() method was replaced by Elasticsearch::clear_index_settings_cache(). See #3552.
• Several methods that were previously part of the WooCommerce\WooCommerce class were moved to the new WooCommerce\Product class. See #3502.
• Several methods that were specific to Facet types were moved to the new Block and Renderer abstract classes. See #3499.

Fixed:

• Same error message being displayed more than once on the Dashboard sync. Props @felipeelia, @MARQAS, @tott, and @wildberrylillet.
• Sync media item when attaching or detaching media. Props @MARQAS and @felipeelia.
• Display “Loading results” instead of “0 results” on first search using Instant Results. Props @oscarssanchez and @JakePT.
• Highlighting returning inaccurate post title when partial/no term match on Instant Results. Props @oscarssanchez, @JakePT, and @tomi10up.
• Warning in Orders Autosuggest: "Creation of dynamic property $search_template is deprecated". Props @burhandodhy.
• Warning while using PHP 8.1+: Deprecated: version_compare(): Passing null to parameter #1 ($version1) of type string is deprecated. Props @felipeelia and @burhandodhy.
• Warning in the metadata range facet renderer: Undefined array key "is_preview". Props @felipeelia and @burhandodhy.

Security:

• Bumped word-wrap from 1.2.3 to 1.2.4. Props @dependabot.
• Bumped tough-cookie from 4.1.2 to 4.1.3 and @cypress/request from 2.88.10 to 2.88.12. Props @dependabot.

4.6.1 – 2023-07-05

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:

• Add doc url for “Did You Mean” feature. Props @burhandodhy.

Changed:

• Use wp_cache_supports over wp_cache_supports_group_flush. Props @spacedmonkey.
• Update the ep_exclude_from_search post meta only if it is set or has some value. Props @MARQAS and @columbian-chris.

Fixed:

• Deprecation notice in ElasticPress\Feature\WooCommerce\Orders. Props @mwidmann.
• Don’t apply a facet filter to the query if the filter value is empty. Props @burhandodhy.
• Syncing a post with empty post meta key. Props @MARQAS and @oscarssanchez.
• Order by clauses with Elasticsearch field formats are not changed anymore. Props @felipeelia and @tlovett1.
• Failed Query logs are automatically cleared on refreshing the “Status Report” page. Props @burhandodhy.
• Warning message on Health page when Last Sync information is not available. Props @burhandodhy.
• Deprecation notice: json_encode(): Passing null to parameter #2. Props @burhandodhy.
• Documentation of the ep_facet_search_get_terms_args filter. Props @burhandodhy.

4.6.0 – 2023-06-13

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:

• ‘Did you mean’ feature. Props @burhandodhy, @felipeelia, @brandwaffle, and @tott.
• Facet by Post type. Props @oscarssanchez, @felipeelia, and @burhandodhy.
• Two new options to disable weighting results by date in WooCommerce products related queries. Props @MARQAS and @felipeelia.
• Sort meta queries by named clauses and sort by different meta types. Props @felipeelia and @selim13.
• New --force flag in the sync WP-CLI command, to stop any other ongoing syncs. Props @felipeelia and @tomjn.
• Installers added to composer.json, so installer-paths works without any additional requirement. Props @felipeelia and @tomjn.
• Links to Patchstack Vulnerability Disclosure Program. Props @felipeelia and @brandwaffle.
• E2E tests for Password Protected Post. Props @burhandodhy and @felipeelia.

Changed:

• If no index is found, the “failed queries” message will be replaced with a prompt to sync. Props @felipeelia.
• Bumped Cypress version to v12. Props @felipeelia.
• Documentation partially moved to Zendesk. Props @felipeelia and @brandwaffle.

Fixed:

• Fatal error related to the maybe_process_error_limit function. Props @burhandodhy.
• Display the error message returned by Elasticsearch if a mapping operation fails. Props @felipeelia via #3464.
• Negative menu_order values being transformed into positive numbers. Props @felipeelia and @navidabdi.
• Password protected content being indexed upon save when Protected Content is not active. Props @felipeelia and @burhandodhy.
• Error message when the Elasticsearch server is not available during the put mapping operation. Props @felipeelia.

4.5.2 – 2023-04-19

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_enable_query_integration_during_indexing filter. Props @rebeccahum.

Changed:

• Automated message sent in GitHub issues after 3 days of inactivity. Props @felipeelia and @brandwaffle.

Fixed:

• Authenticated requests for autosuggest were not being properly cached while using external object cache. Props @felipeelia.

4.5.1 – 2023-04-11

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_instant_results_args_schema filter for filtering Instant Results arguments schema. Props @JakePT.
• New ep.Autosuggest.navigateCallback JS filter for changing the behavior of a clicked element on Autosuggest. Props @oscarssanchez, @felipeelia, and @JakePT.
• New ep.Autosuggest.fetchOptions JS filter for filtering Elasticsearch fetch configuration of Autosuggest. Props @tlovett1, @MARQAS, and @felipeelia.
• Code linting before pushing to the repository. Props @felipeelia.
• Unit tests for the Status Reports feature. Props @burhandodhy.

Changed:

• Meta field facets now only filter based on fields selected on blocks. The new ep_facet_should_check_if_allowed filter reverts this behavior. Props @felipeelia and @burhandodhy.

Fixed:

• Instant Results crashing when using taxonomies as facets that are attached to both searchable and non-searchable post types. Props @JakePT.
• Fatal error during plugin uninstall. Props @felipeelia.
• Compatibility issue which prevented Instant Results from working in WordPress 6.2. Props @JakePT.
• Fatal error while syncing on older versions of WordPress. Props @felipeelia, @TorlockC.
• Facets removing taxonomy parameters in the URL when not using pretty permalinks. Props @MARQAS and @felipeelia.
• JS errors when creating Facet blocks in WP 6.2. Props @felipeelia and @burhandodhy.
• ep_index_meta option blowing up on an indexing process with many errors. Props @rebeccahum and @felipeelia.
• Typo in index_output WP-CLI command help text. Props @bratvanov.
• React warning messages for the comments block. Props @burhandodhy.
• Fixed action_edited_term to call kill_sync in SyncManager for post Indexable. Props @rebeccahum.
• Undefined array key 'index' during sync. Props @felipeelia and @burhandodhy.
• Meta Range Facet Block e2e tests. Props @oscarssanchez and @felipeelia.
• Users e2e tests using WP 6.2. Props @felipeelia.

Security:

• Bumped webpack from 5.75.0 to 5.76.3. Props @dependabot.

4.5.0 – 2023-03-09

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.

ElasticPress 4.5.0 release highlights:

• Autosuggest for WooCommerce Orders (#3175, #3308, #3321, #3324, #3323, #3310, #3349, #3339, and #3363)
• New Facet by Meta Range block (#3289, #3342, #3337, #3361, #3364, #3368, and #3365)
• ElasticPress.io messages system (#3162 and #3376)
• Indices of disabled features will be deleted during a full sync (#3261)
• WooCommerce Queries (#3259 and #3362)

Added:

• Autosuggest for WooCommerce Orders. Props @JakePT and @felipeelia.
• New Facet by Meta Range block (currently in Beta.) Props @felipeelia.
• Option to display term counts in Facets blocks. Props @felipeelia.
• New capability for managing ElasticPress. Props @tlovett1, @tott, and @felipeelia.
• New “Download report” button in the Status Report page. Props @felipeelia.
• ElasticPress.io messages system. Props @felipeelia and @JakePT.
• WP CLI commands get-search-template, put-search-template, and delete-search-template. Props @oscarssanchez.
• New --status parameter to the get-indices WP-CLI command. Props @felipeelia.
• New ep_instant_results_per_page filter for changing the number of results per page in Instant Results. Props @JakePT.
• Support for post_parent__in and post_parent__not_in. Props @MARQAS.
• New ep_sync_args filter. Props @felipeelia and @nickchomey.
• “Full Sync” (Yes/No) to the Last Sync section in Status Report. Props @felipeelia.
• New ep_user_register_feature and ep_feature_is_visible filters. Props @felipeelia.
• Requests now have a new header called X-ElasticPress-Request-ID to help with debugging. Props @felipeelia.
• Compatibility with 'orderby' => 'none' in WP_Query. Props @felipeelia.
• Unit tests related to the ep_weighting_configuration_for_search filter. Props @felipeelia.
• New Unit tests for the WooCoomerce feature. Props @burhandodhy and @felipeelia.
• Description for the --network-wide flag in WP-CLI commands. Props @MARQAS.
• New is_available() helper method in the Feature class. Props @burhandodhy.

Changed:

• Indices of disabled features will be deleted during a full sync. Mappings of needed but non-existent indices will be added even during a regular sync. Props @felipeelia.
• Reduced number of WooCommerce product queries automatically integrated with ElasticPress. Props @burhandodhy and @felipeelia.
• The number of results per page in Instant Results now matches the site’s posts per page setting. Props @JakePT.
• Under the hood improvements to the structure of Instant Results. Props @JakePT.
• Apply the “Exclude from Search” filter directly on ES Query. Props @burhandodhy.
• Avoid using Elasticsearch if query has an unsupported orderby clause. Props @burhandodhy.
• E2e tests split into 2 groups to be executed in parallel. Props @iamchughmayank, @burhandodhy, and @felipeelia.
• Filter command flags using get_flag_value(). Props @oscarssanchez and @felipeelia.
• Code Standards are now applied to the test suite as well. Props @felipeelia.
• Text displayed when a feature that requires a sync is about to be enabled. Props @felipeelia and @brandwaffle.

Removed:

• Remove legacy filters woocommerce_layered_nav_query_post_ids, woocommerce_unfiltered_product_ids, and ep_wp_query_search_cached_posts. Props @burhandodhy.

Fixed:

• API requests for Instant Results sent on page load before the modal has been opened. Props @JakePT.
• Prevent search queries for coupons from using Elasticsearch. Props @burhandodhy.
• Thumbnails are not removed from indexed …