Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Release] Version 5.1.4 #4037

Merged
merged 15 commits into from
Dec 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -16,6 +16,8 @@
/.eslintrc.js export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.nvmrc export-ignore
/.npmrc export-ignore
/.husky export-ignore
/.lintstagedrc.json export-ignore
/.stylelintrc export-ignore
2 changes: 1 addition & 1 deletion .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -69,7 +69,7 @@ jobs:
CI: true

- name: Deploy to GH Pages
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: './wp-content/plugins/elasticpress/docs-built'
2 changes: 1 addition & 1 deletion .github/workflows/push-deploy.yml
Original file line number Diff line number Diff line change
@@ -16,7 +16,7 @@ jobs:
uses: actions/checkout@v4

- name: WordPress Plugin Deploy
if: "! github.event.release.prerelease"
if: ! github.event.release.prerelease
id: deploy
uses: 10up/action-wordpress-plugin-deploy@stable
env:
50 changes: 50 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -11,8 +11,57 @@ All notable changes to this project will be documented in this file, per [the Ke
### Removed
### Fixed
### Security
### Developer
-->

## [5.1.4] - 2024-12-12

### Added
* New filter `ep_facet_selected_filters`. Props [@burhandodhy](https://github.com/burhandodhy) via [#3953](https://github.com/10up/ElasticPress/pull/3953).
* New filter `ep_disable_query_logging` to disable query logging. Props [@davidsword](https://github.com/davidsword) and [@rebeccahum](https://github.com/rebeccahum) via [#4019](https://github.com/10up/ElasticPress/pull/4019).
* New setting to Protect Content to use WP default order in admin. Props [@felipeelia](https://github.com/felipeelia) and [@realrellek](https://github.com/realrellek) via [#4028](https://github.com/10up/ElasticPress/pull/4028).

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

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

### Security
* Bumped `composer/composer` from 2.7.0 to 2.7.8. Props [@dependabot](https://github.com/dependabot) via [#3972](https://github.com/10up/ElasticPress/pull/3972).
* Bumped `symfony/process` from 6.4.8 to 6.4.14. Props [@dependabot](https://github.com/dependabot) via [#3996](https://github.com/10up/ElasticPress/pull/3996).

### Developer
* Tests use ES 8 by default. Props [@felipeelia](https://github.com/felipeelia) via [#4017](https://github.com/10up/ElasticPress/pull/4017).
* Update E2E tests to work properly with the iframed block editor. Props [@dkotter](https://github.com/dkotter) via [#4029](https://github.com/10up/ElasticPress/pull/4029).
* E2e tests for WP 6.6. Props [@felipeelia](https://github.com/felipeelia) via [#3959](https://github.com/10up/ElasticPress/pull/3959).
* E2e tests for WP 6.7. Props [@felipeelia](https://github.com/felipeelia) via [#4010](https://github.com/10up/ElasticPress/pull/4010).
* Unit Tests: Fail faster on requests we know will fail. Props [@felipeelia](https://github.com/felipeelia) via [#4047](https://github.com/10up/ElasticPress/pull/4047).
* E2e tests: Fix the debug-bar-elasticpress dependency of ElasticPress. Props [@felipeelia](https://github.com/felipeelia) via [#4048](https://github.com/10up/ElasticPress/pull/4048).

## [5.1.3] - 2024-06-11

### Fixed
@@ -2128,6 +2177,7 @@ This is a bug fix release with some filter additions.
- Initial plugin release

[Unreleased]: https://github.com/10up/ElasticPress/compare/trunk...develop
[5.1.4]: https://github.com/10up/ElasticPress/compare/5.1.3...5.1.4
[5.1.3]: https://github.com/10up/ElasticPress/compare/5.1.2...5.1.3
[5.1.2]: https://github.com/10up/ElasticPress/compare/5.1.1...5.1.2
[5.1.1]: https://github.com/10up/ElasticPress/compare/5.1.0...5.1.1
6 changes: 6 additions & 0 deletions CREDITS.md
Original file line number Diff line number Diff line change
@@ -239,6 +239,12 @@ Thank you to all the people who have already contributed to this repository via
[Dharmesh Patel (@iamdharmesh)](https://github.com/iamdharmesh),
[Lucas Grzegorczyk (@furai)](https://github.com/furai),
[Ananda Dhakal (@dhakalananda)](https://github.com/dhakalananda),
[Eduardo Pittol (@edpittol)](https://github.com/edpittol),
[David Sword (@davidsword)](https://github.com/davidsword),
[@realrellek](https://github.com/realrellek),
[Arturo Monge (@arturomonge)](https://github.com/arturomonge),
[Majix (@majiix)](https://github.com/majiix),
[Maarten Hunink (@maartenhunink)](https://github.com/maartenhunink),
and
[@qazaqstan2025](https://github.com/qazaqstan2025).

4 changes: 2 additions & 2 deletions elasticpress.php
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
* Plugin Name: ElasticPress
* Plugin URI: https://github.com/10up/ElasticPress
* Description: A fast and flexible search and query engine for WordPress.
* Version: 5.1.3
* Version: 5.1.4
* Requires at least: 6.0
* Requires PHP: 7.4
* Author: 10up
@@ -33,7 +33,7 @@
define( 'EP_URL', plugin_dir_url( __FILE__ ) );
define( 'EP_PATH', plugin_dir_path( __FILE__ ) );
define( 'EP_FILE', plugin_basename( __FILE__ ) );
define( 'EP_VERSION', '5.1.3' );
define( 'EP_VERSION', '5.1.4' );

define( 'EP_PHP_VERSION_MIN', '7.4' );

248 changes: 133 additions & 115 deletions lang/elasticpress.pot

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions package-lock.json
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "elasticpress",
"version": "5.1.3",
"version": "5.1.4",
"license": "GPL-2.0-or-later",
"description": "A fast and flexible search and query engine for WordPress.",
"dependencies": {
62 changes: 58 additions & 4 deletions readme.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
=== ElasticPress ===
Contributors: 10up, tlovett1, vhauri, tott, felipeelia, oscarssanchez, cmmarslender
Tags: performance, search, elasticsearch, fuzzy, related posts
Tested up to: 6.5
Stable tag: 5.1.3
Tested up to: 6.7
Stable tag: 5.1.4
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

@@ -79,6 +79,60 @@ For sure! Feel free to submit ideas or feedback in general to our [GitHub repo](

== Changelog ==

= 5.1.4 - 2024-12-12 =

__Added:__

* New filter `ep_facet_selected_filters`. Props [@burhandodhy](https://github.com/burhandodhy).
* New filter `ep_disable_query_logging` to disable query logging. Props [@davidsword](https://github.com/davidsword) and [@rebeccahum](https://github.com/rebeccahum).
* New setting to Protect Content to use WP default order in admin. Props [@felipeelia](https://github.com/felipeelia) and [@realrellek](https://github.com/realrellek).

__Changed:__

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

__Fixed:__

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

__Security:__

* Bumped `composer/composer` from 2.7.0 to 2.7.8. Props [@dependabot](https://github.com/dependabot).
* Bumped `symfony/process` from 6.4.8 to 6.4.14. Props [@dependabot](https://github.com/dependabot).

__Developer:__

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


= 5.1.3 - 2024-06-11 =

__Fixed:__
@@ -98,11 +152,11 @@ __Security:__

__Changed:__

* Update Support Article URLs. Props [@felipeelia](https://github.com/felipeelia) via [#3919](https://github.com/10up/ElasticPress/pull/3919).
* Update Support Article URLs. Props [@felipeelia](https://github.com/felipeelia).

__Fixed:__

* Status report page when indexable post types is an empty array. Props [@furai](https://github.com/furai) via [#3910](https://github.com/10up/ElasticPress/pull/3910).
* Status report page when indexable post types is an empty array. Props [@furai](https://github.com/furai).

= 5.1.0 - 2024-04-29 =


Unchanged files with check annotations Beta

* @property {any} [default] Default arg value.
* @property {Array} [allowedValues] Array of allowed values.
*
* @param {Object<string, ArgSchema>} argsSchema Schema to build args from.

Check warning on line 138 in assets/js/api-search/src/utilities.js

GitHub Actions / ES and Style Lint

Use object shorthand or index signatures instead of `Object`, e.g., `{[key: string]: string}`
* @param {string} [paramPrefix] Parameter prefix.
* @returns {Object<string, any>} Query args.

Check warning on line 140 in assets/js/api-search/src/utilities.js

GitHub Actions / ES and Style Lint

Use object shorthand or index signatures instead of `Object`, e.g., `{[key: string]: string}`
*/
export const getArgsFromUrlParams = (argsSchema, paramPrefix = '') => {
const urlParams = new URLSearchParams(window.location.search);
/**
* Build request args from defaults provided in a given schema.
*
* @param {Object<string, ArgSchema>} argsSchema Schema to build args from.

Check warning on line 162 in assets/js/api-search/src/utilities.js

GitHub Actions / ES and Style Lint

Use object shorthand or index signatures instead of `Object`, e.g., `{[key: string]: string}`
* @returns {Object<string, any>} Query args.

Check warning on line 163 in assets/js/api-search/src/utilities.js

GitHub Actions / ES and Style Lint

Use object shorthand or index signatures instead of `Object`, e.g., `{[key: string]: string}`
*/
export const getDefaultArgsFromSchema = (argsSchema) => {
return Object.entries(argsSchema).reduce((args, [arg, schema]) => {