Merge branch 'develop' into trunk

.gitattributes

@@ -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

.github/workflows/build-and-tag.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set PHP version
       uses: shivammathur/setup-php@v2
@@ -22,10 +22,10 @@ jobs:
     - name: composer install
       run: composer install
 
-    - name: install node v18
-      uses: actions/setup-node@v3
+    - name: install node v20
+      uses: actions/setup-node@v4
       with:
-        node-version: 18
+        node-version: 20
 
     - name: Build
       run: |

.github/workflows/build-docs.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         path: 'wp-content/plugins/elasticpress'
 
@@ -54,10 +54,10 @@ jobs:
         wp package install felipeelia/cli-command-docs:dev-trunk
         wp cli-command-docs elasticpress --custom-order=sync,activate-feature,deactivate-feature,list-features,get-algorithm-version,set-algorithm-version --remove=delete_transient_on_int,custom_get_transient,stop_on_failed_mapping,call_ep_cli_put_mapping,should_interrupt_sync,index_output,get-indexes,get-cluster-indexes,index,clear-index,get-indexing-status,get-last-cli-index,stop-indexing --custom-intro='The following WP-CLI commands are supported by ElasticPress:' > wp-content/plugins/elasticpress/docs/wp-cli.md
 
-    - name: Use Node.js 18
-      uses: actions/setup-node@v3
+    - name: Use Node.js 20
+      uses: actions/setup-node@v4
       with:
-        node-version: '18'
+        node-version: '20'
 
     - name: npm ci, and build docs
       run: |
@@ -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'

.github/workflows/build-with-vendor-prefixed.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set PHP version
       uses: shivammathur/setup-php@v2
@@ -24,10 +24,10 @@ jobs:
     - name: composer install
       run: composer install
 
-    - name: install node v18
-      uses: actions/setup-node@v3
+    - name: install node v20
+      uses: actions/setup-node@v4
       with:
-        node-version: 18
+        node-version: 20
 
     - name: Build
       run: |

.github/workflows/cypress-tests.yml

@@ -3,7 +3,7 @@ name: E2E Test
 env:
   COMPOSER_VERSION: "2"
   COMPOSER_CACHE: "${{ github.workspace }}/.composer-cache"
-  NODE_VERSION: "18"
+  NODE_VERSION: "20"
   NODE_CACHE: "${{ github.workspace }}/node_modules_cache"
 
 on:
@@ -33,18 +33,17 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Prepare npm cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ env.NODE_CACHE }}
         key: npm-${{ env.NODE_VERSION }}-${{ hashFiles('**/package-lock.json') }}
         restore-keys: |
           npm-${{ env.NODE_VERSION }}-
-
     - name: Prepare composer cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ env.COMPOSER_CACHE }}
         key: composer-${{ env.COMPOSER_VERSION }}-${{ hashFiles('**/composer.lock') }}
@@ -63,7 +62,7 @@ jobs:
       run: composer install
 
     - name: "Install node v${{ env.NODE_VERSION }}"
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ env.NODE_VERSION }}
 
@@ -89,7 +88,7 @@ jobs:
       uses: actions/upload-artifact@v4
       if: failure()
       with:
-        name: cypress-artifact-${{ matrix.core.name }}-${{ matrix.testGroup }}
+        name: cypress-artifact-${{ matrix.esVersion }}-${{ matrix.core.name }}-${{ matrix.testGroup }}
         retention-days: 2
         path: |
           ${{ github.workspace }}/tests/cypress/screenshots/
@@ -98,7 +97,7 @@ jobs:
 
     - name: Stop Elasticsearch
       if: always()
-      run: cd bin/es-docker/ && docker-compose down
+      run: cd bin/es-docker/ && docker compose down
 
     - name: Test plugin uninstall
       if: always()
@@ -122,18 +121,17 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Prepare npm cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ env.NODE_CACHE }}
         key: npm-${{ env.NODE_VERSION }}-${{ hashFiles('**/package-lock.json') }}
         restore-keys: |
           npm-${{ env.NODE_VERSION }}-
-
     - name: Prepare composer cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ env.COMPOSER_CACHE }}
         key: composer-${{ env.COMPOSER_VERSION }}-${{ hashFiles('**/composer.lock') }}
@@ -152,7 +150,7 @@ jobs:
       run: composer install
 
     - name: "Install node v${{ env.NODE_VERSION }}"
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ env.NODE_VERSION }}
 

.github/workflows/lint.yml

