public static function FieldableEntityInterface::baseFieldDefinitions in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Entity/FieldableEntityInterface.php \Drupal\Core\Entity\FieldableEntityInterface::baseFieldDefinitions()
2. 10 core/lib/Drupal/Core/Entity/FieldableEntityInterface.php \Drupal\Core\Entity\FieldableEntityInterface::baseFieldDefinitions()

Provides base field definitions for an entity type.

Implementations typically use the class \Drupal\Core\Field\BaseFieldDefinition for creating the field definitions; for example a 'name' field could be defined as the following:

$fields['name'] = BaseFieldDefinition::create('string')
  ->setLabel(t('Name'));

By definition, base fields are fields that exist for every bundle. To provide definitions for fields that should only exist on some bundles, use \Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions().

The definitions returned by this function can be overridden for all bundles by hook_entity_base_field_info_alter() or overridden on a per-bundle basis via 'base_field_override' configuration entities.

Parameters

\Drupal\Core\Entity\EntityTypeInterface $entity_type: The entity type definition. Useful when a single class is used for multiple, possibly dynamic entity types.

Return value

\Drupal\Core\Field\FieldDefinitionInterface[] An array of base field definitions for the entity type, keyed by field name.

See also

\Drupal\Core\Entity\EntityFieldManagerInterface::getFieldDefinitions()

\Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions()

2 methods override FieldableEntityInterface::baseFieldDefinitions()

ContentEntityBase::baseFieldDefinitions in core/lib/Drupal/Core/Entity/ContentEntityBase.php

Provides base field definitions for an entity type.

EntityTypeManagerTestEntity::baseFieldDefinitions in core/tests/Drupal/Tests/Core/Entity/EntityFieldManagerTest.php

Provides base field definitions for an entity type.

File

core/lib/Drupal/Core/Entity/FieldableEntityInterface.php, line 55

Class

FieldableEntityInterface

Interface for entities having fields.

Namespace

Drupal\Core\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type);