Version 3.6.2

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

Version 3.6.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+

Version 3.6.0

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](https://github.com/10up/ElasticPress/pul...

Version 3.5.6

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+

Version 3.5.5

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

Bug Fixes:

• Fix a problem in autosuggest when highlighting is not active. Props @felipeelia and @Rahmon
• Fix 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

Version 3.5.4

This is primarily a security and bug fix release. PLEASE NOTE that versions 3.5.2 and 3.5.3 contain a vulnerability that allows a 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

[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

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

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.

Version 3.4.3

Enhancements:

• Remove jQuery from front end JavaScript dependencies.

Bug Fixes:

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