Same name and namespace in other branches

1. 11.x core/lib/Drupal/Core/Field/BaseFieldDefinition.php \Drupal\Core\Field\BaseFieldDefinition::setDefaultValueCallback()
2. 10 core/lib/Drupal/Core/Field/BaseFieldDefinition.php \Drupal\Core\Field\BaseFieldDefinition::setDefaultValueCallback()
3. 9 core/lib/Drupal/Core/Field/BaseFieldDefinition.php \Drupal\Core\Field\BaseFieldDefinition::setDefaultValueCallback()
4. 8.9.x core/lib/Drupal/Core/Field/BaseFieldDefinition.php \Drupal\Core\Field\BaseFieldDefinition::setDefaultValueCallback()

Sets the default value callback for the field.

If set, the callback overrides any set default value.

Parameters

callable|null $callback: The callback to invoke for getting the default value. The callback will be invoked with the following arguments:

• \Drupal\Core\Entity\FieldableEntityInterface $entity The entity being created.
• \Drupal\Core\Field\FieldDefinitionInterface $definition The field definition.

It should return the default value in the format accepted by the static::setDefaultValue() method.

Pass NULL to unset a callback that was set previously.

Return value

$this

File

core/lib/Drupal/Core/Field/BaseFieldDefinition.php, line 510

Class

BaseFieldDefinition

A class for defining entity fields.

Namespace

Drupal\Core\Field

Code

public function setDefaultValueCallback($callback) {
  if (isset($callback) && !is_string($callback)) {
    throw new \InvalidArgumentException('Default value callback must be a string, like "function_name" or "ClassName::methodName"');
  }
  $this->definition['default_value_callback'] = $callback;
  return $this;
}

---