gw-list-field-as-choices.php: Added snippet usage examples from gw-list-field-as-choices-usage.php.

[malayladu]

Context

💬 Slack: https://gravitywiz.slack.com/archives/GMP0ZMNSE/p1741960015196679

Summary

Merged usage examples from gw-list-field-as-choices-usage.php to gw-list-field-as-choices.php and delete gw-list-field-as-choices-usage.php

[coderabbitai]

Walkthrough

This pull request removes the separate usage file for the GW_List_Field_As_Choices class and integrates similar usage examples directly into the main class file as commented-out code. The examples demonstrate various configurations (basic usage, alphanumerical sorting, multi-choice field population, custom label/value templates, and a filter for Gravity Flow context) without modifying any existing functionality or public entity declarations.

Changes

File	Summary
gravity-forms/gw-list-field-as-choices-usage.php	Deleted file that contained examples and usage instructions for the GW_List_Field_As_Choices class, including code snippets for sorting choices, populating fields, and customizing values via a filter in a Gravity Flow context.
gravity-forms/gw-list-field-as-choices.php	Added multiple commented-out code examples demonstrating various usage scenarios for the GW_List_Field_As_Choices class. These examples include basic usage, alphanumerical sorting, multi-choice field population, custom label/value templating, and a filter for altering list field values based on Gravity Flow user input.

Suggested reviewers

• saifsultanc

✨ 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

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

[github-actions]

	Warnings
⚠️	When ready, don't forget to request reviews on this pull request from your fellow wizards.

Generated by 🚫 dangerJS against 3b64bd4

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (4)

gravity-forms/gw-list-field-as-choices.php (4)

156-162: Usage Example: Basic Usage – Consistent Commenting Style
The basic usage example is well integrated and clearly demonstrates how to instantiate the class. Consider using a consistent comment style throughout these examples (e.g. using either // or # uniformly) to improve readability.

---

164-171: Usage Example: Enable Sorting of Choices – Clear and Informative
This example illustrates how to enable alphanumerical sorting of choices effectively. The code is self-explanatory; a minor suggestion is to maintain the same commenting style as in other examples for consistency.

---

180-188: Usage Example: Customizing the Choice Label and Value – Verify HTML Safety
This example demonstrates how to customize choice labels and values using templates, which is very useful. When uncommented and used in production, ensure that any HTML included in the templates is properly sanitized to prevent security issues.

---

189-211: Usage Example: Filter Usage – Consistency in Inline Comments
The filter usage example provides advanced guidance on customizing list field values based on Gravity Flow context. It’s clear and detailed; however, consider unifying the inline comment markers (for example, replacing the in-line # with // inside the commented-out code) to maintain consistency throughout the code snippet.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7e1442a and 3b64bd4.

📒 Files selected for processing (2)

• gravity-forms/gw-list-field-as-choices-usage.php (0 hunks)
• gravity-forms/gw-list-field-as-choices.php (1 hunks)

💤 Files with no reviewable changes (1)

• gravity-forms/gw-list-field-as-choices-usage.php

🔇 Additional comments (1)

gravity-forms/gw-list-field-as-choices.php (1)

172-178: Usage Example: Populating Multiple Choice Fields – Accurate Documentation
The snippet for handling multiple choice fields is clear and correctly shows how to pass an array for the choice_field_ids. No further action is needed.