gpnf-sort-nested-form-entries.php: Added snippet for sorting nested form entries both on frontend and backend.
#1068
Conversation
… form entries both on frontend and backend.
WalkthroughThis pull request adds a new PHP file that introduces the Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant WP as WordPress
participant SN as GPNF_Sort_Nested_Entries
participant JS as JavaScript Environment
U->>WP: Request Nested Form Page
WP->>SN: Trigger init() during WordPress initialization
SN->>WP: Add filters for template arguments and script loading
WP->>SN: On form render, call load_form_script()
SN->>WP: Execute output_script() to inject JS snippet
JS->>JS: Register filter and sort nested form entries on client side
Possibly related PRs
Suggested reviewers
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
gp-nested-forms/gpnf-sort-nested-form-entries.php (4)
17-30: Consider adding validation for required parameters.The constructor sets default values of
falsefor critical parameters (parent_form_id,nested_field_id, andsort_field_id), but doesn't validate that proper values are provided during instantiation.public function __construct( $args = array() ) { $this->_args = wp_parse_args( $args, array( 'parent_form_id' => false, 'nested_field_id' => false, 'sort_field_id' => false, 'sort_order' => 'asc', ) ); + // Validate required parameters + if ( ! $this->_args['parent_form_id'] || ! $this->_args['nested_field_id'] || ! $this->_args['sort_field_id'] ) { + error_log( 'GPNF_Sort_Nested_Entries: Required parameters missing.' ); + return; + } add_action( 'init', array( $this, 'init' ) ); }
37-59: Improve sorting robustness with type-safe comparison and validation.The sorting function has a few areas that could be improved:
- Add array validation before using usort
- Use strict comparison (
===) instead of loose equality (==)- Consider type conversion for consistent sorting
public function sort_entries_php( $args ) { $field_id = $this->_args['sort_field_id']; $order = strtolower( $this->_args['sort_order'] ); - if ( isset( $args['entries'] ) ) { + if ( isset( $args['entries'] ) && is_array( $args['entries'] ) ) { usort( $args['entries'], function( $a, $b ) use ( $field_id, $order ) { $first = rgar( $a, $field_id ); $second = rgar( $b, $field_id ); - if ( $first == $second ) { + if ( $first === $second ) { return 0; } + // Convert to comparable types if possible + if ( is_numeric( $first ) && is_numeric( $second ) ) { + $first = (float) $first; + $second = (float) $second; + } + if ( $order === 'asc' ) { return ( $first < $second ) ? -1 : 1; } else { return ( $first > $second ) ? -1 : 1; } } ); } return $args; }
70-105: Add browser compatibility enhancements and handle different data types.The JavaScript code uses modern features (template literals with backticks, optional chaining) that might not be supported in older browsers. Also, the sort logic only compares string values, which might not work well for numeric fields.
public function output_script() { $args = array( 'parentFormId' => (int) $this->_args['parent_form_id'], 'nestedFieldId' => (int) $this->_args['nested_field_id'], 'sortFieldId' => (int) $this->_args['sort_field_id'], 'sortOrder' => strtolower( $this->_args['sort_order'] ), ); ?> <script type="text/javascript"> (function($) { var sortFieldId = "<?php echo esc_js( $args['sortFieldId'] ); ?>"; var sortOrder = "<?php echo esc_js( $args['sortOrder'] ); ?>"; window.gform.addFilter('gpnf_sorted_entries', function(entries, formId, fieldId, gpnf) { if (!entries || !entries.length || !entries[0][sortFieldId]) { - console.warn(`GPNF Sort: Field ID ${sortFieldId} not found in entries or entries are empty.`); + console.warn('GPNF Sort: Field ID ' + sortFieldId + ' not found in entries or entries are empty.'); return entries; } return entries.sort(function(a, b) { - let valA = a[sortFieldId]?.label || ''; - let valB = b[sortFieldId]?.label || ''; + var valA = a[sortFieldId] && a[sortFieldId].label ? a[sortFieldId].label : ''; + var valB = b[sortFieldId] && b[sortFieldId].label ? b[sortFieldId].label : ''; + + // Handle numeric values + if (!isNaN(valA) && !isNaN(valB)) { + valA = parseFloat(valA); + valB = parseFloat(valB); + + if (sortOrder === 'desc') { + return valB - valA; + } + return valA - valB; + } + + // Handle string values if (sortOrder === 'desc') { return valB.localeCompare(valA); } return valA.localeCompare(valB); }); }); })(jQuery); </script> <?php }
108-114: Improve example usage with comments.The example instantiation would benefit from additional comments explaining how to adapt the IDs for different implementations.
# Example usage: new GPNF_Sort_Nested_Entries( array( - 'parent_form_id' => 184, - 'nested_field_id' => 1, - 'sort_field_id' => 2, // field on child form to sort by + 'parent_form_id' => 184, // ID of your parent form + 'nested_field_id' => 1, // ID of the Nested Form field in the parent form + 'sort_field_id' => 2, // ID of the field in the child form to sort by 'sort_order' => 'asc', // or 'desc' ) );
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
gp-nested-forms/gpnf-sort-nested-form-entries.php(1 hunks)
🔇 Additional comments (3)
gp-nested-forms/gpnf-sort-nested-form-entries.php (3)
1-16: Well-structured documentation header!The documentation provides clear information about the purpose of the snippet, includes links to resources, and follows proper plugin header format.
32-35: LGTM - Proper hook implementation.The initialization method properly adds filters with specific form and field IDs.
61-68: LGTM - Good use of hook checks to prevent duplicate script loading.The method correctly checks if the current form matches the target parent form and uses a smart approach to prevent multiple script inclusions.
Context
💬 Slack: https://gravitywiz.slack.com/archives/C03T0CNL8AV/p1743626874998309?thread_ts=1743622780.437469&cid=C03T0CNL8AV
Summary
Consolidating snippets-
as mentioned by David and Clay on the thread.
Demo:
https://www.loom.com/share/c9fd421f33dd4925ae2c0139abace5f0