function hook_entity_bundle_info

Same name in other branches
  1. 9 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_bundle_info()
  2. 10 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_bundle_info()
  3. 11.x core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_bundle_info()

Describe the bundles for entity types.

Return value

array An associative array of all entity bundles, keyed by the entity type name, and then the bundle name, with the following keys:

  • label: The human-readable name of the bundle.
  • uri_callback: (optional) The same as the 'uri_callback' key defined for the entity type in the EntityTypeManager, but for the bundle only. When determining the URI of an entity, if a 'uri_callback' is defined for both the entity type and the bundle, the one for the bundle is used.
  • translatable: (optional) A boolean value specifying whether this bundle has translation support enabled. Defaults to FALSE.

See also

\Drupal\Core\Entity\EntityTypeBundleInfo::getBundleInfo()

hook_entity_bundle_info_alter()

Related topics

1 function implements hook_entity_bundle_info()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

entity_test_entity_bundle_info in core/modules/system/tests/modules/entity_test/entity_test.module
Implements hook_entity_bundle_info().
2 invocations of hook_entity_bundle_info()
EntityTypeBundleInfo::getAllBundleInfo in core/lib/Drupal/Core/Entity/EntityTypeBundleInfo.php
Get the bundle info of all entity types.
KernelTestBaseTest::testSetUp in core/modules/simpletest/src/Tests/KernelTestBaseTest.php
Tests expected behavior of setUp().

File

core/lib/Drupal/Core/Entity/entity.api.php, line 853

Code

function hook_entity_bundle_info() {
    $bundles['user']['user']['label'] = t('User');
    return $bundles;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.