1. 8.5.x core/lib/Drupal/Core/Config/Entity/ConfigEntityBundleBase.php ConfigEntityBundleBase
  2. 8.0.x core/lib/Drupal/Core/Config/Entity/ConfigEntityBundleBase.php ConfigEntityBundleBase
  3. 8.1.x core/lib/Drupal/Core/Config/Entity/ConfigEntityBundleBase.php ConfigEntityBundleBase
  4. 8.2.x core/lib/Drupal/Core/Config/Entity/ConfigEntityBundleBase.php ConfigEntityBundleBase
  5. 8.3.x core/lib/Drupal/Core/Config/Entity/ConfigEntityBundleBase.php ConfigEntityBundleBase
  6. 8.4.x core/lib/Drupal/Core/Config/Entity/ConfigEntityBundleBase.php ConfigEntityBundleBase
  7. 8.6.x core/lib/Drupal/Core/Config/Entity/ConfigEntityBundleBase.php ConfigEntityBundleBase

A base class for config entity types that act as bundles.

Entity types that want to use this base class must use bundle_of in their annotation to specify for which entity type they are providing bundles for.


Expanded class hierarchy of ConfigEntityBundleBase

7 files declare their use of ConfigEntityBundleBase
BlockContentType.php in core/modules/block_content/src/Entity/BlockContentType.php
CommentType.php in core/modules/comment/src/Entity/CommentType.php
ContactForm.php in core/modules/contact/src/Entity/ContactForm.php
EntityTestBundle.php in core/modules/system/tests/modules/entity_test/src/Entity/EntityTestBundle.php
NodeType.php in core/modules/node/src/Entity/NodeType.php

... See full list


core/lib/Drupal/Core/Config/Entity/ConfigEntityBundleBase.php, line 14


View source
abstract class ConfigEntityBundleBase extends ConfigEntityBase {

   * Deletes display if a bundle is deleted.
  protected function deleteDisplays() {

    // Remove entity displays of the deleted bundle.
    if ($displays = $this
      ->loadDisplays('entity_view_display')) {
      $storage = $this

    // Remove entity form displays of the deleted bundle.
    if ($displays = $this
      ->loadDisplays('entity_form_display')) {
      $storage = $this

   * {@inheritdoc}
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);
    $entity_manager = $this
    $bundle_of = $this
    if (!$update) {
        ->id(), $bundle_of);
    else {

      // Invalidate the render cache of entities for which this entity
      // is a bundle.
      if ($entity_manager
        ->hasHandler($bundle_of, 'view_builder')) {

      // Entity bundle field definitions may depend on bundle settings.

   * {@inheritdoc}
  public static function postDelete(EntityStorageInterface $storage, array $entities) {
    parent::postDelete($storage, $entities);
    foreach ($entities as $entity) {
        ->id(), $entity

   * Acts on an entity before the presave hook is invoked.
   * Used before the entity is saved and before invoking the presave hook.
   * Ensure that config entities which are bundles of other entities cannot have
   * their ID changed.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage object.
   * @throws \Drupal\Core\Config\ConfigNameException
   *   Thrown when attempting to rename a bundle entity.
  public function preSave(EntityStorageInterface $storage) {

    // Only handle renames, not creations.
    if (!$this
      ->isNew() && $this
      ->getOriginalId() !== $this
      ->id()) {
      $bundle_type = $this
      $bundle_of = $bundle_type
      if (!empty($bundle_of)) {
        throw new ConfigNameException("The machine name of the '{$bundle_type
          -&gt;<span class="php-function-or-constant function member-of-variable">getLabel</span>()}' bundle cannot be changed.");

   * Returns view or form displays for this bundle.
   * @param string $entity_type_id
   *   The entity type ID of the display type to load.
   * @return \Drupal\Core\Entity\Display\EntityDisplayInterface[]
   *   A list of matching displays.
  protected function loadDisplays($entity_type_id) {
    $ids = \Drupal::entityQuery($entity_type_id)
      ->condition('id', $this
      ->getBundleOf() . '.' . $this
      ->getOriginalId() . '.', 'STARTS_WITH')
    if ($ids) {
      $storage = $this
      return $storage
    return array();



Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
ConfigEntityBase::$isSyncing private property Whether the config is being created, updated or deleted through the import process.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity.
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides Entity::createDuplicate
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides Entity::getCacheTagsToInvalidate
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides Entity::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides Entity::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides Entity::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides Entity::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides Entity::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides Entity::isNew
ConfigEntityBase::isSyncing public function Returns whether this entity is being changed as part of an import process. Overrides ConfigEntityInterface::isSyncing
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides Entity::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides Entity::preDelete
ConfigEntityBase::save public function Saves an entity permanently. Overrides Entity::save
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides Entity::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setSyncing public function Sets the status of the isSyncing flag. Overrides ConfigEntityInterface::setSyncing
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label.
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides Entity::toArray
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides Entity::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides Entity::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides Entity::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides Entity::__construct
ConfigEntityBase::__sleep public function Overrides Entity::__sleep
ConfigEntityBundleBase::deleteDisplays protected function Deletes display if a bundle is deleted.
ConfigEntityBundleBase::loadDisplays protected function Returns view or form displays for this bundle.
ConfigEntityBundleBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides Entity::postDelete
ConfigEntityBundleBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides Entity::postSave
ConfigEntityBundleBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Aliased as: traitSleep
DependencySerializationTrait::__wakeup public function
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
Entity::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
Entity::$entityTypeId protected property The entity type.
Entity::$typedData protected property A typed data object wrapping this entity.
Entity::access public function Checks data value access. Overrides AccessibleInterface::access
Entity::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle
Entity::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
Entity::delete public function Deletes an entity permanently. Overrides EntityInterface::delete
Entity::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
Entity::entityManager Deprecated protected function Gets the entity manager.
Entity::entityTypeManager protected function Gets the entity type manager.
Entity::getCacheContexts public function The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts
Entity::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge
Entity::getCacheTags public function The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags
Entity::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
Entity::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
Entity::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
Entity::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
Entity::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
Entity::id public function Gets the identifier. Overrides EntityInterface::id
Entity::label public function Gets the label of the entity. Overrides EntityInterface::label
Entity::language public function Gets the language of the entity. Overrides EntityInterface::language
Entity::languageManager protected function Gets the language manager.
Entity::linkTemplates protected function Gets an array link templates.
Entity::load public static function Loads an entity. Overrides EntityInterface::load
Entity::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
Entity::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate
Entity::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad
Entity::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate
Entity::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities
Entity::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
Entity::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
Entity::urlRouteParameters protected function Gets an array of placeholders for this entity.
Entity::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid
Entity::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance.
RefinableCacheableDependencyTrait::$cacheContexts protected property Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags protected property Cache tags.
RefinableCacheableDependencyTrait::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency
RefinableCacheableDependencyTrait::addCacheContexts public function Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts
RefinableCacheableDependencyTrait::addCacheTags public function Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge