Update readme for v6.17

[Crabcyborg]

No description provided.

[coderabbitai]

Walkthrough

This pull request introduces version 6.17 of the Formidable Forms plugin, focusing on enhancing functionality, performance, and validation. Key updates include new settings for redirect delay in confirmation actions, a UTF-8 with BOM option for CSV exports, and a new database index to improve field query performance. The changes also address validation improvements for email fields, refine HTML tag handling, and deprecate certain global JavaScript functions.

Changes

File	Change Summary
changelog.txt	- Added redirect delay duration and message settings - Introduced UTF-8 with BOM for CSV exports - New database index for field queries - Email field validation improvements - Akismet name value check update - HTML tag handling refinement
readme.txt	- Updated stable tag to 6.17 - Documented new features and fixes - Highlighted performance optimizations - Noted deprecation of frmFrontForm.escapeHtml

Possibly related PRs

• Start working on change log for v6.10 #1753: Changelog updates with similar improvements and deprecations
• Update readme for v6.11 #1810: Readme and changelog updates with validation and performance enhancements
• Add changelog for v6.11.1 #1852: Changelog updates focusing on deprecations and functionality improvements

Suggested labels

run analysis

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

readme.txt (1)

377-378: Performance optimization for field queries

Added a new database index to the fields table and optimized database queries, which should significantly improve performance for field-related operations.

Consider monitoring query performance after this change to ensure the index is being utilized effectively.

changelog.txt (1)

3-4: Performance improvement for field queries

The addition of a database index to the fields table is a significant performance optimization that should improve query speed for field-related operations.

Consider monitoring query performance on large forms to verify the index is being utilized effectively.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8b822e5 and 8a48530.

📒 Files selected for processing (2)

• changelog.txt (1 hunks)
• readme.txt (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Cypress

🔇 Additional comments (6)

readme.txt (5)

374-375: Version 6.17 introduces several important improvements

This release focuses on performance optimizations, security enhancements, and new features for better user experience.

---

375-376: New confirmation action settings improve UX

Added new redirect delay duration and delay message settings for confirmation actions, giving users more control over the post-submission experience.

Also applies to: 376-377

---

378-379: CSV export improvements

Two notable CSV export enhancements:

1. Added UTF-8 with BOM format option for better international character support
2. Optimized database queries for non-Pro CSV exports
3. Added batch size filter for fine-tuning export performance

Also applies to: 379-380

---

380-381: Enhanced email validation

Added additional validation for email fields to prevent incorrect period usage, improving data quality and security.

---

381-384: Bug fixes and improvements

Several important fixes:

1. Updated Akismet name value checking to reduce false positives
2. Improved HTML tag handling for form data input
3. Fixed bottom margin value for centered submit buttons
4. Deprecated global JS function frmFrontForm.escapeHtml

changelog.txt (1)

10-10: Security enhancement for HTML tag handling

The updated HTML tag handling with conditional allowance provides better security while maintaining necessary functionality.

Run this script to check current HTML tag handling:

✅ Verification successful

HTML tag handling implementation verified as secure

The implementation uses WordPress's battle-tested sanitization functions (wp_kses_post and strip_tags) appropriately, with specific handling for edge cases where valid option values might contain HTML-like content.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check HTML tag handling in form data
rg "strip_tags|wp_kses" --type php

Length of output: 6554