ElasticPress

This is a bug fix release.

Added

• Server type/software detection and warning. Props @felipeelia and @brandwaffle via #2835.
• Coverage of E2E tests for the activate-feature command. Props @burhandodhy via #2802.

Changed

• Sync button title attribute. Props @burhandodhy and @JakePT via #2814.
• npm run build:zip to use git archive. Props @felipeelia via #2822.

Fixed

• Fatal error related to WP-CLI timers on long-running syncs. Props @felipeelia and @przestrzal via #2820.
• Uncaught TypeError on the Settings Page. Props @burhandodhy via #2816.
• Meta values that are not dates converted into date format. Props @burhandodhy, @oscarssanchez, @tott, and @felipeelia via #2828.
• An issue where feature settings could be saved during a sync. Props @JakePT via #2823.
• Admin menu bar items are not clickable when instant results popup modal is activated. Props @MARQAS and @JakePT via #2833.
• Facet block wrongly available in the post editor. Props @oscarssanchez via #2831.
• Show Facet widgets on taxonomy archives. Props @burhandodhy and @felipeelia via #2837.
• Meta queries with 'exists' as compare operator and empty meta values handling. Props @burhandodhy via #2817.
• Sync interruption message always mentioning ElasticPress.io. Props @burhandodhy and @JakePT via #2813.
• An issue where the Related Posts block would display the wrong posts in the preview when added inside a Query Loop block. Props @JakePT via #2825.
• E2e tests for the Facets feature. Props @felipeelia via #2840.
• Intermittent error on GitHub Actions using the latest node 16 version. Props @felipeelia via #2839.

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

ElasticPress 4.2.0 fixes some bugs and introduces some new and exciting changes.

The sync functionality had its JavaScript refactored. Timeouts, memory limits, and general errors are now properly handled and do not make the sync get stuck when performed via the WP-CLI index command. There is also a new get-last-sync WP-CLI command to check the errors and numbers from the last sync.

We've improved the admin search experience for sites using both WooCommerce and Protected Content. Previously, WooCommerce was processing that screen with two different queries, and EP was used only in one of them. Now, it will be only one query, fully handled by ElasticPress. Users wanting to keep the previous behavior can do so by adding add_filter( 'ep_woocommerce_integrate_admin_products_list', '__return_false' ); to their website's codebase.

Facets are now available through a WordPress block. If you are using the Full Site Editing feature, you can now add ElasticPress Facets to your theme with just a few clicks! This block has been introduced with a simplified user interface to enable compatibility with Full Site Editing and will continue to be iterated and improved in future versions of the plugin.

Added

• E2e tests for the Facets feature. Props @felipeelia via #2667.
• $post_args and $post_id to the ep_pc_skip_post_content_cleanup filter. Props @felipeelia and @ecaron via #2728.
• New filter ep_integrate_search_queries. Props @rebeccahum and @felipeelia via #2735.
• New get-last-sync WP-CLI command. Props @felipeelia via #2748.
• Facet block (previously only available as a widget.) Props @felipeelia via #2722.
• New _variations_skus field to WooCommerce products. Props @felipeelia, @kallehauge, and @lukaspawlik via #2763.
• Support for ordering Users by user_registered and lowercase id. Props @felipeelia and @burhandodhy via #2781.
• New filter ep_sync_number_of_errors_stored. Props @felipeelia, @tott and @JakePT via #2789.

Changed

• Facets widgets rendered by a separate class. Props @felipeelia via #2712.
• Deprecated ElasticPress\Feature\Facets\Widget::get_facet_term_html() in favor of ElasticPress\Feature\Facets\Renderer::get_facet_term_html(). Props @felipeelia via #2712.
• Log errors and remove indexing status on failed syncs. Props @felipeelia via #2748.
• Refactored Sync page JavaScript. Props @JakePT via #2738.
• Updated admin scripts to use WordPress's version of React. Props @JakePT via #2756.
• WooCommerce products list in the Dashboard now properly leverages ElasticPress. Props @felipeelia via #2757.
• Removed Instant Results' dependency on @wordpress/components and @wordpress/date. Props @JakePT and @felipeelia via #2774.
• (Protected Content) Password-protected posts are only hidden on searches. Props @felipeelia, @JakePT, and @burhandodhy via #2780.
• The plugin is now available via Composer without any additional steps required. Props @felipeelia, @jeffpaul, and @johnbillion via #2799.

Fixed

