Skip to content

Allow links in GDPR agreement text#2288

Merged
Crabcyborg merged 1 commit into
masterfrom
allow_links_in_gdpr_agreement_text
Mar 31, 2025
Merged

Allow links in GDPR agreement text#2288
Crabcyborg merged 1 commit into
masterfrom
allow_links_in_gdpr_agreement_text

Conversation

@Crabcyborg
Copy link
Copy Markdown
Contributor

@Crabcyborg Crabcyborg commented Mar 31, 2025

Related ticket https://secure.helpscout.net/conversation/2891604879/226396

It's common to link to Terms and Conditions in a field like our GDPR one.

However, because this was using esc_html, links were not working.

Pre-release
formidable-6.19.1b.zip

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 31, 2025

Walkthrough

The change updates how the agreement text is rendered in the GDPR field. Instead of using esc_html(), the code now calls FrmAppHelper::kses_echo() to output the $agreement_text. This adjustment permits specific HTML tags (such as <a>) in the text while still applying sanitization. The overall control flow of the code remains unchanged.

Changes

File Path Change Summary
classes/.../gdpr-field.php Replaced esc_html() with FrmAppHelper::kses_echo() for the $agreement_text output to allow the inclusion of safe HTML (specifically <a> tags).

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f1cad6c and a09fac7.

📒 Files selected for processing (1)
  • classes/views/frm-fields/front-end/gdpr/gdpr-field.php (1 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
classes/views/frm-fields/front-end/gdpr/gdpr-field.php (1)
classes/helpers/FrmAppHelper.php (2)
  • FrmAppHelper (6-4460)
  • kses_echo (905-907)
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Run PHP Syntax inspection (8.3)
  • GitHub Check: PHP 8 tests in WP trunk
  • GitHub Check: PHP 7.4 tests in WP trunk
  • GitHub Check: Cypress
  • GitHub Check: PHP 8 tests in WP trunk
  • GitHub Check: PHP 7.4 tests in WP trunk
  • GitHub Check: PHP 8 tests in WP trunk
  • GitHub Check: Cypress
  • GitHub Check: PHP 7.4 tests in WP trunk
  • GitHub Check: Run PHP Syntax inspection (8.3)
  • GitHub Check: Cypress
🔇 Additional comments (1)
classes/views/frm-fields/front-end/gdpr/gdpr-field.php (1)

24-24: Good enhancement to allow links in GDPR agreement text!

This change appropriately replaces esc_html() with FrmAppHelper::kses_echo(), enabling the inclusion of hyperlinks in the GDPR agreement text while maintaining security through proper sanitization. The array('a') parameter ensures only anchor tags are allowed, which is perfect for linking to privacy policies or terms of service documents.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

Copy link
Copy Markdown
Contributor

@Liviu-p Liviu-p left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Crabcyborg, it looks good to me. Thanks for handling it!

@Crabcyborg Crabcyborg merged commit 359baae into master Mar 31, 2025
@Crabcyborg Crabcyborg deleted the allow_links_in_gdpr_agreement_text branch March 31, 2025 12:21
@coderabbitai coderabbitai Bot mentioned this pull request Apr 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants