GF_Field_HiddenProduct

Introduction

The GF_Field_HiddenProduct class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Product field is rendered when it is the “Hidden” selection 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 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.

Properties

Below is a listing of the properties inherited from the parent class and ones specific 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.

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

  • 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

    The sub-type of a field. For instance, when the field is a Product field, the “type” is set to product and the “inputType” is set to hiddenproduct. 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.

  • label string

    The field label that will be displayed on the form and on the admin pages.

  • type string

    The field type. The type is set to product. The “inputType” is set to hiddenproduct.

Source Code

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