function field_update_field

Updates a field.

Any module may forbid any update for any reason. For example, the field's storage module might forbid an update if it would change the storage schema while data for the field exists. A field type module might forbid an update if it would change existing data's semantics, or if there are external dependencies on field settings that cannot be updated.

Parameters

mixed $field: Either the \Drupal\field\Plugin\Core\Entity\Field object to update, or a field array structure. If the latter, $field['field_name'] must provided; it identifies the field that will be updated to match this structure. Any other properties of the field that are not specified in $field will be left unchanged, so it is not necessary to pass in a fully populated $field structure.

Throws

Drupal\field\FieldException

See also

field_create_field()

Related topics

File

drupal/core/modules/field/field.crud.inc, line 93

Field CRUD API, handling field and field instance creation and deletion.

Code

function field_update_field($field) {

  // Module developers can still pass in an array of properties.
  if (is_array($field)) {
    $field_loaded = entity_load('field_entity', $field['field_name']);
    if (empty($field_loaded)) {
      throw new FieldException('Attempt to update a non-existent field.');
    }

    // Merge incoming values.
    foreach ($field as $key => $value) {
      $field_loaded[$key] = $value;
    }
    $field = $field_loaded;
  }
  $field
    ->save();
}