Ajax Upload
Upload images to the Media Library as they are uploaded via the Gravity Forms Multi-file Upload field.
Instructions
Code
Filename: gpml-ajax-upload.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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
<?php
/**
* Gravity Perks // Media Library // Ajax Upload
* https://gravitywiz.com/documentation/gravity-forms-media-library/
*
* Instruction Video: https://www.loom.com/share/bed55943a25c44f697530ed79d1d3066
*
* Upload images to the Media Library as they are uploaded via the Gravity Forms Multi-file Upload field.
*
* Plugin Name: GP Media Library - Ajax Upload
* Plugin URI: https://gravitywiz.com/documentation/gravity-forms-media-library/
* Description: Upload images to the Media Library as they are uploaded via the Gravity Forms Multi-file Upload field.
* Author: Gravity Wiz
* Version: 0.16
* Author URI: https://gravitywiz.com/
*/
class GPML_Ajax_Upload {
private $_args = array();
private $form_id;
public function __construct( $args = array() ) {
$this->_args = wp_parse_args( $args, array(
'default_entry_id' => 1,
) );
$this->form_id = rgar( $args, 'form_id' );
add_action( 'init', array( $this, 'init' ), 11 );
}
public function init() {
if ( ! is_callable( 'gp_media_library' ) ) {
return;
}
add_action( 'gform_post_multifile_upload', array( $this, 'upload' ), 10, 5 );
remove_action( 'gform_entry_post_save', array( gp_media_library(), 'maybe_upload_to_media_library' ) );
add_filter( 'gform_entry_post_save', array( $this, 'update_entry_field_values' ), 10, 2 );
// This filter ensures that this snippet is called on Gravity Flow inbox pages which do not
// seem to trigger `gform_entry_post_save` when updating entries.
add_filter( 'gravityflow_next_step', array( $this, 'gpml_gflow_next_step' ), 10, 4 );
// Bypass GF's file URL validation for fields already uploaded and validated during the
// AJAX upload step. GF rejects these URLs because they point to wp-content/uploads/
// instead of GF's expected temp directory.
add_filter( 'gform_field_validation', array( $this, 'bypass_file_validation' ), 10, 4 );
// Retain AJAX-uploaded files when using Save & Continue. GF strips our uploaded files
// from the draft because they include a URL (see GFFormsModel::set_uploaded_files()),
// so we re-inject them into the draft submission before it is saved.
add_filter( 'gform_incomplete_submission_pre_save', array( $this, 'retain_files_in_draft' ), 10, 3 );
// GF 2.10.3+ strips file entries with a 'url' key in set_uploaded_files(), which runs
// during process_form(). Strip our 'url' key from gform_uploaded_files before that
// happens so the temp_filename/uploaded_filename entries survive for validation.
add_filter( 'gform_pre_process', array( $this, 'strip_url_from_gform_uploaded_files' ) );
}
public function is_applicable_form( $form ) {
return empty( $this->form_id ) || (int) rgar( $form, 'id' ) === (int) $this->form_id;
}
public function gpml_gflow_next_step( $step, $current_step, $entry, $steps ) {
$form = GFAPI::get_form( $entry['form_id'] );
if ( ! $this->is_applicable_form( $form ) ) {
return $step;
}
$this->update_entry_field_values( $entry, $form );
return $step;
}
public function upload( $form, $field, $uploaded_filename, $tmp_file_name, $file_path ) {
if ( ! gp_media_library()->is_applicable_field( $field ) || ! $this->is_applicable_form( $form ) ) {
return;
}
$field_uid = implode( '_', array( rgpost( 'gform_unique_id' ), $field->id ) );
$renamed_file_path = str_replace( basename( $file_path ), $uploaded_filename, $file_path );
rename( $file_path, $renamed_file_path );
$id = gp_media_library()->upload_to_media_library( $renamed_file_path, $field, array( 'id' => $this->_args['default_entry_id'] ) );
if ( is_wp_error( $id ) ) {
return;
}
/**
* Fires after a file has been uploaded to the Media Library via AJAX.
*
* @param array $id Array of file IDs.
* @param GF_Field_FileUpload $field The File Upload field object.
*
* @since 0.14
*/
do_action( 'gpmlau_after_upload', $id, $field );
$key = sprintf( 'gpml_ids_%s', $field_uid );
// Get file IDs.
$ids = gform_get_meta( $this->_args['default_entry_id'], $key );
if ( ! is_array( $ids ) ) {
$ids = array();
}
$ids[] = $id[0];
// Update file IDs.
gform_update_meta( $this->_args['default_entry_id'], $key, $ids, $form['id'] );
$output = array(
'status' => 'ok',
'data' => array(
'temp_filename' => $tmp_file_name,
'uploaded_filename' => str_replace( "\\'", "'", urldecode( $uploaded_filename ) ), //Decoding filename to prevent file name mismatch.
'url' => wp_get_attachment_url( $id[0] ),
),
);
$output = json_encode( $output );
die( $output );
}
public function retain_files_in_draft( $submission_json, $resume_token, $form ) {
$submission = json_decode( $submission_json, true );
$unique_id = rgar( $submission, 'gform_unique_id' ) ?: rgpost( 'gform_unique_id' );
if ( ! $this->is_applicable_form( $form ) || ! is_array( $submission ) || empty( $unique_id ) ) {
return $submission_json;
}
foreach ( $form['fields'] as $field ) {
if ( $field->get_input_type() != 'fileupload' || ! $field->multipleFiles || ! gp_media_library()->is_applicable_field( $field ) ) {
continue;
}
$ids = gform_get_meta( $this->_args['default_entry_id'], sprintf( 'gpml_ids_%s_%s', $unique_id, $field->id ) );
if ( empty( $ids ) ) {
continue;
}
$files = array();
$urls = array();
foreach ( $ids as $id ) {
$url = is_wp_error( $id ) ? false : wp_get_attachment_url( $id );
if ( ! $url ) {
continue;
}
$files[] = array(
'uploaded_filename' => wp_basename( $url ),
'id' => 'gpml-' . $id,
);
$urls[] = $url;
}
if ( $files ) {
$submission['files'][ 'input_' . $field->id ] = $files;
$submission['partial_entry'][ $field->id ] = json_encode( $urls );
$submission['submitted_values'][ $field->id ] = $urls;
}
}
return json_encode( $submission );
}
public function strip_url_from_gform_uploaded_files( $form ) {
if ( ! $this->is_applicable_form( $form ) ) {
return $form;
}
$raw = rgpost( 'gform_uploaded_files' );
if ( empty( $raw ) ) {
return $form;
}
$uploaded_files = json_decode( $raw, true );
if ( ! is_array( $uploaded_files ) ) {
return $form;
}
$modified = false;
foreach ( $uploaded_files as &$files ) {
if ( ! is_array( $files ) || ! isset( $files[0] ) || ! is_array( $files[0] ) ) {
continue;
}
foreach ( $files as &$file ) {
if ( isset( $file['url'] ) ) {
unset( $file['url'] );
$modified = true;
}
}
}
unset( $files, $file );
if ( $modified ) {
$_POST['gform_uploaded_files'] = json_encode( $uploaded_files );
}
return $form;
}
public function bypass_file_validation( $result, $value, $form, $field ) {
if ( ! $this->is_applicable_form( $form ) ) {
return $result;
}
if ( $field->get_input_type() !== 'fileupload' || ! $field->multipleFiles ) {
return $result;
}
if ( ! gp_media_library()->is_applicable_field( $field ) ) {
return $result;
}
$field_uid = implode( '_', array( rgpost( 'gform_unique_id' ), $field->id ) );
$ids = gform_get_meta( $this->_args['default_entry_id'], sprintf( 'gpml_ids_%s', $field_uid ) );
if ( ! empty( $ids ) && ! $result['is_valid'] ) {
$result['is_valid'] = true;
$result['message'] = '';
}
return $result;
}
public function update_entry_field_values( $entry, $form ) {
if ( ! $this->is_applicable_form( $form ) ) {
return $entry;
}
foreach ( $form['fields'] as $field ) {
if ( $field->get_input_type() != 'fileupload' || ! $field->multipleFiles ) {
continue;
}
$field_uid = implode( '_', array( rgpost( 'gform_unique_id' ), $field->id ) );
$ids = gform_get_meta( $this->_args['default_entry_id'], sprintf( 'gpml_ids_%s', $field_uid ) );
if ( empty( $ids ) ) {
continue;
}
$new_value = array();
foreach ( $ids as $id ) {
if ( ! is_wp_error( $id ) ) {
$new_value[] = wp_get_attachment_url( $id );
}
}
// Append to current value if present
$current_value = rgar( $entry, $field->id, false );
if ( $current_value ) {
$new_value = array_merge( json_decode( $current_value ), $new_value );
}
$entry[ $field->id ] = json_encode( $new_value );
$entry[ $field->id ] = json_encode( $new_value );
// Save our changes to the DB for this entry.
GFAPI::update_entry_field( $entry['id'], $field->id, $entry[ $field->id ] );
// Delete temporary file ID meta.
gform_delete_meta( $this->_args['default_entry_id'], sprintf( 'gpml_ids_%s', $field_uid ) );
// Save the file ID meta to the actual entry/field.
gp_media_library()->update_file_ids( $entry['id'], $field->id, $ids );
}
return $entry;
}
}
# Configuration
new GPML_Ajax_Upload();
# Apply to a specific Form.
// new GPML_Ajax_Upload( array(
// 'form_id' => 292,
// ) );