• WP-CLI parameters documentation. Props @felipeelia via #2711.
• Full indices removal after e2e tests. Props @felipeelia and @dustinrue via #2710.
• Usage of the $return parameter in Feature\RelatedPosts::find_related(). Props @felipeelia and @altendorfme via #2719.
• Link to API Functions under the Related Posts feature -> Learn more. Props @felipeelia and @burhandodhy via #2729.
• Sync of WooCommerce Orders fields when WooCommerce and Protected Content features are enabled. Props @felipeelia and @ecaron via #2728.
• An issue where selecting no features during install would just cause the install page to reload without any feedback. Props @JakePT and @tlovett1 via #2734.
• An issue where deselecting a feature during install would not stop that feature from being activated. Props @JakePT via #2734.
• Add the missing text domain for the Related Posts block. Props @burhandodhy via #2751.
• Console error when hitting enter on search inputs with autosuggest. Props @burhandodhy, @felipeelia, and @MarijnvSprundel via #2754.
• An issue where attribute selectors could not be used for the Autosuggest Selector. Props @JakePT and @oscarssanchez via #2753.
• "Time elapsed" and "Total time elapsed" in WP-CLI index command. Props @felipeelia and @archon810 via #2762.
• Sync process with skipped objects. Props @juliecampbell and @felipeelia via #2761.
• Typo in the sync page. Props @JakePT and @davidegreenwald via #2767.
• WP-CLI index command without the --network-wide only syncs the main site. Props @felipeelia and @colegeissinger via #2771.
• WP-CLI commands get-mapping, get-indexes, status, and stats only uses all sites' indices name when network activated. Props @felipeelia and @colegeissinger via #2771.
• A bug where URL search parameters could be cleared when using Instant Results. Props @JakePT and @yashumitsu via #2777.
• Undefined index notice in Facets renderer. Props @felipeelia and @burhandodhy via #2779.
• Prevent an unnecessary call when the ES server is not set yet. Props @felipeelia and @burhandodhy via #2782.
• An incompatibility with the way WP 6.0 handles WP_User_Query using fields. Props @felipeelia via #2800.

Security

• Bumped moment from 2.29.1 to 2.29.2. Props @dependabot via #2709.
• Bumped @wordpress/env from 4.4.0 to 4.5.0. Props @felipeelia via #2721.

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

Added

• Utility command to create zip packages: npm run build:zip. Props @felipeelia via #2669.
• E2e tests for the Synonyms feature. Props @felipeelia via #2655.
• generate_mapping() to post and comment indexables. Props @rebeccahum via #2637.
• get_related_query() to the RelatedPosts class. Props @ayebare via #1653.
• New --pretty flag to the WP-CLI commands that output a JSON. Props @felipeelia and @oscarssanchez via #2653.
• Support for an array of aggregations in the aggs parameter of WP_Query. Props @felipeelia and @oscarssanchez via #2682.

Changed

• Refactored remaining admin scripts to remove jQuery as a dependency. Props @JakePT via #2664.
• Generate Instant Results' search template as an anonymous user by default. Props @JakePT via #2672.

Fixed

• PHP warning Trying to access array offset on value of type int in get_index_names(). Props @sun via #2580.
• Searches by WooCommerce Order ID. Props @felipeelia via #2666.
• Display and error message if syncing failed due to invalid JSON response from the server. Props @dsawardekar via #2677.
• Better compatibility with PHP 8.1 by replacing the deprecated FILTER_SANITIZE_STRING. Props @sjinks via #2529.
• get_term_tree() no longer infinite loops when parent ID is non-existent. Props @rebeccahum via #2687.
• User search results include users who do not exist in the current site. Props @tfrommen and @felipeelia via #2670.
• Pagination while syncing Indexables other than Posts. Props @felipeelia and @derringer via #2665.
• Handle the output of an array of messages in sync processes. Props @felipeelia via #2688.
• Truthy values for the 'enabled' field's attribute while using the ep_weighting_configuration_for_search filter. Props @felipeelia and @moritzlang via #2673.
• "Learn More" link on the Sync Page. Props @felipeelia, @JakePT, and @brandwaffle via #2699.
• Icons alignment in the WP Dashboard. Props @jakemgold, @felipeelia, @brandwaffle, and @tlovett1 via #2701.

Security

• Bumped node-forge from 1.2.1 to 1.3.0. Props @dependabot via #2678.
• Bumped @wordpress/env from 4.2.2 to 4.4.0, and minimist from 1.2.5 to 1.2.6. Props @felipeelia via #2680.

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

This is a security release affecting users running ElasticPress 4.0 with both the WooCommerce and Protected Content Features activated. Please update to the latest version of ElasticPress if the WooCommerce and Protected Content features are activated and you're using ElasticPress 4.0.

Security

• Orders belonging to all users loaded in the My Account WooCommerce page. Props @tomburtless and @oscarssanchez via #2658.

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

ElasticPress 4.0 contains some important changes. Make sure to read these highlights before upgrading:

