Jun 27, 2018: Updated to use
get_upload_dir()method instead ofwp_upload_dir().November 19th, 2016: Fixed typo in method name.
October 24, 2016: Fixed issue with Gravity Forms 2.0.7. Major refactor. Requires Gravity Forms 2.0.7.15 or greater.
December 5, 2015: Added support for Post Image fields.
September 22, 2015: Updated to remove forward and backslashes from new filename.
March 26, 2015: Fixed issue when submitting form with no uploaded files
| <?php | |
| /** | |
| * Gravity Wiz // Gravity Forms // Rename Uploaded Files | |
| * | |
| * Rename uploaded files for Gravity Forms. You can create a static naming template or using merge tags to base names on user input. | |
| * | |
| * Features: | |
| * + supports single and multi-file upload fields | |
| * + flexible naming template with support for static and dynamic values via GF merge tags | |
| * | |
| * Uses: | |
| * + add a prefix or suffix to file uploads | |
| * + include identifying submitted data in the file name like the user's first and last name | |
| * | |
| * @version 2.3 | |
| * @author David Smith <david@gravitywiz.com> | |
| * @license GPL-2.0+ | |
| * @link https://gravitywiz.com/rename-uploaded-files-for-gravity-form/ | |
| */ | |
| class GW_Rename_Uploaded_Files { | |
| public function __construct( $args = array() ) { | |
| // set our default arguments, parse against the provided arguments, and store for use throughout the class | |
| $this->_args = wp_parse_args( $args, array( | |
| 'form_id' => false, | |
| 'field_id' => false, | |
| 'template' => '' | |
| ) ); | |
| // do version check in the init to make sure if GF is going to be loaded, it is already loaded | |
| add_action( 'init', array( $this, 'init' ) ); | |
| } | |
| public function init() { | |
| // make sure we're running the required minimum version of Gravity Forms | |
| if( ! is_callable( array( 'GFFormsModel', 'get_physical_file_path' ) ) ) { | |
| return; | |
| } | |
| add_filter( 'gform_entry_post_save', array( $this, 'rename_uploaded_files' ), 9, 2 ); | |
| add_filter( 'gform_entry_post_save', array( $this, 'stash_uploaded_files' ), 99, 2 ); | |
| add_action( 'gform_after_update_entry', array( $this, 'rename_uploaded_files_after_update' ), 9, 2 ); | |
| add_action( 'gform_after_update_entry', array( $this, 'stash_uploaded_files_after_update' ), 99, 2 ); | |
| } | |
| function rename_uploaded_files( $entry, $form ) { | |
| if( ! $this->is_applicable_form( $form ) ) { | |
| return $entry; | |
| } | |
| foreach( $form['fields'] as &$field ) { | |
| if( ! $this->is_applicable_field( $field ) ) { | |
| continue; | |
| } | |
| $uploaded_files = rgar( $entry, $field->id ); | |
| if( empty( $uploaded_files ) ) { | |
| continue; | |
| } | |
| $uploaded_files = $this->parse_files( $uploaded_files, $field ); | |
| $stashed_files = $this->parse_files( gform_get_meta( $entry['id'], 'gprf_stashed_files' ), $field ); | |
| $renamed_files = array(); | |
| foreach( $uploaded_files as $_file ) { | |
| // Don't rename the same files twice. | |
| if( in_array( $_file, $stashed_files ) ) { | |
| $renamed_files[] = $_file; | |
| continue; | |
| } | |
| $dir = wp_upload_dir(); | |
| $dir = $this->get_upload_dir( $form['id'] ); | |
| $file = str_replace( $dir['url'], $dir['path'], $_file ); | |
| if( ! file_exists( $file ) ) { | |
| continue; | |
| } | |
| $renamed_file = $this->rename_file( $file, $entry ); | |
| if ( ! is_dir( dirname( $renamed_file ) ) ) { | |
| wp_mkdir_p( dirname( $renamed_file ) ); | |
| } | |
| $result = rename( $file, $renamed_file ); | |
| $renamed_files[] = $this->get_url_by_path( $renamed_file, $form['id'] ); | |
| } | |
| // In cases where 3rd party add-ons offload the image to a remote location, no images can be renamed. | |
| if( empty( $renamed_files ) ) { | |
| continue; | |
| } | |
| if( $field->get_input_type() == 'post_image' ) { | |
| $value = str_replace( $uploaded_files[0], $renamed_files[0], rgar( $entry, $field->id ) ); | |
| } else if( $field->multipleFiles ) { | |
| $value = json_encode( $renamed_files ); | |
| } else { | |
| $value = $renamed_files[0]; | |
| } | |
| GFAPI::update_entry_field( $entry['id'], $field->id, $value ); | |
| $entry[ $field->id ] = $value; | |
| } | |
| return $entry; | |
| } | |
| function get_upload_dir( $form_id ) { | |
| $dir = GFFormsModel::get_file_upload_path( $form_id, 'PLACEHOLDER' ); | |
| $dir['path'] = dirname( $dir['path'] ); | |
| $dir['url'] = dirname( $dir['url'] ); | |
| return $dir; | |
| } | |
| function rename_uploaded_files_after_update( $form, $entry_id ) { | |
| $entry = GFAPI::get_entry( $entry_id ); | |
| $this->rename_uploaded_files( $entry, $form ); | |
| } | |
| /** | |
| * Stash the "final" version of the files after other add-ons have had a chance to interact with them. | |
| * | |
| * @param $entry | |
| * @param $form | |
| */ | |
| function stash_uploaded_files( $entry, $form ) { | |
| foreach ( $form['fields'] as &$field ) { | |
| if ( ! $this->is_applicable_field( $field ) ) { | |
| continue; | |
| } | |
| $uploaded_files = rgar( $entry, $field->id ); | |
| gform_update_meta( $entry['id'], 'gprf_stashed_files', $uploaded_files ); | |
| } | |
| return $entry; | |
| } | |
| function stash_uploaded_files_after_update( $form, $entry_id ) { | |
| $entry = GFAPI::get_entry( $entry_id ); | |
| $this->stash_uploaded_files( $entry, $form ); | |
| } | |
| function rename_file( $file, $entry ) { | |
| $new_file = $this->get_template_value( $this->_args['template'], $file, $entry ); | |
| $new_file = $this->increment_file( $new_file ); | |
| return $new_file; | |
| } | |
| function increment_file( $file ) { | |
| $file_path = GFFormsModel::get_physical_file_path( $file ); | |
| $pathinfo = pathinfo( $file_path ); | |
| $counter = 1; | |
| // increment the filename if it already exists (i.e. balloons.jpg, balloons1.jpg, balloons2.jpg) | |
| while ( file_exists( $file_path ) ) { | |
| $file_path = str_replace( ".{$pathinfo['extension']}", "{$counter}.{$pathinfo['extension']}", GFFormsModel::get_physical_file_path( $file ) ); | |
| $counter++; | |
| } | |
| $file = str_replace( basename( $file ), basename( $file_path ), $file ); | |
| return $file; | |
| } | |
| function is_path( $filename ) { | |
| return strpos( $filename, '/' ) !== false; | |
| } | |
| function get_template_value( $template, $file, $entry ) { | |
| $info = pathinfo( $file ); | |
| if( strpos( $template, '/' ) === 0 ) { | |
| $dir = wp_upload_dir(); | |
| $template = $dir['basedir'] . $template; | |
| } else { | |
| $template = $info['dirname'] . '/' . $template; | |
| } | |
| // replace our custom "{filename}" psuedo-merge-tag | |
| $value = str_replace( '{filename}', $info['filename'], $template ); | |
| // replace merge tags | |
| $form = GFAPI::get_form( $entry['form_id'] ); | |
| $value = GFCommon::replace_variables( $value, $form, $entry, false, true, false, 'text' ); | |
| // make sure filename is "clean" | |
| $filename = $this->clean( basename( $value ) ); | |
| $value = str_replace( basename( $value ), $filename, $value ); | |
| // append our file ext | |
| $value .= '.' . $info['extension']; | |
| return $value; | |
| } | |
| function remove_slashes( $value ) { | |
| return stripslashes( str_replace( '/', '', $value ) ); | |
| } | |
| function is_applicable_form( $form ) { | |
| $form_id = isset( $form['id'] ) ? $form['id'] : $form; | |
| return $form_id == $this->_args['form_id']; | |
| } | |
| function is_applicable_field( $field ) { | |
| $is_file_upload_field = in_array( GFFormsModel::get_input_type( $field ), array( 'fileupload', 'post_image' ) ); | |
| $is_applicable_field_id = $this->_args['field_id'] ? $field['id'] == $this->_args['field_id'] : true; | |
| return $is_file_upload_field && $is_applicable_field_id; | |
| } | |
| function clean( $str ) { | |
| return $this->remove_slashes( sanitize_title_with_dashes( strtr( | |
| utf8_decode( $str ), | |
| utf8_decode( 'ŠŒŽšœžŸ¥µÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿ'), | |
| 'SOZsozYYuAAAAAAACEEEEIIIIDNOOOOOOUUUUYsaaaaaaaceeeeiiiionoooooouuuuyy' | |
| ), 'save' ) ); | |
| } | |
| function get_url_by_path( $file, $form_id ) { | |
| $dir = $this->get_upload_dir( $form_id ); | |
| $url = str_replace( $dir['path'], $dir['url'], $file ); | |
| return $url; | |
| } | |
| function parse_files( $files, $field ) { | |
| if( empty( $files ) ) { | |
| return array(); | |
| } | |
| if( $field->get_input_type() == 'post_image' ) { | |
| $file_bits = explode( '|:|', $files ); | |
| $files = array( $file_bits[0] ); | |
| } else if( $field->multipleFiles ) { | |
| $files = json_decode( $files ); | |
| } else { | |
| $files = array( $files ); | |
| } | |
| return $files; | |
| } | |
| } | |
| # Configuration | |
| new GW_Rename_Uploaded_Files( array( | |
| 'form_id' => 628, | |
| 'field_id' => 3, | |
| 'template' => '{Name (First):1.3}-{Name (Last):1.6}-{filename}' // most merge tags are supported, original file extension is preserved | |
| ) ); |
We wrote a snippet that will allow you to create a dynamic naming template for your uploaded Gravity Form files. This includes the ability to prepend, append or generate from scratch custom file names. You can use merge tags to include user input in your new file names.
Here are a couple use cases where this snippet might be useful:
- Include the name of the submitting user either before or after the file name.
- Include an event name in the file name to better categorize which files belong to which events.
For example, given an original file name of mountains.png and a template of {Name (First):1.3}-{Name (Last):1.6}-{filename}, the final image name would be Jordan-Smith-mountains.png
Getting Started
- Check requirements
- Make sure you have Gravity Forms installed and activated.
- Already have a license? Download Latest Gravity Forms
- Need a license? Buy Gravity Forms
- Make sure you have Gravity Forms installed and activated.
- Install the snippet
- Copy and paste the entire snippet into your theme’s functions.php file.
- Configure the snippet
- Once you have installed the snippet, find the snippet configuration section located at the bottom of the snippet code.
- Replace the
form_idwith the ID of your form. - Replace the
field_idwith the field ID of your File Upload field. - Replace the
templatewith your custom file name template.
Usage Examples
First and Last Name
| new GW_Rename_Uploaded_Files( array( | |
| 'form_id' => 628, | |
| 'field_id' => 3, | |
| 'template' => '{Name (First):1.3}-{Name (Last):1.6}-{filename}' // most merge tags are supported, original file extension is preserved | |
| ) ); |
In this example, we are prepending the first and last name from the form to easily identify who submitted the file. Most merge tags are supported using this method and the original file extension is preserved.
Form Title Merge Tag
| new GW_Rename_Uploaded_Files( array( | |
| 'form_id' => 12, | |
| 'field_id' => 18, | |
| 'template' => '{form_title}-{filename}' // most merge tags are supported, original file extension is preserved | |
| ) ); |
In this example, we are prepending the title of the form to the filename to quickly identify which form the file was uploaded to.
Static Text
| new GW_Rename_Uploaded_Files( array( | |
| 'form_id' => 628, | |
| 'field_id' => 5, | |
| 'template' => 'static-file-name' | |
| ) ); |
You can use any text you’d like, just make sure to add the {filename} merge tag somewhere in there.
Parameters
form_id (integer) (required)
Your Form ID. There is no default value.
field_id (integer) (required)
The Field ID of the file upload field. There is no default value.
template (string or merge tag) (required)
This is the template that controls how the file will be rewritten. The value can be either a static string or a merge-tag(s). There is no default value.
You never need to include the file extension in your template. It will automatically be included.
Was this helpful?
We hope you find this snippet useful! If you do, show us some love by sharing this article on the social media platform of your choice. Let’s keep the Gravity Wiz pumping out awesome snippets. Thanks!
Did this resource help you do something awesome with Gravity Forms? Then you'll absolutely love Gravity Perks; a suite of 29+ essential add-ons for Gravity Forms with support you can count on.
Sean P Sullivan says
June 17, 2019 at 8:22 pmI asked this before with no reply, but has anyone noticed that GF 2.4.8 or better breaks this function. I have the latest code installed. The files do upload to proper folder but do not rename. Help!
Adam Reynolds says
May 29, 2019 at 12:24 pmThis is great, but any chance you could extend this functionality so that it applies to any form and/or any form upload fields, so that I can add, say, a timestamp to the end of each file upload, or a random number, etc.?
Thanks, Adam
David Smith says
May 29, 2019 at 12:47 pmHi Adam, try not specifying a “form_id” or “field_id” parameter.
Adam Reynolds says
May 29, 2019 at 3:47 pmNo, unfortunately, that doesn’t work. Execution stops at is_applicable_form (line 54) and returns an uninitialized $entry. Any idea how this could be adapted to apply to all forms and upload fields?
Antoone says
May 30, 2019 at 11:37 amIt might be helpful if we could add the field (admin) label, maybe another path?
Thad Winzenz says
May 31, 2019 at 2:38 pm@Antoone – we’ve needed the admin label (value) for one of our forms as well. We have competitors uploading an .mp3 file to use as part of a performance and need those files renamed to match the division and name of the competitor.
Here’s what works for us to populate the admin value instead of the field label for the ‘Division’ component of the naming.
‘template’ => ‘{Division:2:value}-{Name (First):3.3}-{Name (Last):3.6}’
Essentially, put :value trailing the field reference.
Antoine says
May 24, 2019 at 1:06 pmDavid, please delete all my posts about the confirmation email being sent multiple times (including this one). => This is nowhere related to your snippet.
Appears someone (SWIDH) added admin as CCI and cough-cough admin is … me. As it is CCI, I could only see the user’s email address … and thought the email was sent twice.
Sorry + blush
Antoine says
May 24, 2019 at 12:14 pmFWIW and as a possible track (no guarantee whatsoever) for people using this in conjunction with Gravity VIEW …
Problem is that if you/the user edit a previously registered entry, chances are your file name will be renamed every time you save the form, even if you’ve not changed the (uploaded) file (name). Worse, it will be renamed in the file system but NOT in the entry.
There’s probably a lot of different ways to avoid this but I took this option : If the existing file contains already the chosen “prefix” (I use an url populated field for the prefix, stored in a hidden field #19), just skip it (that’s the higher point I’ve found; where the function decides whether the field is valid or not.
http://snippi.com/s/vy2ale0
There’s probably better/smarter/cleaner way of doing this so … as mentioned before, FWIW !
Michael Cornelius says
April 29, 2019 at 9:29 amHi I was redirected here from GF. My question relates to a file upload from the front end when and used by non-technical staff. I have a member of staff who generates a pdf file containing the latest information, they will then upload to wp, and when the page is next called in wp it uses the latest pdf file. The issue I have is that when GF uploads the file because one already exists by that name a suffix is added to the file being uploaded, which of course means the wp page does not open the new file. GF suggest that this snippit might do the trick. I’m already a GW client using the Populate Anywhere perp. Thanks Michael
David Smith says
April 29, 2019 at 12:55 pmHi Michael, it sounds like what you want to do is overwrite the previously uploaded file with the new file? Is that correct? If so, this snippet will not be much help as it would still append the suffix as to not overwrite the existing file.
Michael Cornelius says
April 29, 2019 at 1:13 pmHi Dave
Yes that is correct. Do you know of such a solution please, I thought it would have been a common need but have carried out a number of googles without success – but being a newbie to WP et al I might be asking the wrong question. Thanks Michael
Antoine says
April 24, 2019 at 1:16 pmThanks, that’s great !
I’m currently hacking this code to run it for any form that have one or more upload fields. Therefore I modified is_applicable_form & is_applicable_field functions : http://snippi.com/s/9w1f0jc (note : with these hacks, form_id and field_id parameters won’t be used anymore) Seems to work as a POC, but maybe you’d like to refine/correct it ?
What I’d like also is to set the template parameter so that the field name is added among – say- last name field and original filename. Can I use a “merge tag” like in parameters array or should I hack later, while in the loop ?
David Smith says
April 24, 2019 at 2:30 pmHi Antoine, first, I’d recommend extending the class rather than modifying it. This way you can overwrite the functions you want and still replace the base class with newer versions as they become available. Here’s an example:
http://snippi.com/s/c7wnilw
I’m not sure I understand what you’re trying to do with the field name and template parameter?
Antoine says
April 24, 2019 at 2:43 pmHi David, thank you for these helpful comments. Still a bit fresh on php/wp but I’ll certainly extend V.S modify the code.
What we might have on a single form is multiple upload fields for different usages, say a personal photo and an ID scan. We’d like to be able to identify each like : [form field name]-{firstname}-{lastname}-{filename}.
Also, I noticed that my hack has a flaw; the form will be submitted (and confirmation sent) as many times as there are upload fields in the form. Sure have to add some controls to prevent this … any idea ?
Antoine says
April 25, 2019 at 9:24 amHI David, as mentioned above, I’m facing a problem I cannot solve by myself. If my form contains more than one fileupload field, everything seems to be ok but the confirmation message is sent as many times than there are fields.
I’ve been trying several combinations, hooking on gform_disable_notification filter with no luck, I’m probably missing something obvious here …
Basically, what I do is : 1. In the parameters array, I’ve added a “field_nb” parameter (defaulted to 0) 2. In the “is_applicable_form” function, while looping into the fields to find (eventually) fileupload file types, I increment this parameter so that we know how many fields should be treated before sending notification. 3. I tried various combinations I’m to shameful to share here (hooking on gform_disable_notification) with no luck … Basically I just wanted to switch notification for this particular entry off by default and reactivate it (in the ‘foreach’ fields loop) only for the last field. I guess I’ve reached my limit here … help very welcome :)
Antoine says
April 25, 2019 at 11:21 amDavid, I’m really sorry for flooding (and my poor English). This will meant more than my words : http://snippi.com/s/darpu4y
State : I can disable notification, can’t enable it back …
Sean P Sullivan says
April 15, 2019 at 11:45 pmGF 2.4.8 breaks this function. I had to roll back to 2.4.6. Anyone else experience this?
Sean
RACHID says
March 23, 2019 at 10:52 amMERCI BIEN; est ce que existe une extension pour ce la?
Zachariah says
March 5, 2019 at 5:18 pmThis is working great. Just one question to see if this is possible. Would it be possible to change the file name AND convert to uppercase in the process? I have a field in GF that I’ve converted to uppercase before saving in the db. This field is also being used to create a query string that gets passed to the form where the file upload and renaming happens. This query string doesn’t use the uppercase value saved in the database but rather whatever the user put in.
Thanks!
David Smith says
March 5, 2019 at 6:13 pmHi Zachariah, your best bet is to modify the clean() method to also uppercase the string.