GF_Field_Hidden
Source: includes/fields/class-gf-field-hidden.php:8
Details
- Kind:
class - Namespace:
(global) - Extends: GF_Field
Properties
| Property | Type | Description |
|---|---|---|
$repeatable | bool | Whether the field can be used in a repeater. |
$_supports_state_validation | bool | Indicates if this field supports state validation. |
Methods
| Method | Description |
|---|---|
get_form_editor_field_description() | Returns the field's form editor description. |
get_form_editor_field_icon() | Returns the field's form editor icon. |
get_field_content() | Returns the field markup. |
get_filter_operators() | Returns the filter operators for the current field. |
get_state_validation_message() | Returns the validation message to be applied when the field has failed state validation. |
Method Reference
get_form_editor_field_description()
public function get_form_editor_field_description()
Returns the field's form editor description.
Returns
string
Since: 2.5
Source: includes/fields/class-gf-field-hidden.php:41
get_form_editor_field_icon()
public function get_form_editor_field_icon()
Returns the field's form editor icon.
This could be an icon url or a gform-icon class.
Returns
string
Since: 2.5
Source: includes/fields/class-gf-field-hidden.php:54
get_field_content()
public function get_field_content( $value, $force_frontend_label, $form )
Returns the field markup.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$value | string | array | The field value. From default/dynamic population, $_POST, or a resumed incomplete submission. | |
$force_frontend_label | bool | Should the frontend label be displayed in the admin even if an admin label is configured. | |
$form | array | The Form Object currently being processed. |
Returns
string
Since:
1.93.0(Using the parent method on validation failure, so the error message will be displayed.)
Source: includes/fields/class-gf-field-hidden.php:105
get_filter_operators()
public function get_filter_operators()
Returns the filter operators for the current field.
Returns
array
Since: 2.4
Source: includes/fields/class-gf-field-hidden.php:135
get_state_validation_message()
public function get_state_validation_message()
Returns the validation message to be applied when the field has failed state validation.
Returns
string
Since: 3.0
Source: includes/fields/class-gf-field-hidden.php:149