Entity types form#

In the Content entity types form section, click ‘Add Content entity type’. This adds a form section for the entity type.

Enter the machine ID of the entity type. This will automatically fill in the entity type label and class name, but you can change these to something different.

Select as many of the Entity functionality options you want for your entity type:

Fieldable

The entity type can have fields.

Revisionable

The entities can have multiple revisions.

Translatable

The entities can be translated.

Changed

The entities have a timestamp field that stores their last change. The entity class will implement EntityChangedInterface.

Owner

The entities have a field that stores a user reference to their author. The entity class will implement EntityOwnerInterface.

Published

The entities have a status field indicating whether they are published or not. The entity class will implement EntityPublishedInterface.

The ‘Provide UI’ options are a shortcut to set a large number of the entity handler options that follow. You can still set options for entity handlers, and the presets for the ‘Provide UI’ options will merge with your settings.

None

No presets are applied to the entity handler options. Use this option if your entity type does not need a UI, or you know what combination of entity handlers you need.

Default UI

Creates a UI for your entity type which uses the site theme. This will make them work similarly to nodes.

Admin UI

Creates a UI for your entity type which uses the admin theme. This will make them work similarly to most config entity types.

You can define a config bundle entity type for your entity type. This is analogous to the ‘Node type’ config entity type being the bundle entity type for the ‘Node’ content entity type, or the ‘Taxonomy vocabulary’ and ‘Taxonomy term’ entity types. Clicking the ‘Add Bundle config entity type’ will add a form section for this entity type. It will be similar to the form section for config entity types: see below.

There are other ways of defining bundles for your entity type:

• Implement hook_entity_bundle_info() to define the list of bundles in PHP code.
• Use Entity module’s helpers for defining an entity type’s bundles automatically from a plugin type.

You can add base fields for your entity type. Note that the ‘Entity functionality options’ above will automatically add the relevant base fields such as ‘owner’, ‘changed’, and so on.

To add base fields:

1. Click ‘Add base fields item’. This adds a table row to the base fields table form element.
2. Enter the field machine name.
3. The field label will fill automatically.
4. Select the field type.
5. You can add as many base fields as you like.

Specify which entity handlers your entity type uses. Entity handlers are classes which control a particular area of functionality for an entity type.

• For most handler types, the options are:

  • Don’t specify a handler class for this handler type at all. The entity type will not provide the functionality for this handler type.

  • Use the generic class from Drupal core for this handler type.

  • Create a custom handler class for this entity type. This allows your entity type to have custom functionality.

    

• There are some handler types that all entity types have: Drupal Entity API will use a generic handler class if none is specified. In this case, the only option is whether to add a custom handler class or not.