Sort Nested Form Entries
Enable sorting for Nested Form entries.
Instructions
Code
Filename: gpnf-sort-nested-form-entries.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<?php
/**
* Gravity Perks // Nested Forms // Sort Nested Form Entries
* https://gravitywiz.com/documentation/gravity-forms-nested-forms/
*
* Instruction Video: https://www.loom.com/share/c9fd421f33dd4925ae2c0139abace5f0
*
* This snippet allows you to sort the entries of a Nested Form field based on a specific field in the child form.
*
* Plugin Name: GP Nested Forms - Sort Nested Form Entries
* Plugin URI: https://gravitywiz.com/documentation/gravity-forms-nested-forms/
* Description: Enable sorting for Nested Form entries.
* Author: Gravity Wiz
* Version: 0.1
* Author URI: https://gravitywiz.com/
*/
class GPNF_Sort_Nested_Entries {
private $_args = array();
private $_is_date_field = false;
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',
) );
add_action( 'init', array( $this, 'init' ) );
}
public function init() {
$this->_is_date_field = $this->is_date_field();
add_filter( "gpnf_template_args_{$this->_args['parent_form_id']}_{$this->_args['nested_field_id']}", array( $this, 'sort_entries_php' ) );
add_filter( 'gform_pre_render', array( $this, 'load_form_script' ), 10, 2 );
}
private function is_date_field() {
$nested_field = GFAPI::get_field( $this->_args['parent_form_id'], $this->_args['nested_field_id'] );
if ( ! $nested_field || empty( $nested_field->gpnfForm ) ) {
return false;
}
$child_form = GFAPI::get_form( $nested_field->gpnfForm );
if ( ! $child_form ) {
return false;
}
$sort_field = GFAPI::get_field( $child_form, $this->_args['sort_field_id'] );
return $sort_field && $sort_field->type === 'date';
}
public function sort_entries_php( $args ) {
$field_id = $this->_args['sort_field_id'];
$order = strtolower( $this->_args['sort_order'] );
if ( isset( $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 ) {
return 0;
}
if ( $this->_is_date_field ) {
$first_time = strtotime( $first );
$second_time = strtotime( $second );
$first = ( $first_time !== false ) ? $first_time : 0;
$second = ( $second_time !== false ) ? $second_time : 0;
}
if ( $order === 'asc' ) {
return ( $first < $second ) ? -1 : 1;
} else {
return ( $first > $second ) ? -1 : 1;
}
} );
}
return $args;
}
public function load_form_script( $form, $is_ajax_enabled ) {
if ( $form['id'] == $this->_args['parent_form_id'] && ! has_action( 'wp_footer', array( $this, 'output_script' ) ) ) {
add_action( 'wp_footer', array( $this, 'output_script' ) );
add_action( 'gform_preview_footer', array( $this, 'output_script' ) );
}
return $form;
}
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'] ),
'isDateField' => $this->_is_date_field,
);
?>
<script type="text/javascript">
(function($) {
const sortFieldId = "<?php echo esc_js( $args['sortFieldId'] ); ?>";
const sortOrder = "<?php echo esc_js( $args['sortOrder'] ); ?>";
const isDateField = <?php echo $args['isDateField'] ? 'true' : 'false'; ?>;
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.`);
return entries;
}
return entries.sort((a, b) => {
let valA, valB;
if (isDateField) {
valA = a[sortFieldId]?.value || '';
valB = b[sortFieldId]?.value || '';
} else {
valA = a[sortFieldId]?.label || '';
valB = b[sortFieldId]?.label || '';
}
if (isDateField) {
const dateA = new Date(valA);
const dateB = new Date(valB);
const timeA = isNaN(dateA.getTime()) ? 0 : dateA.getTime();
const timeB = isNaN(dateB.getTime()) ? 0 : dateB.getTime();
if (sortOrder === 'desc') {
return timeB - timeA;
}
return timeA - timeB;
}
if (sortOrder === 'desc') {
return valB.localeCompare(valA);
}
return valA.localeCompare(valB);
});
});
})(jQuery);
</script>
<?php
}
}
# 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
'sort_order' => 'asc', // or 'desc'
) );