Community Documentation

hook_field_validate

7 field.api.php hook_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors)
8 field.api.php hook_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors)

Validate this module's field data.

If there are validation problems, add to the $errors array (passed by reference). There is no return value.

Parameters

$entity_type: The type of $entity.

$entity: The entity for the operation.

$field: The field structure for the operation.

$instance: The instance structure for $field on $entity's bundle.

$langcode: The language associated with $items.

$items: $entity->{$field['field_name']}[$langcode], or an empty array if unset.

$errors: The array of errors (keyed by field name, language code, and delta) that have already been reported for the entity. The function should add its errors to this array. Each error is an associative array with the following keys and values:

  • error: An error code (should be a string prefixed with the module name).
  • message: The human readable message to be displayed.

Related topics

▾ 6 functions implement hook_field_validate()

entity_form_field_validate in includes/common.inc
Helper function for attaching field API validation to entity forms.
field_test_field_validate in modules/field/tests/field_test.field.inc
Implements hook_field_validate().
list_field_validate in modules/field/modules/list/list.module
Implements hook_field_validate().
number_field_validate in modules/field/modules/number/number.module
Implements hook_field_validate().
taxonomy_field_validate in modules/taxonomy/taxonomy.module
Implements hook_field_validate().
text_field_validate in modules/field/modules/text/text.module
Implements hook_field_validate().

File

modules/field/field.api.php, line 400

Code

<?php
function hook_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) {
  foreach ($items as $delta => $item) {
    if (!empty($item['value'])) {
      if (!empty($field['settings']['max_length']) && drupal_strlen($item['value']) > $field['settings']['max_length']) {
        $errors[$field['field_name']][$langcode][$delta][] = array(
          'error' => 'text_max_length', 
          'message' => t('%name: the value may not be longer than %max characters.', array('%name' => $instance['label'], '%max' => $field['settings']['max_length'])),
        );
      }
    }
  }
}
?>

Comments

@see hook_field_widget_error

See http://drupal.org/node/1226110 - you need to implement hook_field_widget_error() to show the messages that you define here for each error to the user.

The field_example.module in the Examples project has more information.

Login or register to post comments