hook_field_attach_submit

7 field.api.php hook_field_attach_submit($entity_type, $entity, $form, &$form_state)
8 field.api.php hook_field_attach_submit($entity_type, $entity, $form, &$form_state)

Act on field_attach_submit().

This hook is invoked after the field module has performed the operation.

Parameters

$entity_type: The type of $entity; for example, 'node' or 'user'.

$entity: The entity for which an edit form is being submitted. The incoming form values have been extracted as field values of the $entity object.

$form: The form structure where field elements are attached to. This might be a full form structure, or a sub-part of a larger form. The $form['#parents'] property can be used to identify the corresponding part of $form_state['values'].

$form_state: An associative array containing the current state of the form.

Related topics

File

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

Code

<?php
function hook_field_attach_submit($entity_type, $entity, $form, &$form_state) {
  // Sample case of an 'Empty the field' checkbox added on the form, allowing
  // a given field to be emptied.
  $values = drupal_array_get_nested_value($form_state['values'], $form['#parents']);
  if (!empty($values['empty_field_foo'])) {
    unset($entity->field_foo);
  }
}
?>

Comments

Is the example correct?

I think there must be unset($form_state['field_foo']) instead of unset($entity->field_foo).

But the example works.

Login or register to post comments