Use entity_label() to display taxonomy terms [#1864870]

Instead of directly displaying taxonomy terms with $term->name, Views should use entity_label('taxonomy_term', $term).

i18n_taxonomy.module for example automatically integrates with that to show the translated term title, if available.

This should make i18nviews's life easier and could probably deprecate a number of taxonomy handlers which do nothing else but display the term title in the correct language. And it should also make it much easier for users. Had to dive really deep into the views code to understand that I also need the i18n term argument validation handler because that one does inject the validated title ;)

Needs more testing, but seemed to work for me. Most $term's are actually not loaded with taxonomy_term_load() but use custom queries, that's a bit.. unfortunate but works in 7.x.

Consider this as a proof of concept :)

Comment	File	Size	Author
#6	views-entity_label-1864870-6.patch	2.21 KB	Andrew Answer
#6	7.x-3.x: PHP 7.1 & MySQL 5.5, D7 232 pass
#4	views-entity-label-1864870-4.patch	2.2 KB	Berdir
#4
#1	views-entity-label.patch	3.74 KB	Berdir
#1
	views-entity-label.patch	3.74 KB	Berdir

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

Berdir

German

Switzerland

CreditAttribution: Berdir commented 12 December 2012 at 15:55

File	Size
views-entity-label.patch	3.74 KB

Better patch, still had a $term->name in there.

Comment #2

dawehner

German

CreditAttribution: dawehner commented 12 December 2012 at 17:46

Issue tags:

+Needs manual testing

Thanks for working on it!

Needs more testing, but seemed to work for me. Most $term's are actually not loaded with taxonomy_term_load() but use custom queries, that's a bit.. unfortunate but works in 7.x.

I don't want to change these things in d7 unless we have tests for it, but in general your changes looks fine. For d8 we either have fixed it already or there are issues for that.

Comment #3

dawehner

German

CreditAttribution: dawehner commented 19 March 2013 at 23:03

+++ b/modules/taxonomy/views_handler_field_term_node_tid.incundefined
@@ -112,7 +112,7 @@ class views_handler_field_term_node_tid extends views_handler_field_prerender_li
+        $this->items[$term->node_nid][$term->tid]['name'] = check_plain(entity_label('taxonomy_term', $term));

+++ b/modules/taxonomy/views_plugin_argument_validate_taxonomy_term.incundefined
@@ -103,7 +103,7 @@ class views_plugin_argument_validate_taxonomy_term extends views_plugin_argument
+        $this->argument->validated_title = check_plain(entity_label('taxonomy_term', $term));

@@ -152,7 +152,7 @@ class views_plugin_argument_validate_taxonomy_term extends views_plugin_argument
+            $titles[] = $validated_cache[$term->tid] = check_plain(entity_label('taxonomy_term', $term));

@@ -185,7 +185,7 @@ class views_plugin_argument_validate_taxonomy_term extends views_plugin_argument
+          $this->argument->validated_title = check_plain(entity_label('taxonomy_term', $term));

Should we ever call entity_label on an entity which is not loaded totally?

Comment #4

Berdir

German

Switzerland

CreditAttribution: Berdir commented 20 August 2013 at 14:16

File	Size
views-entity-label-1864870-4.patch	2.2 KB

Re-roll, looks like one file was already fixed.

One case remaining where we don't load the entity. Not sure if we should load or not.

Comment #5

Chris Matthews CreditAttribution: Chris Matthews as a volunteer commented 7 January 2019 at 21:34

Issue summary:	View changes
Status:	Needs review	» Needs work
Issue tags:		+Needs reroll

3 files were hidden/shown/deleted

File	Size
views-entity-label.patch	3.74 KB

views-entity-label.patch	3.74 KB

views-entity-label-1864870-4.patch	2.2 KB

The 5 year old patch in #4 does not apply to the latest views 7.x-3.x-dev and if still applicable needs reroll.

Checking patch modules/taxonomy/views_handler_argument_taxonomy.inc...
error: while searching for:
    if ($this->argument) {
      $term = taxonomy_term_load($this->argument);
      if (!empty($term)) {
        return check_plain($term->name);
      }
    }
    // TODO review text

error: patch failed: modules/taxonomy/views_handler_argument_taxonomy.inc:20
error: modules/taxonomy/views_handler_argument_taxonomy.inc: patch does not apply

Checking patch modules/taxonomy/views_handler_argument_term_node_tid_depth.inc...
error: while searching for:
  function title() {
    $term = taxonomy_term_load($this->argument);
    if (!empty($term)) {
      return check_plain($term->name);
    }
    // TODO review text
    return t('No name');

error: patch failed: modules/taxonomy/views_handler_argument_term_node_tid_depth.inc:137
error: modules/taxonomy/views_handler_argument_term_node_tid_depth.inc: patch does not apply

Checking patch modules/taxonomy/views_handler_field_term_node_tid.inc...
Hunk #1 succeeded at 122 (offset 10 lines).

Comment #6

Andrew Answer CreditAttribution: Andrew Answer as a volunteer commented 20 April 2019 at 16:14

Status:	Needs work	» Needs review
Issue tags:	-Needs reroll

File	Size
views-entity_label-1864870-6.patch	2.21 KB
7.x-3.x: PHP 7.1 & MySQL 5.5, D7 232 pass

Patch rerolled.

Comment #7

AlfTheCat CreditAttribution: AlfTheCat commented 29 April 2020 at 04:58

Status:

Needs review

» Needs work

After applying the patch, I get a fatal error and the taxonomy page breaks. I tried the latest views dev release and the latest stable release, both with the same result.

The error in the log:
EntityMalformedException: Missing bundle property on entity of type taxonomy_term. in entity_extract_ids() (line 8003 of /var/aegir/platforms/[xxxx]/includes/common.inc).