function BaseFieldDefinition::setInitialValueFromField
Same name in other branches
- 9 core/lib/Drupal/Core/Field/BaseFieldDefinition.php \Drupal\Core\Field\BaseFieldDefinition::setInitialValueFromField()
- 8.9.x core/lib/Drupal/Core/Field/BaseFieldDefinition.php \Drupal\Core\Field\BaseFieldDefinition::setInitialValueFromField()
- 11.x core/lib/Drupal/Core/Field/BaseFieldDefinition.php \Drupal\Core\Field\BaseFieldDefinition::setInitialValueFromField()
Sets a field that will be used for getting initial values.
Parameters
string $field_name: The name of the field that will be used for getting initial values.
mixed $default_value: (optional) The default value for the field, in case the inherited value is NULL. This can be either:
- a literal, in which case it will be assigned to the first property of the first item;
- a numerically indexed array of items, each item being a property/value array;
- a non-numerically indexed array, in which case the array is assumed to be a property/value array and used as the first item;
- an empty array for no initial value.
If the field being added is required or an entity key, it is recommended to provide a default value.
Return value
$this
File
-
core/
lib/ Drupal/ Core/ Field/ BaseFieldDefinition.php, line 551
Class
- BaseFieldDefinition
- A class for defining entity fields.
Namespace
Drupal\Core\FieldCode
public function setInitialValueFromField($field_name, $default_value = NULL) {
$this->definition['initial_value_from_field'] = $field_name;
$this->setInitialValue($default_value);
return $this;
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.