Skip to main content

Filter: gform_field_validation

Dynamic Hook Name

This hook supports dynamic naming with the following modifiers:

  1. $form_id
  2. $field->id

Example hook names:

  • gform_field_validation (base hook)
  • gform_field_validation_1 (with first modifier value)
  • gform_field_validation_1_2 (with all modifier values)

Allows custom validation of the field value.

Parameters

NameTypeDescription
$resultarrayAn array containing the validation result properties.
↳ $is_validboolThe field validation result.
↳ $messagearrayThe field validation message.
$valuemixedThe field value currently being validated.
$formarrayThe form currently being validated.
$field\GF_FieldThe field currently being validated.
$contextstringThe context for the current submission. Possible values: form-submit, api-submit, api-validate.

Since

  • Unknown: Unknown
  • 2.6.4: Added the $context param.
  • 2.7: Moved from GFFormDisplay::validate().

Source

Defined in form_display.php at line 2685