1. 8.2.x core/modules/taxonomy/src/Plugin/migrate/source/d6/Vocabulary.php Vocabulary
  2. 8.2.x core/modules/taxonomy/src/Entity/Vocabulary.php Vocabulary
  3. 8.2.x core/modules/taxonomy/src/Plugin/migrate/source/d7/Vocabulary.php Vocabulary
  4. 8.0.x core/modules/taxonomy/src/Entity/Vocabulary.php Vocabulary
  5. 8.0.x core/modules/taxonomy/src/Plugin/migrate/source/d6/Vocabulary.php Vocabulary
  6. 8.0.x core/modules/taxonomy/src/Plugin/migrate/source/d7/Vocabulary.php Vocabulary
  7. 8.1.x core/modules/taxonomy/src/Plugin/migrate/source/d7/Vocabulary.php Vocabulary
  8. 8.1.x core/modules/taxonomy/src/Plugin/migrate/source/d6/Vocabulary.php Vocabulary
  9. 8.1.x core/modules/taxonomy/src/Entity/Vocabulary.php Vocabulary
  10. 8.3.x core/modules/taxonomy/src/Plugin/migrate/source/d7/Vocabulary.php Vocabulary
  11. 8.3.x core/modules/taxonomy/src/Entity/Vocabulary.php Vocabulary
  12. 8.3.x core/modules/taxonomy/src/Plugin/migrate/source/d6/Vocabulary.php Vocabulary

Defines the taxonomy vocabulary entity.

