You are here

public static function EditorialContentEntityBase::baseFieldDefinitions in Drupal 8

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Entity/EditorialContentEntityBase.php \Drupal\Core\Entity\EditorialContentEntityBase::baseFieldDefinitions()
  2. 10 core/lib/Drupal/Core/Entity/EditorialContentEntityBase.php \Drupal\Core\Entity\EditorialContentEntityBase::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.

Overrides ContentEntityBase::baseFieldDefinitions

See also

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

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

5 calls to EditorialContentEntityBase::baseFieldDefinitions()
BlockContent::baseFieldDefinitions in core/modules/block_content/src/Entity/BlockContent.php
Provides base field definitions for an entity type.
Media::baseFieldDefinitions in core/modules/media/src/Entity/Media.php
Provides base field definitions for an entity type.
MenuLinkContent::baseFieldDefinitions in core/modules/menu_link_content/src/Entity/MenuLinkContent.php
Provides base field definitions for an entity type.
Node::baseFieldDefinitions in core/modules/node/src/Entity/Node.php
Provides base field definitions for an entity type.
Term::baseFieldDefinitions in core/modules/taxonomy/src/Entity/Term.php
Provides base field definitions for an entity type.
5 methods override EditorialContentEntityBase::baseFieldDefinitions()
BlockContent::baseFieldDefinitions in core/modules/block_content/src/Entity/BlockContent.php
Provides base field definitions for an entity type.
Media::baseFieldDefinitions in core/modules/media/src/Entity/Media.php
Provides base field definitions for an entity type.
MenuLinkContent::baseFieldDefinitions in core/modules/menu_link_content/src/Entity/MenuLinkContent.php
Provides base field definitions for an entity type.
Node::baseFieldDefinitions in core/modules/node/src/Entity/Node.php
Provides base field definitions for an entity type.
Term::baseFieldDefinitions in core/modules/taxonomy/src/Entity/Term.php
Provides base field definitions for an entity type.

File

core/lib/Drupal/Core/Entity/EditorialContentEntityBase.php, line 19

Class

EditorialContentEntityBase
Provides a base entity class with extended revision and publishing support.

Namespace

Drupal\Core\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);

  // Add the revision metadata fields.
  $fields += static::revisionLogBaseFieldDefinitions($entity_type);

  // Add the published field.
  $fields += static::publishedBaseFieldDefinitions($entity_type);
  return $fields;
}