GF_Field_FileUpload

• Introduction
• Settings and Properties
• Settings
• Properties
• Dynamic Population
• Calculations Support
• Conditional Logic Support
• Draft Entry Value
• Saved Entry Value
• Source Code

Introduction

The GF_Field_FileUpload class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the File Upload field is rendered when the form is displayed and how its value is handled during and after form submission.

Settings and Properties

Settings control what options are available to the admin user when configuring the field in the form editor. Gravity Forms includes many built-in settings such as Field Label, Field Description, Choices, Conditional Logic, etc. In addition to built-in settings, custom settings can also be developed. For more information on how to develop custom settings and how to associate settings to a field, visit the GF_Field page.

Properties contain the values specified by the settings and generally are part of the Field Object.

The properties may be retrieved by accessing the Field Object as follows:

// Get the field.
$field = GFAPI::get_field( $form_or_id, $field_id );

// Get the allowed extensions.
$extensions = $field->allowedExtensions;

Settings

Properties

Dynamic Population

Since Gravity Forms 2.9.18, the File Upload field supports dynamic population with a file URL, a comma-separated or JSON encoded list of file URLs, or an array of file URLs.

Note: Only the URL(s) are saved to the entry. The files are not copied to the uploads folder.

Calculations Support

The File Upload field can’t currently be used with calculations.

Conditional Logic Support

Conditional logic rules can’t currently be based on the File Upload field.

Draft Entry Value

Since version 2.8.6, the field value found in the draft entry, returned by GFFormsModel::create_lead() and GFFormsModel::get_current_lead(), contains a JSON encoded array of details about the temporary file(s). Example:

[{"tmp_path":"\/public\/wp-content\/uploads\/gravity_forms\/6-13631115a0dd7370720e7c2979c2f768\/tmp\/65febb4be9e37_input_3.png","tmp_url":"https:\/\/domain.local\/wp-content\/uploads\/gravity_forms\/6-13631115a0dd7370720e7c2979c2f768\/tmp\/65febb4be9e37_input_3.png","tmp_name":"65febb4be9e37_input_3.png","uploaded_name":"screenshot.png"}]

This is the same for both the single file field and the multi-file enabled field. The array for each file contains the following:

To access these file properties, you’ll need to JSON decode the field entry value. Example:

$field_value = rgar( $draft_entry, $field_id );
if ( empty( $field_value ) ) {
	return;
}

$files = json_decode( $field_value, true );
if ( empty( $files ) ) {
	return;
}

This will provide you with an indexed array, which can be accessed like so:

foreach ( $files as $file ) {
	// Do something with the file.
	$tmp_path      = rgar( $file, 'tmp_path' );
	$tmp_url       = rgar( $file, 'tmp_url' );
	$tmp_name      = rgar( $file, 'tmp_name' );
	$uploaded_name = rgar( $file, 'uploaded_name' );
}

They can also be accessed using the file index instead of a foreach. The following example is accessing the first file, which is located at index 0.

$tmp_path      = rgars( $files, '0/tmp_path' );
$tmp_url       = rgars( $files, '0/tmp_url' );
$tmp_name      = rgars( $files, '0/tmp_name' );
$uploaded_name = rgars( $files, '0/uploaded_name' );

If you will be using the URL of the temporary file publicly, you might want to hide the real location of the file by using the field’s get_download_url() method to return a URL using a gf-download query string instead, e.g.

$field    = GFAPI::get_field( $form_or_id, $field_id );
$file_url = $field->get_download_url( $tmp_url, $force_download = false );

Saved Entry Value

The saved entry value depends on how the field is configured. For the default single file configuration, the value is the URL of the uploaded file. For the multi-file configuration, the value is a JSON encoded array of file URLs.

We recommend using the following approach to access the URL(s).

$field_value = rgar( $entry, $field_id );
if ( empty( $field_value ) ) {
	return;
}

$urls = json_decode( $field_value, true );
if ( empty( $urls ) ) {
	$urls = array( $field_value );
}

foreach ( $urls as $url ) {
	// Do something with the $url.
}

Source Code

The source code is located in includes/fields/class-gf-field-fileupload.php in the Gravity Forms folder of your site’s plugins directory.