public static function BlockContent::baseFieldDefinitions in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/block_content/src/Entity/BlockContent.php \Drupal\block_content\Entity\BlockContent::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 EditorialContentEntityBase::baseFieldDefinitions

See also

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

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

File

core/modules/block_content/src/Entity/BlockContent.php, line 178

Class

BlockContent

Defines the custom block entity class.

Namespace

Drupal\block_content\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {

  /** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['id']
    ->setLabel(t('Custom block ID'))
    ->setDescription(t('The custom block ID.'));
  $fields['uuid']
    ->setDescription(t('The custom block UUID.'));
  $fields['revision_id']
    ->setDescription(t('The revision ID.'));
  $fields['langcode']
    ->setDescription(t('The custom block language code.'));
  $fields['type']
    ->setLabel(t('Block type'))
    ->setDescription(t('The block type.'));
  $fields['revision_log']
    ->setDescription(t('The log entry explaining the changes in this revision.'));
  $fields['info'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Block description'))
    ->setDescription(t('A brief description of your block.'))
    ->setRevisionable(TRUE)
    ->setTranslatable(TRUE)
    ->setRequired(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => -5,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->addConstraint('UniqueField', []);
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time that the custom block was last edited.'))
    ->setTranslatable(TRUE)
    ->setRevisionable(TRUE);
  $fields['reusable'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Reusable'))
    ->setDescription(t('A boolean indicating whether this block is reusable.'))
    ->setTranslatable(FALSE)
    ->setRevisionable(FALSE)
    ->setDefaultValue(TRUE);
  return $fields;
}