Add a convenience method for getting the label of a bundle

+++ includes/common.incundefined
@@ -7283,6 +7283,29 @@ function entity_label($entity_type, $entity) {
+ * @return
+ *   A string with the human-readable name of the bundle, or FALSE if not specified.

Needs to be wrapped since it exceeds 80 chars.

Also not sure why we need a blank line in the middle, otherwise I could use this too in a couple modules, although it's really not too hard to grab from the entity information directly.

Powered by Dreditor.

+++ includes/common.incundefined
@@ -7283,6 +7283,29 @@ function entity_label($entity_type, $entity) {
+    $info = entity_get_info($entity_type);
+    $labels[$entity_type][$bundle] = !empty($info[$entity_type]['bundles'][$bundle]['label']) ? $info[$entity_type]['bundles'][$bundle]['label'] : FALSE;

1. We should probably pre-build all the possible bundle labels if !isset($labels[$entity_type]) to avoid multiple calls to entity_get_info(). Presumably this code will get called often when listing all bundles of an entity.

2. $info is already looked up by entity type, so trying to do $info[$entity_type] is invalid.

Powered by Dreditor.

The function definition comment was repeated and had an incorrect parameter. And the parameter names were re-used within the for loops, which caused some issues.

Also, where a label isn't available then maybe returning the machine name back would be better than false.

My patch is untested, I had no intention to use a patched core but have borrowed the function for custom module.

I've fixed a couple of bad variable names from #7.

Using this and very useful still. Marking RTBC

1. I think Drupal 8 needs this too, right? (Took a quick look through the D8 code and field_ui_widget_type_form() seems like a place that could use it.)
2. I don't see a point in caching here since entity_get_info() is already cached. (Perhaps that was not the case in November 2010 when this patch was originally written.)
3. If we need to avoid duplicate variable names, then the "normal" names ($entity_type and $bundle) should be used in the function parameters rather than the other way around. However, if we remove the caching that probably won't be necessary anyway.

Er, that is not the tag I intended to add... That would have been an interesting backport! :)

Related: See the comments on the entity_get_info API page, and also, for an example of somewhere this might be needed: #1953672: Make "These settings apply to the field everywhere it is used" clearer

If anyone thinks this is useful for D8, this would be the patch. I'm not so sure its needed, you could just call entity_get_bundles() yourself (it's heavily cached).

@tim.plunkett Thanks! I used you technique for my latest patch in #1953672: Make "These settings apply to the field everywhere it is used" clearer. It's quite simple, so I'm not sure a dedicated function is necessary though.

Agreed.

This was closed for D8, but could we still get the patch in #9 into D7? Patch still applies, and it seems like a useful addition.

I'm using this patch to get the entity bundle label in an entityreference selection plugin, and it works great.

Fixing docs line wrapping and trailing whitespace.

#21 works well for me

#23 As long as the same functionality is present in Drupal 8, we are good to go per out backports policy.

https://www.drupal.org/node/1527558 describes what changes can be added to a stable release a little bit more.

Features can be added at maintainer discretion, but need to be opt-in.

API additions are fine.

--

So we need to check if similar functionality is present in D8.

I've thought about this. While entity_get_bundle_name() was won't fix for Drupal 8, I would be okay to add a entity_get_bundles() function that does the same as in D8 - where it is deprecated, but has a replacement in the OO layer.

The code in #15 shows how simple the task to retrieve a bundle label then is.

If people disagree, we can also won't fix this.

Note this also still needs (or would have needed) work for #11 - that was not addressed in the latest Drupal 7 patch.

I have to say I wonder if there is really any significant difference between Drupal 7 and 8 here. I'm going to take a closer look...

So yeah, minus some uncertainly over what you do when the label doesn't exist:

1. The code in Drupal 8 (the procedural version) is basically this:

     $bundles = entity_get_bundles($entity_type);
     return isset($bundles[$bundle]['label']) ? $bundles[$bundle]['label'] : NULL;
   

2. Whereas the code in Drupal 7 is basically this:

     $entity_info = entity_get_info($entity_type);
     return isset($entity_info['bundles'][$bundle]['label']) ? $entity_info['bundles'][$bundle]['label'] : NULL;
   

Looks pretty similar to me.

Backporting entity_get_bundles() to Drupal 7 (either as part of this issue or separate) doesn't sound like a bad idea, but I don't think it materially affects the issue this was originally filed about.

Based on the above, I think if this is "won't fix" for Drupal 8 it should be "won't fix" for Drupal 7 also. But I'm not sure. Just because it only takes two lines of code to do something doesn't mean a helper method isn't useful. It still is useful if the two lines of code aren't so intuitive. Are they?

For Drupal 8 at this point I suppose a new function would look something like EntityTypeBundleInfoInterface::getBundleLabel($entity_type, $bundle). I am not sure offhand if that is an interface that it is OK to add a new method to though.

I would suggest we close this in favour of #2699835: Add a method to ContentEntityBase for getting its Bundle entity.

If that adds a way of doing $entity->getBundleEntity() then you can just chain on to get the label like this: $entity->getBundleEntity()->getLabel().

@joachim, that requires you to have a particular entity to work with, but there's no reason to assume your code would have one (or even to assume that one exists on the site yet).

I played around it with a bit though and it seems that in Drupal 8 you can do things like this:

  entity_load('node_type', 'article')->label();        // Gives "Article"
  entity_load('taxonomy_vocabulary', 'tags')->label(); // Gives "Tags"

Which is maybe good enough. However, it was a bit non-intuitive to have to use "node_type" there; it would still be nice to have a way to go from "node" and "article" to the bundle label, as described above.

@David_Rothstein ah right, fair enough.

For Drupal 7 this code works:

For the Bundle Machine Name

/**
 * Helper. Get bundle name.
 */
function entity_get_bundle_name($entity, $type) {
  $entity_info = entity_get_info($type);
  if (empty($entity_info['entity keys']['bundle'])) {
    $bundle = $type;
  } else {
    $bundle = $entity->{$entity_info['entity keys']['bundle']};
  }
  return $bundle;
}

For the Bundle Label

/**
 * Helper. Get bundle label.
 */
function entity_get_bundle_label($entity, $type) {
  $entity_info = entity_get_info($type);
  if (empty($entity_info['entity keys']['bundle'])) {
    $bundle = $type;
    $entity_type = $entity_info['bundles'][$bundle]['label'];
  } else {
    $bundle = $entity->{$entity_info['entity keys']['bundle']};
    $entity_type = $entity_info['bundles'][$bundle]['label'];
  }
  return $entity_type;
}