W3cubDocs

/Drupal 8

public function FieldDefinitionInterface::getDefaultValue

public FieldDefinitionInterface::getDefaultValue(FieldableEntityInterface $entity)

Returns the default value for the field in a newly created entity.

This method computes the runtime default value for a field in a given entity. To access the raw properties assigned to the field definition, ::getDefaultValueLiteral() or ::getDefaultValueCallback() should be used instead.

Parameters

\Drupal\Core\Entity\FieldableEntityInterface $entity: The entity for which the default value is generated.

Return value

array The default value for the field, as a numerically indexed array of items, each item being a property/value array (array() for no default value).

See also

FieldDefinitionInterface::getDefaultValueLiteral()

FieldDefinitionInterface::getDefaultValueCallback()

File

core/lib/Drupal/Core/Field/FieldDefinitionInterface.php, line 225

Class

FieldDefinitionInterface
Defines an interface for entity field definitions.

Namespace

Drupal\Core\Field

Code

public function getDefaultValue(FieldableEntityInterface $entity);

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Field!FieldDefinitionInterface.php/function/FieldDefinitionInterface::getDefaultValue/8.1.x