• This version requires a full reindex.
• It introduces a new search algorithm that may change the search results displayed on your site.
• A new feature called "Instant Results" is available. As it requires a full reindex, if you plan to use it, we recommend you enable it first and reindex only once.
• Users upgrading from Beta 1 need to re-save the Instant Results feature settings.
• New minimum versions are:

  	Min	Max
  Elasticsearch	5.2	7.10
  WordPress	5.6+	latest
  PHP	7.0+	latest

Note that ElasticPress 4.0.0 release removes built assets from the develop branch, replaced master with trunk, added a ZIP with the plugin and its built assets in the GitHub Releases page, and included a build script should you want to build assets from a branch. As such, please plan to update any references you have from master to trunk or to GitHub Releases depending on whether you require built assets or not. (See changes in #2622.)

The Facets widget is not currently available within Full Site Editing mode.

This changelog contains all changes made since 3.6.6 (including Beta 1.)

Added

• Instant Results. Props @JakePT, @felipeelia, and Pratheep Chandrasekhar via #2481 and #2500.
• New default search algorithm prioritizing exact matches, matches in the same field, then matches across different fields. Props @brandwaffle and @felipeelia via #2498.
• Filter ep_load_search_weighting to disable search weighting engine. Props @rebeccahum and @felipeelia via #2522.
• Post types to facet labels when needed to to differentiate facets with duplicate labels. Props @JakePT and @felipeelia via #2541.
• Support for search form post type fields to Instant Results. Props @JakePT via #2510.
• Alternative way to count total posts on larger DBs during indexing. Props @rebeccahum and @felipeelia via #2571.
• Do not count posts in get_total_objects_for_query_from_db() if any object limit IDs are passed in. Props @rebeccahum via #2586.
• Show WP-CLI progress on the new Sync page. Props @Rahmon and @felipeelia via #2564.
• Display results counts for facet options in Instant Results. Props @JakePT, @felipeelia via #2563.
• ARIA attributes to Facet widget links to improve accessibility. Props @JakePT via #2607.
• Support for shareable URLs to Instant Results. Props @JakePT and @felipeelia via #2604.
• Dynamic bulk requests limits. Instead of sending only one request per document batch, send several adjusting their sizes based on the Elasticsearch response. Props @felipeelia, @dinhtungdu, @brandwaffle, and @Rahmon via #2585.
• New step in the installation process: users can now select features before the initial sync. Props @felipeelia, @JakePT, Jonathan Netek, and @brandwaffle via #2572.
• Complement to the resync message related to Instant Results. Props @felipeelia and @brandwaffle via #2628.

Changed

• Sync page and code responsible for indexing. Props @helen, @felipeelia, @Rahmon, @mckdemps, @tott, and Pratheep Chandrasekhar via #1835, #2448, and #2501.
• When Protected Content is enabled, ElasticPress will have a more similar behavior to WordPress core but the post content and meta will not be indexed (the new ep_pc_skip_post_content_cleanup can be used to skip that removal.) Props @rebeccahum, @oscarssanchez, @felipeelia, @dinhtungdu, @cristianuibar, and @allan23, @mallorydxw via #2408 and #2646.
• Bump minimum required versions of Elasticsearch from 5.0 to 5.2 and WordPress from 3.7.1 to 5.6. Props @felipeelia via #2475.
• Bump minimum required PHP version from 5.6 to 7.0. Props @felipeelia, @ActuallyConnor, and @brandwaffle via #2485 and #2626.
• Internationalize start and end datetimes of sync. Props @Rahmon and @felipeelia via #2485 and #2548.
• ep_integrate argument in WP_Query to accept 0 and 'false' as valid negative values. Props @oscarssanchez, @Rahmon, and @felipeelia via #2547 and #2573.
• To comply with modern WooCommerce behavior, ElasticPress no longer changes the orderby parameter. Props @felipeelia and @beazuadmin via #2577.
• Query parameters for facets to start with ep_filter, changeable via the new ep_facet_filter_name filter. Props @oscarssanchez, @felipeelia, and @slaxxarn via #2560.
• Output of sync processes using offset to display the number of documents skipped. Props @oscarssanchez, @felipeelia, @cbratschi, and @brandwaffle via #2591.
• Switched from WP Acceptance to Cypress for end to end tests. Props @felipeelia, @Sidsector9, and @dustinrue via #2446 and #2615.
• CSS vars usage in the new Sync page. Props @Rahmon, @JakePT, @mehidi258, and @felipeelia via #2561.
• Features screen: improved accessibility and jQuery dependency removal. Props @JakePT via #2503.
• Taxonomy parameters now reflect the WordPress parsed tax_query value. Props @felipeelia and @sathyapulse via #2419.
• Features order in the Features screen. Props @felipeelia and @brandwaffle via #2618.
• WooCommerce's search parameter also to be used by ElasticPress queries. Props @felipeelia, @dianfishekqi, and @oscarssanchez via #2620.
• Posts are now reindexed when a new term is associated with them and also when an associated term is updated or deleted. Props @nickdaugherty, @felipeelia, @brandon-m-skinner, @mckdemps, @rebeccahum via #2603.
• Updated jsdoc from 3.6.9 to 3.6.10 and fixed the documentation of the ep_thumbnail_image_size filter. Props @felipeelia via #2639.
• Instant Results: type and initial value of search template and move save to the end of sync. Props @felipeelia and @oscarssanchez via #2645.

Removed

• Built assets (minified JavaScript and CSS files) from the repository. Props @felipeelia and @jeffpaul via #2486.
• Duplicate case 'description': from ElasticPress\Indexable\Term\Term::parse_orderby. Props @sjinks via #2533.

Fixed

• CSS issues on Features page. Props @JakePT via #2495.
• AJAX URL on subsites. Props @Rahmon via #2501.
• PHP Notice while monitoring a WP-CLI sync in the dashboard. Props @felipeelia and @ParhamG via #2544.
• Sync page when WooCommerce's "hide out of stock items" and Instant Results are both enabled. Props @felipeelia via #2566.
• PHPUnit Tests and WordPress 5.9 compatibility. Props @felipeelia via #2569.
• WooCommerce Orders Search when searching for an order ID. Props @felipeelia via #2554.
• Code standards. Props @felipeelia via #2574 and #2578.
• Posts insertion and deletion in the same thread. Props @felipeelia and @tcrsavage via #2575.
• Invalid values in tax_query terms resulting in a query failure. Props @rinatkhaziev and @felipeelia via #2576 and #2583.
• New Sync Page to display a message when an indexing is stopped by the WP-CLI stop-indexing command. Props @Rahmon, @felipeelia, and @brandwaffle via #2549.
• Nested queries are no longer deleted. Props @oscarssanchez and @christianc1 via #2567.
• Type hints for epwr_decay and epwr_weight hooks. Props @edwinsiebel via #2537.
• Errors count in the new Sync page. Props @felipeelia via #2590.
• Multisite could index posts from a disabled indexing site. Props @oscarssanchez, @chrisvanpatten, @felipeelia via #2621.
• New sync code and the upper-limit-object-id and lower-limit-object-id parameters in WP-CLI command. Props @felipeelia via #2634.
• Sync link on index health page. Props @JakePT via #2644.
• Logic checking if it is a full sync and if search should go or not through ElasticPress. Props @felipeelia and @JakePT via #2642.

Security

• Use most recent external GitHub Actions versions. Props @felipeelia and @qazaqstan2025 via #2535.
• Updated 10up-toolkit from 1.0.13 to 3.0.1, jsdoc from 3.6.7 to 3.6.9, terser-webpack-plugin from 5.2.4 to 5.3.0, @wordpress/env from 4.1.1 to 4.2.2, and promise-polyfill from 8.2.0 to 8.2.1. Props @felipeelia via #2559, #2611, and #2631.
• Bumped follow-redirects from 1.14.7 to 1.14.9. Props @dependabot via #2609.

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

ElasticPress 4.0 Beta 1 is now available for non-production testing.

Note that the upcoming ElasticPress 4.0.0 release will remove built assets from the develop branch, will replace master with trunk, will add a zip with the plugin and its built assets in the GitHub release page, and will include a build script should you want to build assets from a branch. As such, please plan to update any references you have from master to trunk or to GitHub releases depending on whether you require built assets or not.

Supported versions:

Added

• Ensure array query parameters do not contain empty items. Props @roborourke via #2462.
• WP-CLI request subcommand. Props @joehoyle and @felipeelia via #2484 and #2523.

Changed

• Enabling features that require a reindex will now ask for confirmation. Props @JakePT, @felipeelia, @Rahmon, @columbian-chris, and @brandwaffle via #2491, #2524, and #2536.

Fixed

• Broken search pagination on hierarchical post types. Props @tfrommen via #2511.
• Synonyms erased when syncing via WP-CLI. Props @felipeelia and @oscarssanchez via #2517.
• Deleting a metadata without passing an object id now updates all associated posts. Props @oscarssanchez, @felipeelia, and @Shrimpstronaut via #2483 and #2525.
• Not indexable sites added to indexes list in WP-CLI commands. Props @oscarssanchez and @felipeelia via #2531.

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

This software is still in development, so it is not recommended to run this version on a production site.

This version requires a full reindex.

Please note that 4.0 introduces a new search algorithm that may change the order of results displayed on your site. Additionally, this algorithm may be changed again during the beta process before a final 4.0 release algorithm is determined. Your feedback on this new algorithm is welcome via the Github issues list.

New minimum versions are:

Note that the official ElasticPress 4.0.0 release will replace master with trunk. Built assets were already removed from the branch and added to the zip file attached to the GitHub release page. As such, please plan to update any references you have from master to trunk or to GitHub releases depending on whether you require built assets or not.

Added

• Instant Results. Props @JakePT, @felipeelia, and Pratheep Chandrasekhar via #2481 and #2500.
• New default search algorithm prioritizing exact matches, matches in the same field, then matches across different fields. Props @brandwaffle and @felipeelia via #2498.
• WP-CLI request subcommand. Props @joehoyle and @felipeelia via #2484.

Changed

• Sync Page and code responsible for indexing. Props @helen, @felipeelia, @Rahmon, @mckdemps, @tott, and Pratheep Chandrasekhar via #1835 and #2448.
• When Protected Content is enabled, WordPress behavior for password protected content is correctly reproduced with ElasticPress enabled. Props @rebeccahum, @oscarssanchez, @felipeelia, @dinhtungdu, and @cristianuibar via #2408.
• Enabling features that require a reindex will now ask for confirmation. Props @JakePT, @columbian-chris, and @brandwaffle via #2491.
• Bump minimum required versions of Elasticsearch from 5.0 to 5.2 and WordPress from 3.7.1 to 5.6. Props @felipeelia via #2475.
• Bump minimum required PHP version from 5.6 to 7.0. Props @felipeelia, @ActuallyConnor, and @brandwaffle via #2485.

Removed

• Built assets (minified JavaScript and CSS files) from the repository. Props @felipeelia and @jeffpaul via #2486.

Fixed

• Deleting a metadata without passing an object id now updates all associated posts. Props @oscarssanchez, @felipeelia, and @Shrimpstronaut via #2483.
• CSS issues on Features page. Props @JakePT via #2495.

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

Note that the upcoming ElasticPress 4.0.0 release will remove built assets from the develop branch, will replace master with trunk, will add a zip with the plugin and its built assets in the GitHub release page, and will include a build script should you want to build assets from a branch. As such, please plan to update any references you have from master to trunk or to GitHub releases depending on whether you require built assets or not.

Supported versions:

Added

• Docs: Link to the support page in README.md. Props @brandwaffle via #2436.
• New ep_weighting_default_enabled_taxonomies filter. Props @felipeelia and @tott via #2474.
• $blog_id and $indexable_slug parameters to the ep_keep_index filter. Props @felipeelia and @brandwaffle via #2478.

Changed

• Add $type parameter to ep_do_intercept_request filter. Props @rebeccahum and @felipeelia via #2443.
• Cache the detected Posts mapping version, avoiding get_mapping calls in all admin requests. Props @felipeelia via #2445.
• Docs: Required ES and WP versions planned for ElasticPress 4.0.0. Props @felipeelia via #2442.
• The admin.min.js file was split in notice.min.js and weighting.min.js, being loaded accordingly. Props @felipeelia and @barryceelen via #2476.

Fixed

• Force fetching ep_wpcli_sync_interrupted transient from remote to allow for more reliable remote interruption. Props @rinatkhaziev and @rebeccahum via #2433.
• Duplicate orderby statement in Users query. Props @brettshumaker, @pschoffer, and @rebeccahum via #2435.
• When using offset and default maximum result window value for size, subtract offset from size. Props @rebeccahum via #2441.
• Order for Custom Search Results in autosuggest. Props @felipeelia and @johnwatkins0 via #2447.
• WP-CLI stats and status to output all indices related to ElasticPress. Props @felipeelia via #2479.
• Tests: Ensure that Posts related queries use ElasticPress. Props @Rahmon via #2401.
• Tests: PHPUnit and yoast/phpunit-polyfills. Props @felipeelia via #2457.

Security

• Bumped path-parse from 1.0.6 to 1.0.7. Props @dependabot via #2458.
• Bumped 10up-toolkit from 1.0.12 to 1.0.13. Props @felipeelia via #2467.

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

Note that the upcoming ElasticPress 4.0.0 release will remove built assets from the develop branch, will replace master with trunk, will build a stable release version including built assets into a stable branch, and will include a build script should you want to build assets from a branch. As such, please plan to update any references you have from master to either stable or trunk depending on whether you require built assets or not.

Official PHP support is currently 5.6+. Minimum PHP version for ElasticPress 4.0.0 will be 7.0+.

Added

• WP-CLI: New get-mapping command. Props @tfrommen, @felipeelia, and @Rahmon via #2414.
• New filters: ep_query_request_args and ep_pre_request_args. Props @felipeelia via #2416.
• Support for Autosuggest to dynamically inserted search inputs. Props @JakePT, @rdimascio, @brandwaffle, and @felipeelia via #2404.

Changed

• Automatically generated WP-CLI docs. Props @felipeelia via #2370.
• Verification of active features requirement. Props @Rahmon, @felipeelia, and @WPprodigy via #2410.
• ewp_word_delimiter base filter: changed from word_delimiter to word_delimiter_graph. Props @pschoffer and @yolih via #2409.
• Terms search query in admin will not be fuzzy. Props @rebeccahum via #2417.

Fixed

• Elapsed time beyond 1000 seconds in WP-CLI index command. Props @felipeelia and @dustinrue via #2380.
• Layout of Index Health totals on small displays. Props @JakePT and @oscarssanchez via #2403.
• Deprecated URL for multiple documents get from ElasticSearch. Props @pschoffer via #2397.
• Add new lines and edit terms in the Advanced Synonym Editor. Props @JakePT and @johnwatkins0 via #2411.
• Terms: Avoid falling back to MySQL when results are empty. Props @felipeelia via #2420.
• Terms: Usage of several parameters for searching and ordering. Props @felipeelia and @Rahmon via #2420 and #2421.
• Attachment indexing on Elasticsearch 7. Props @Rahmon via #2425.
• Tests: Ensure that Documents related queries use ElasticPress. Props @Rahmon via #2388.
• Tests: Ensure that WooCommerce related queries use ElasticPress. Props @Rahmon and @felipeelia via #2389.
• Tests: Ensure that Comments related queries use ElasticPress. Props @Rahmon and @felipeelia via #2390.
• Tests: Ensure that Multisite related queries use ElasticPress. Props @Rahmon and @felipeelia via #2400.
• Tests: Ensure that Terms related queries use ElasticPress. Props @felipeelia via #2420.

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

Note that the upcoming ElasticPress 3.7.0 release will remove built assets from the develop branch, will replace master with trunk, will build a stable release version including built assets into a stable branch, and will include a build script should you want to build assets from a branch. As such, please plan to update any references you have from master to either stable or trunk depending on whether you require built assets or not.

Official PHP support is currently 5.6+. Minimum PHP version for ElasticPress 3.7.0 will be 7.0+.

Added

• New ep_facet_widget_term_html and ep_facet_widget_term_label filters to the Facet widget for filtering the HTML and label of individual facet terms. Props @JakePT, @Rahmon, and @felipeelia via #2363.
• New ep_set_sort filter for changing the sort clause of the ES query if orderby is not set in WP_Query. Props @rebeccahum and @felipeelia via #2343 and #2364.
• WP-CLI documentation for some commands and parameters. Props @felipeelia via #2369.

Changed

• In addition to post titles, now autosuggest also partially matches taxonomy terms. Props @felipeelia and @Rahmon via #2347.
• Date parsing change to avoid E_WARNINGs. Props @pschoffer via #2340.

Fixed

• Comments created by anonymous users (but approved by default) are now indexed. Props @tomjn and @Rahmon via #2357.
• Deleted terms are now properly removed from the Elasticsearch index. Props @felipeelia via #2366.
• Children of deleted terms are now properly removed from the Elasticsearch index. Props @pschoffer via #2349.
• Post tag duplicated in the Elasticsearch query. Props @oscarssanchez, @Rahmon, and @felipeelia via #2341.
• Infinite loading state of ElasticPress Related Posts block in the Widgets Edit Screen. Props @felipeelia via #2353.
• Return of Search::integrate_search_queries() when is_integrated_request. Props @adiloztaser via #2355.
• Mapping determination based on existing info. Props @felipeelia via #2345.
• WP_Term_Query and parent = 0. Props @felipeelia and @juansanchezfernandes via #2344.
• WP Acceptance Tests. Props @felipeelia via #2352.
• Typos in the output of some WP-CLI Commands. Props @rebeccahum via #2336.

Security

• Bumped 10up-toolkit from 1.0.11 to 1.0.12, terser-webpack-plugin from 5.1.4 to 5.2.4, @wordpress/api-fetch from 3.21.5 to 3.23.1, and @wordpress/i18n from 3.18.0 to 3.20.0. Props @felipeelia via #2372.

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

Note that the upcoming ElasticPress 3.7.0 release will remove built assets from the develop branch, will replace master with trunk, will build a stable release version including built assets into a stable branch, and will include a build script should you want to build assets from a branch. As such, please plan to update any references you have from master to either stable or trunk depending on whether you require built assets or not.

This version bumps official PHP support from 5.3+ to 5.6+. Minimum PHP version for ElasticPress 3.7.0 will be 7.0+.

Added

• GitHub Action to test compatibility with different PHP versions. Props @felipeelia via #2303.
• Validate mapping currently in index against expected version. Props @tott, @tlovett1, @asharirfan, @oscarssanchez, and @felipeelia via #1472.
• ep_default_analyzer_filters filter to adjust default analyzer filters. Props @pschoffer and @felipeelia via #2282.
• title and aria-labels attributes to each icon hyperlink in the header toolbar. Props @claytoncollie and @felipeelia via #2304.
• Utils\is_integrated_request() function to centralize checks for admin, AJAX, and REST API requests. Props @JakePT, @felipeelia, @brandwaffle, @moritzlang, and @lkraav via #2267.

Changed

• Use 10up-toolkit to build assets. Props @Rahmon, @felipeelia, and @nicholasio via #2279.
• Official PHP supported version bumped to 5.6. Props @felipeelia via #2320.
• Lint React rules using 10up/eslint-config/react. Props @Rahmon via #2306.
• For ES 7.0+ mappings, change edgeNGram to edge_ngram. Props @pschoffer and @rinatkhaziev via #2315.

Removed

• Remove duplicate category_name, cat and tag_id from ES query when tax_query set. Props @rebeccahum and @oscarssanchez via #2241.
• Remove unused path from dynamic_templates. Props @pschoffer via #2315.

Fixed

• Remove data from Elasticsearch on a multisite network when a site is archived, deleted or marked as spam. Props @dustinrue and @felipeelia via #2284.
• stats and status commands in a multisite scenario. Props @Rahmon, @felipeelia, and @dustinrue via #2290.
• Multiple words synonyms. Props @scooterlord, @jonasstrandqvist, and @felipeelia via #2287.
• Category slug used when doing cat Tax Query with ID. Props @oscarssanchez and @karols0 via #2322.
• Restore current blog when the_post triggers outside the loop in multisite environment and the whole network is searched if the first result is from another blog. Props @gonzomir and @felipeelia via #2283.
• Prevents a post from being attempted to delete twice. Props @pauarge via #2314.
• Indexing button on Health screen. Props @Rahmon and @oscarssanchez via #2312.
• WP Acceptance tests and Page Crashed errors. Props @felipeelia and @jeffpaul via #2281 and #2313.
• Facets: Children of selected terms ordered by count. Props @oscarssanchez, @Rahmon, and @felipeelia via #2288.

Security

• Bumps path-parse from 1.0.6 to 1.0.7. Props @dependabot via #2302.

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

Note that the upcoming ElasticPress 3.7.0 release will remove built assets from the develop branch, will replace master with trunk, will build a stable release version including built assets into a stable branch, and will include a build script should you want to build assets from a branch. As such, please plan to update any references you have from master to either stable or trunk depending on whether you require built assets or not.

This version requires a full reindex. The new facet field introduced in 3.6.0 requires a change in the mapping, otherwise, all content sync related to posts will silently fail. If you've upgraded to 3.6.0 and didn't resync your content yet (via Dashboard or with WP-CLI wp elasticpress index --setup) make sure to do so.

Added

• Filter ep_remote_request_add_ep_user_agent. Passing true to that, the ElasticPress version will be added to the User-Agent header in the request. Props @felipeelia via #2264
• Flagged 3.6.0 as version that needs a full reindex. Props @adiloztaser and @felipeelia via #2264

Changed

• Notice when a sync is needed is now an error. Props @felipeelia and @brandwaffle via #2264

Fixed

• Encode the Search Term header before sending it to ElasticPress.io. Props @felipeelia via #2265

See: https://github.com/10up/ElasticPress/pulls?q=is%3Apr+milestone%3A3.6.1+is%3Aclosed+

Note that the upcoming ElasticPress 3.7.0 release will remove built assets from the develop branch, will replace master with trunk, will build a stable release version including built assets into a stable branch, and will include a build script should you want to build assets from a branch. As such, please plan to update any references you have from master to either stable or trunk depending on whether you require built assets or not.

Breaking Changes

• Autosuggest will now respect the [name="post_type"] input in the same form. Before it would bring all post types. Props @mustafauysal and @JakePT via #1689
• Facets Widget presentation, replacing the <input type="checkbox"> elements in option links with a custom .ep-checkbox presentational div. Props @MediaMaquina, @amesplant, @JakePT, and @oscarssanchez via #1886

Added

• Comments Indexable. Props @dkotter, @dinhtungdu, @Rahmon, and @felipeelia via #1531
• "ElasticPress - Comments", a search form for comments. Props @Rahmon and @felipeelia via #2238
• Facets: new ep_facet_allowed_query_args filter. Props @mustafauysal, @JakePT,@Rahmon, and @felipeelia via #1689
• Facets: new ep_facet_use_field filter. Props @moraleida via #2071
• GitHub Action to auto-close non-responsive reporter feedback issues after 3 days. Props @jeffpaul via #2199
• Autosuggest: new ep_autosuggest_default_selectors filter. Props @JakePT and @johnbillion via #2181
• WP-CLI: Index by ID ranges with --upper-limit-object-id and --lower-limit-object-id. Props @WPprodigy, @Rahmon, and @felipeelia via #2171
• Confirmation for destructive WP-CLI commands. Props @nickdaugherty and @Rahmon via #2120
• Elasticsearch::get_documents() and Indexable::multi_get(). Props @nickdaugherty, @felipeelia, and @Rahmon via #2210
• Custom sorting to features on the Features page. Props @Rahmon via #1987
• Terms: add a new facet field to hold the entire term object in json format. Props @moraleida via #2071
• Elasticsearch connection check to Site Health page. Props @spacedmonkey and @Rahmon via #2084
• Support for NOT LIKE operator for meta_query. Props @Thalvik) and @Rahmon via #2157.
• Support for category__not_in and tag__not_in. Props @oscarssanchez and @felipeelia via #2174
• Support for post__name_in. Props @jayhill90 and @oscarssanchez via #2194
• $indexable_slug property to ElasticPress\Indexable\Post\SyncManager. Props @edwinsiebel via #2196
• Permission check bypass for indexing / deleting for cron and WP CLI. Props @nickdaugherty and @felipeelia via #2172
• Check if term exists before a capabilities check is done. Props @msawicki via #2230
• New ep_show_indexing_option_on_multisite filter. Props @johnbillion and @Rahmon via #2156
• Documentation updates related to upcoming changes in 3.7.0. Props @jeffpaul via #2248
• Documentation about how to search using rendered content (shortcodes and reusable blocks). Props @johnbillion and @felipeelia via #2127
• Autosuggest: filter results HTML by defining a window.epAutosuggestItemHTMLFilter() function in JavaScript. Props @JakePT via #2146

