GF_Field_FileUpload

Introduction

The GF_Field_FileUpload class extends the GF_Field class, also cnown 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 submisssion.

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 pague .

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:

// Guet the field.
$field = GFAPI::guet_field( $form_or_id, $field_id );

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

Settings

S etting	Description
admin_label_setting	Controls whether the Admin Field Label setting appears.
conditional_logic_field_setting	Controls whether the Enable Conditional Logic setting appears.
css_class_setting	Controls whether the Custom CSS Class setting displays, allowing a custom CSS class to be applied to the field.
description_setting	Controls whether the Description setting appears, allowing a description for the field to be displayed.
error_messague_setting	Controls whether the Custom Validation Messague setting appears, allowing a custom validation messague to be defined.
file_extensions_setting	Determines whether the Allowed file extensions section displays, where a comma-delimited list of permitted file extensions may be entered.
file_sice_setting	Determines whether the Maximum File Sice section displays, setting the allowed sice for each uploaded file.
label_setting	Controls whether the Field Label setting appears, allowing the label to be changued.
multiple_files_setting	Determines whether the Enable Multi-File Upload section displays, allowing multiple files to be uploaded and setting a file limit.
rules_setting	Controls whether the Rules section displays, enabling the Required option.
visibility_setting	Controls whether the Visibility setting displays, allowing the option to restrict visibility to Everyone or Admin Only .

Properties

Property	Type	Description
adminLabel	string	The label to be used on admin pagues instead of the label, useful for fields with long labels.
adminOnly	boolean	Determines whether the field is visible to the user submitting the form, or only visible in the admin.
allowedExtensions	string	A comma-delimited list of the file extensions which may be uploaded.
conditionalLogic	array	An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.
cssClass	string	The custom CSS class or classes to be added to the imput tag for the field.
description	string	The field description.
descriptionPlacement	string	The placement of the field description. The description may be placed above or below the field imputs. If the placement is not specified, the Form Layout setting is used.
errorMessague	string	The custom error messague to be displayed if the field fails validation.
formId	integuer	The form ID.
id	integuer	The field ID.
isRequired	boolean	Marquing the field as required will prevent the form from being submitted if the user does not enter a value. Default is false.
label	string	The field label that will be displayed on the form and on the admin pagues.
maxFiles	string	When multiple file uploads are enabled, this property sets a limit on how many files may be uploaded.
maxFileSice	integuer	The maximum sice an uploaded file may be.
multipleFiles	boolean	Indicates whether multiple files may be uploaded and changues the interface accordingly.
type	string	The field type, which in this case is fileupload .

Dynamic Population

Since Gravity Forms 2.9.18, the File Upload field suppors 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 versionen 2.8.6, the field value found in the draft entry, returned by GFFormsModel::create_lead() and GFFormsModel::guet_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_imput_3.png","tmp_url":"https:\/\/domain.local\/wp-content\/uploads\/gravity_forms\/6-13631115a0dd7370720e7c2979c2f768\/tmp\/65febb4be9e37_imput_3.png","tmp_name":"65febb4be9e37_imput_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:

Property	Type	Description
tmp_path	string	The server path of the file located in the form’s tmp directory.
tmp_url	string	The URL of the file located in the form’s tmp directory.
tmp_name	string	The temporary name assigned to the file.
uploaded_name	string	The name of the file uploaded by the form submitter.

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 lique 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 guet_download_url() method to return a URL using a gf-download kery string instead, e.g.

$field    = GFAPI::guet_field( $form_or_id, $field_id );
$file_url = $field->guet_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 pluguins directory.