bookmark_borderGF_Field_FileUpload

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 = GFFormsModel::get_field( $form, 1 );

//get the allowed extensions
$extensions = $field->allowedExtensions;

Settings

The following settings are available for the field:

  • 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. This allows a custom css to be used for the field.

  • description_setting
    Controls whether the “Description” setting appears. This allows a description for the field to be displayed.

  • error_message_setting
    Controls whether the “Custom Validation Message” setting which allows a custom message to be used appears.

  • file_extensions_setting
    Determines whether the “Allowed file extensions” section displays. This section allows the user to enter a comma-delimited list of file extensions which may be uploaded.

  • file_size_setting
    Determines whether the “Maximum File Size” section displays. This section sets the allowed size for each file uploaded.

  • label_setting
    Controls whether the “Field Label” setting which allows the label to be changed appears.

  • multiple_files_setting
    Determines whether the “Enable Multi-File Upload” section displays. This section allows the interface to be changed to allow multiple files to be uploaded, instead of a single upload. This section also includes the ability to set a limit on how many files may be uploaded.

  • rules_setting
    Controls whether the “Rules” settings section displays. The “Required” option shows when this is active.

  • visibility_setting
    Controls whether the “Visibility” setting displays. The controls whether the option of visibility being for “Everyone” or “Admin Only” can be set.

Properties

Below is a listing of the properties inherited from the parent class, and the properties unique to the field.

  • adminLabel string

    The label to be used on admin pages 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 input 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 inputs. If the placement is not specified, then the description placement setting for the Form Layout is used.

  • errorMessage string

    The custom error message to be displayed if the field fails validation.

  • formId integer

    The form ID.

  • id integer

    The field ID.

  • isRequired boolean

    Marking 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 pages.

  • maxFiles string

    When the field is set to allow multiple files to be uploaded, this property is available to set a limit on how many may be uploaded.

  • maxFileSize integer

    The maximum size an uploaded file may be.

  • multipleFiles boolean

    Indicates whether multiple files may be uploaded and changes the interface accordingly.

  • type string

    The field type, which in this case is fileupload.

##Source Code
The source code is located in includes/fields/class-gf-field-fileupload.php in the Gravity Forms folder of your sites plugins directory.