Changed

• Autosuggest: JavaScript is not loaded anymore when ElasticPress is indexing. Props @fagiani and @felipeelia via #2163
• Indexable\Post\Post::prepare_date_terms() to only call date_i18n() once. Props @WPprodigy and @Rahmon via #2214

Removed

• Assets source mappings. Props @Rahmon and @MadalinWR via #2162
• References to posts_by_query property and spl_object_hash calls. Props @danielbachhuber and @Rahmon via #2158

Fixed

• GitHub issue templates. Props @jeffpaul via #2145
• Facets: error in filters where terms wouldn't match if the user types a space. Props @felipeelia via #2218
• Facets: pagination parameters in links are now removed when clicking on filters. Props @shmaltz, @oscarssanchez, and @Rahmon via #2229
• Output of WP-CLI index errors. Props @notjustcode-sp and @felipeelia via #2243
• index_name is transformed in lowercase before the index creation in Elasticsearch. Props @teoteo and @felipeelia via #2173
• Validate that a meta_value is a recognizable date value before storing. Props @jschultze, @moraleida and @Rahmon via #1703
• Array with a MIME type without the subtype in post_mime_type argument. Props @ethanclevenger91 and @Rahmon via #2222
• Sort for WP_User_Query. Props @Rahmon via #2226
• WP Acceptance Tests. Props @felipeelia via #2184
• Styling issue of Autosuggest and search block (WP 5.8). Props @dinhtungdu via #2219
• Undefined variable: closed notice in Elasticsearch::update_index_settings(). Props @nickdaugherty and @pschoffer via #2159
• Documentation for WP-CLI *-feature commands. Props @felipeelia via #2164
• Custom Results: a current_user_can() call now receives the post ID instead of the whole object. Props @Sysix via #2255
• Autosuggest: adjust debounce to avoid sending unnecessary requests to the server. Props @Rahmon via #2257

