Helper function to get the default value for a field on an entity.

Parameters

$entity_type: The type of $entity; e.g., 'node' or 'user'.

$entity: The entity for the operation.

$field: The field structure.

$instance: The instance structure.

$langcode: The field language to fill-in with the default value.

Related topics

Field API
Attach custom data fields to Drupal entities.
2 calls to field_get_default_value()
field_default_form in modules/field/field.form.inc
Creates a form element for a field and can populate it with a default value.
field_default_insert in modules/field/field.default.inc
Default field 'insert' operation.

File

modules/field/field.module, line 483
Attach custom data fields to Drupal entities.

Code

function field_get_default_value($entity_type, $entity, $field, $instance, $langcode = NULL) {
  $items = array();
  if (!empty($instance['default_value_function'])) {
    $function = $instance['default_value_function'];
    if (function_exists($function)) {
      $items = $function($entity_type, $entity, $field, $instance, $langcode);
    }
  }
  elseif (!empty($instance['default_value'])) {
    $items = $instance['default_value'];
  }
  return $items;
}