@@ -3,7 +3,7 @@ name: Linting
 env:
   COMPOSER_VERSION: "2"
   COMPOSER_CACHE: "${{ github.workspace }}/.composer-cache"
-  NODE_VERSION: "18"
+  NODE_VERSION: "20"
   NODE_CACHE: "${{ github.workspace }}/node_modules_cache"
 
 on:
@@ -22,22 +22,22 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set standard 10up cache directories
       run: |
         sudo npm config set cache "${{ env.NODE_CACHE }}" --global
 
     - name: Prepare npm cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ env.NODE_CACHE }}
         key: npm-${{ env.NODE_VERSION }}-${{ hashFiles('**/package-lock.json') }}
         restore-keys: |
           npm-${{ env.NODE_VERSION }}-
 
     - name: "install node v${{ env.NODE_VERSION }}"
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ env.NODE_VERSION }}
 
@@ -56,14 +56,14 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set standard 10up cache directories
       run: |
         composer config -g cache-dir "${{ env.COMPOSER_CACHE }}"
 
     - name: Prepare composer cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ env.COMPOSER_CACHE }}
         key: composer-${{ env.COMPOSER_VERSION }}-${{ hashFiles('**/composer.lock') }}
@@ -82,4 +82,4 @@ jobs:
       run: composer install
 
     - name: PHPCS check
-      run: './vendor/bin/phpcs . -q --report=checkstyle --runtime-set testVersion 7.4- | cs2pr'
+      run: './vendor/bin/phpcs . -q --report=checkstyle --warning-severity=6 --runtime-set testVersion 7.4- | cs2pr'

.github/workflows/push-asset-readme-update.yml

@@ -8,7 +8,7 @@ jobs:
     name: Push to trunk
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: WordPress.org plugin asset/readme update
       uses: 10up/action-wordpress-plugin-asset-update@stable
       env:

.github/workflows/push-deploy.yml

@@ -13,10 +13,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout code
-      uses: actions/checkout@v3
+      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:

.github/workflows/test.yml

@@ -30,13 +30,13 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Start MySQL
       run: sudo systemctl start mysql.service
 
     - name: Setup Elasticsearch
-      run: cd bin/es-docker/ && docker-compose build --build-arg ES_VERSION=${{ matrix.esVersion }} && docker-compose up -d
+      run: cd bin/es-docker/ && docker compose build --build-arg ES_VERSION=${{ matrix.esVersion }} && docker compose up -d
 
     - name: Check ES response
       run: curl --connect-timeout 5 --max-time 10 --retry 5 --retry-max-time 40 --retry-all-errors http://127.0.0.1:8890
@@ -46,7 +46,7 @@ jobs:
         composer config -g cache-dir "${{ env.COMPOSER_CACHE }}"
 
     - name: Prepare composer cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ env.COMPOSER_CACHE }}
         key: composer-${{ env.COMPOSER_VERSION }}-${{ hashFiles('**/composer.lock') }}

.github/workflows/wordpress-latest.yml

@@ -15,6 +15,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: WordPress version checker
-        uses: skaut/wordpress-version-checker@v1.2.0
+        uses: skaut/wordpress-version-checker@v2.2.2
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}

.npmrc

@@ -0,0 +1 @@
+engine-strict=true

.nvmrc

@@ -0,0 +1 @@
+v20

.stylelintrc

@@ -11,7 +11,8 @@
       }
     ],
     "font-family-no-missing-generic-family-keyword": null,
-    "declaration-property-unit-allowed-list": null
+    "declaration-property-unit-allowed-list": null,
+    "at-rule-disallowed-list": null
   }
 
 }

.wp-env.json

@@ -13,7 +13,6 @@
         ".",
         "https://downloads.wordpress.org/plugin/classic-widgets.zip",
         "https://downloads.wordpress.org/plugin/debug-bar.zip",
-        "https://downloads.wordpress.org/plugin/debug-bar-elasticpress.zip",
         "https://downloads.wordpress.org/plugin/wordpress-importer.zip",
         "10up/elasticpress-proxy#develop"
       ],

CHANGELOG.md

@@ -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

CREDITS.md

@@ -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).
 

README.md

@@ -37,7 +37,7 @@ Simply downloading the repository files is not enough to have the plugin working
 
 `npm install && npm run build`
 
-[Node.js](https://nodejs.org/en/) (v18) and [npm](https://www.npmjs.com/) (v8) are required.
+[Node.js](https://nodejs.org/en/) (v20) and [npm](https://www.npmjs.com/) (v9) are required.
 
 ## React Components