Security

• Updated browserslist and jsdoc versions. Props @felipeelia via #2246
• Updated lodash, hosted-git-info, ssri, rmccue/requests, and y18n versions. Props @dependabot via #2203, #2204, #2179, #2188, and #2153

See: https://github.com/10up/ElasticPress/pulls?q=is%3Apr+milestone%3A3.6.0+is%3Aclosed+

This release fixes some bugs and also adds some new actions and filters.

Security Fix:

• Updated JS dependencies. Props @hats00n and @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

See: https://github.com/10up/ElasticPress/pulls?utf8=%E2%9C%93&q=is%3Apr+milestone%3A3.5.6+is%3Aclosed+

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 Facet Term Search for more than one Widget. Props @goaround
• Fix a Warning that was triggered while using PHP 8. Props @Rahmon
• Fix a wrong phrase in the Indexables documentation. Props @jpowersdev

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_cli_before_clear_index, ep_after_update_feature, and ep_cli_after_clear_index. Props @felipeelia and @Rahmon

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 user to 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

Version 3.5.2 is a bug fix release with minor additions to functionality, largely in the form of new hooks and filters. You can read more about these changes below.

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

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', '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.

Enhancements:

• Remove jQuery from front end JavaScript dependencies.

Bug Fixes:

• Fix accessibility bug on autosuggest.
• Fix broken facet search.