GF_Field_SingleProduct

Introduction

The GF_Field_SingleProduct class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Single Product field is rendered when the form is displayed and how its value is handled during and after form submission. Because this is a product field, the “type” property will be set to “product” and the “inputType” property to “singleproduct”.

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 admin label
$admin_label = $field->adminLabel;

Settings

The following settings are available for the field:

  • base_price_setting
    Determines whether the “Price” section displays. This allows a base price to be specified for the product.

  • conditional_logic_field_setting
    Controls whether the “Enable Conditional Logic” setting appears.

  • disable_quantity_setting
    Determines whether the “Disable quantity field” checkbox appears. This allows the quantity to be removed from the field. A default value of 1 will be used, unless a separate Quantity field is added.

  • duplicate_setting
    Controls whether the “No Duplicates” setting displays within the “Rules” section. This controls whether the same value may exist more than once in the database. The “Rules” setting must be active for this to display.

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

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

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

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.

  • allowsPrepopulate boolean

    Determines if the field values can be dynamically populated. Default is false.

  • basePrice string

    The price of the product. The value includes the formatting characters.

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

  • disableQuantity boolean

    Indicates whether the Quantity field is active.

  • errorMessage string

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

  • formId integer

    The form ID.

  • id integer

    The field ID.

  • inputs array

    An array containing the the individual properties for each element of the single product field.

    • id integer

      The id of the input field.

    • label string

      The label for the input.

    • name string

      The name of the parameter used for the input when dynamically populating the field.

    An example of the array output is as follows:

    $inputs = array(
            array(
              'id'    => '1.1',
              'label' => 'Product Name',
              'name'  => 'param_product'
            ),
            array(
              'id'    => '1.2',
              'label' => 'Price',
              'name'  => 'param_price'
            ),
            array(
              'id'    => '1.3',
              'label' => 'Quantity',
              'name'  => 'param_qty'
            ),
          )

  • inputType string

    Specifies the type of Product field being used. For instance, when the field is for a product, the “type” is set to product and the “inputType” is set to singleproduct. When the field is created, the type is initially set using the “type” property. If “inputType” is not empty, then the “inputType” is used to create the field instead.

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

  • noDuplicates boolean

    Determines if the value entered by the user may already exist in the database.

  • type string

    The field type, which in this case is product. The specific type of product field is in the “inputType” property.

Source Code

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