Plugin annotation

  id = "taxonomy_vocabulary",
  label = @Translation("Taxonomy vocabulary"),
  handlers = {
    "storage" = "Drupal\taxonomy\VocabularyStorage",
    "list_builder" = "Drupal\taxonomy\VocabularyListBuilder",
    "form" = {
      "default" = "Drupal\taxonomy\VocabularyForm",
      "reset" = "Drupal\taxonomy\Form\VocabularyResetForm",
      "delete" = "Drupal\taxonomy\Form\VocabularyDeleteForm"
  admin_permission = "administer taxonomy",
  config_prefix = "vocabulary",
  bundle_of = "taxonomy_term",
  entity_keys = {
    "id" = "vid",
    "label" = "name",
    "weight" = "weight"
  links = {
    "add-form" = "/admin/structure/taxonomy/manage/{taxonomy_vocabulary}/add",
    "delete-form" = "/admin/structure/taxonomy/manage/{taxonomy_vocabulary}/delete",
    "reset-form" = "/admin/structure/taxonomy/manage/{taxonomy_vocabulary}/reset",
    "overview-form" = "/admin/structure/taxonomy/manage/{taxonomy_vocabulary}/overview",
    "edit-form" = "/admin/structure/taxonomy/manage/{taxonomy_vocabulary}",
    "collection" = "/admin/structure/taxonomy",
  config_export = {


Expanded class hierarchy of Vocabulary

47 files declare their use of Vocabulary
CommentTokenReplaceTest.php in core/modules/comment/src/Tests/CommentTokenReplaceTest.php
ConfigTranslationListUiTest.php in core/modules/config_translation/src/Tests/ConfigTranslationListUiTest.php
DefaultViewsTest.php in core/modules/views/src/Tests/DefaultViewsTest.php
EntityCrudHookTest.php in core/tests/Drupal/KernelTests/Core/Entity/EntityCrudHookTest.php
EntityQueryRelationshipTest.php in core/tests/Drupal/KernelTests/Core/Entity/EntityQueryRelationshipTest.php

... See full list

4 string references to 'Vocabulary'
taxonomy.schema.yml in core/modules/taxonomy/config/schema/taxonomy.schema.yml
taxonomy.views.schema.yml in core/modules/taxonomy/config/schema/taxonomy.views.schema.yml
TaxonomyIndexTid::buildExtraOptionsForm in core/modules/taxonomy/src/Plugin/views/filter/TaxonomyIndexTid.php
Provide a form for setting options.
Term::baseFieldDefinitions in core/modules/taxonomy/src/Entity/Term.php
Provides base field definitions for an entity type.


core/modules/taxonomy/src/Entity/Vocabulary.php, line 49


View source
class Vocabulary extends ConfigEntityBundleBase implements VocabularyInterface {

   * The taxonomy vocabulary ID.
   * @var string
  protected $vid;

   * Name of the vocabulary.
   * @var string
  protected $name;

   * Description of the vocabulary.
   * @var string
  protected $description;

   * The type of hierarchy allowed within the vocabulary.
   * Possible values:
   * - VocabularyInterface::HIERARCHY_DISABLED: No parents.
   * - VocabularyInterface::HIERARCHY_SINGLE: Single parent.
   * - VocabularyInterface::HIERARCHY_MULTIPL: Multiple parents.
   * @var int
  protected $hierarchy = VocabularyInterface::HIERARCHY_DISABLED;

   * The weight of this vocabulary in relation to other vocabularies.
   * @var int
  protected $weight = 0;

   * {@inheritdoc}
  public function getHierarchy() {
    return $this->hierarchy;

   * {@inheritdoc}
  public function setHierarchy($hierarchy) {
    $this->hierarchy = $hierarchy;
    return $this;

   * {@inheritdoc}
  public function id() {
    return $this->vid;

   * {@inheritdoc}
  public function getDescription() {
    return $this->description;

   * {@inheritdoc}
  public static function preDelete(EntityStorageInterface $storage, array $entities) {
    parent::preDelete($storage, $entities);

    // Only load terms without a parent, child terms will get deleted too.
    entity_delete_multiple('taxonomy_term', $storage->getToplevelTids(array_keys($entities)));

   * {@inheritdoc}
  public static function postDelete(EntityStorageInterface $storage, array $entities) {
    parent::postDelete($storage, $entities);

    // Reset caches.

    if (reset($entities)->isSyncing()) {

    $vocabularies = array();
    foreach ($entities as $vocabulary) {
      $vocabularies[$vocabulary->id()] = $vocabulary->id();
    // Load all Taxonomy module fields and delete those which use only this
    // vocabulary.
    $field_storages = entity_load_multiple_by_properties('field_storage_config', array('module' => 'taxonomy'));
    foreach ($field_storages as $field_storage) {
      $modified_storage = FALSE;
      // Term reference fields may reference terms from more than one
      // vocabulary.
      foreach ($field_storage->getSetting('allowed_values') as $key => $allowed_value) {
        if (isset($vocabularies[$allowed_value['vocabulary']])) {
          $allowed_values = $field_storage->getSetting('allowed_values');
          $field_storage->setSetting('allowed_values', $allowed_values);
          $modified_storage = TRUE;
      if ($modified_storage) {
        $allowed_values = $field_storage->getSetting('allowed_values');
        if (empty($allowed_values)) {
        else {
          // Update the field definition with the new allowed values.



Contains filters are case sensitive
Name Modifierssort descending Type Description
VocabularyInterface::HIERARCHY_DISABLED constant Denotes that no term in the vocabulary has a parent.
VocabularyInterface::HIERARCHY_SINGLE constant Denotes that one or more terms in the vocabulary has a single parent.
VocabularyInterface::HIERARCHY_MULTIPLE constant Denotes that one or more terms in the vocabulary have multiple parents.
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.
ConfigEntityBundleBase::deleteDisplays protected function Deletes display if a bundle is deleted.
ConfigEntityBundleBase::loadDisplays protected function Returns view or form displays for this bundle.
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides Entity::invalidateTagsOnSave
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
DependencyTrait::addDependencies protected function Adds multiple dependencies.
Entity::entityManager Deprecated protected function Gets the entity manager.
Entity::entityTypeManager protected function Gets the entity type manager.
Entity::languageManager protected function Gets the language manager.
Entity::uuidGenerator protected function Gets the UUID generator.
Entity::linkTemplates protected function Gets an array link templates.
Entity::urlRouteParameters protected function Gets an array of placeholders for this entity.
Vocabulary::$vid protected property The taxonomy vocabulary ID.
Vocabulary::$name protected property Name of the vocabulary.
Vocabulary::$description protected property Description of the vocabulary.
Vocabulary::$hierarchy protected property The type of hierarchy allowed within the vocabulary.
Vocabulary::$weight protected property The weight of this vocabulary in relation to other vocabularies.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
DependencyTrait::$dependencies protected property The object's dependencies.
Entity::$entityTypeId protected property The entity type.
Entity::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
Entity::$typedData protected property A typed data object wrapping this entity.
RefinableCacheableDependencyTrait::$cacheContexts protected property Cache contexts.
RefinableCacheableDependencyTrait::$cacheTags protected property Cache tags.
RefinableCacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides Entity::invalidateTagsOnDelete
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
Vocabulary::getHierarchy public function Returns the vocabulary hierarchy. Overrides VocabularyInterface::getHierarchy
Vocabulary::setHierarchy public function Sets the vocabulary hierarchy. Overrides VocabularyInterface::setHierarchy
Vocabulary::id public function Gets the identifier. Overrides Entity::id
Vocabulary::getDescription public function Returns the vocabulary description. Overrides VocabularyInterface::getDescription
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
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides Entity::__construct
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides Entity::getOriginalId
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides Entity::setOriginalId
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides Entity::isNew
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status
ConfigEntityBase::setSyncing public function Sets the status of the isSyncing flag. Overrides ConfigEntityInterface::setSyncing
ConfigEntityBase::isSyncing public function Returns whether this entity is being changed as part of an import process. Overrides ConfigEntityInterface::isSyncing
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides Entity::createDuplicate
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides Entity::toArray
ConfigEntityBase::__sleep public function Overrides Entity::__sleep
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides Entity::urlInfo
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides Entity::url
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides Entity::link
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides Entity::toUrl
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides Entity::getCacheTagsToInvalidate
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides Entity::getConfigDependencyName
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides Entity::getConfigTarget
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
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::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::save public function Saves an entity permanently. Overrides Entity::save
Entity::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid
Entity::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
Entity::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
Entity::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle
Entity::label public function Gets the label of the entity. Overrides EntityInterface::label
Entity::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
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::access public function Checks data value access. Overrides AccessibleInterface::access
Entity::language public function Gets the language of the entity. Overrides EntityInterface::language
Entity::delete public function Deletes an entity permanently. Overrides EntityInterface::delete
Entity::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
Entity::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate
Entity::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities
Entity::getCacheContexts public function The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts
Entity::getCacheTags public function The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags
Entity::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge
Entity::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
Entity::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
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
DependencySerializationTrait::__sleep public function Prevents serializing any properties. Aliased as: traitSleep
DependencySerializationTrait::__wakeup public function
Vocabulary::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides ConfigEntityBase::preDelete
Vocabulary::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides ConfigEntityBundleBase::postDelete
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label.
Entity::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate
Entity::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad
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::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create