Contrib.social

Remove taxonomy term description field; provide description field for forum taxonomy

Open on Drupal.org →
Created on 5 September 2009, almost 15 years ago
Updated 7 June 2024, 20 days ago

Updated: Comment #171, #242 →

Problem/Motivation

  • Following #413192 make taxonomy terms fieldable, the taxonomy term description base field is unnecessary.
  • For some vocabularies, e.g. the forum vocabulary, a taxonomy term description is a reasonable part of the taxonomy data model.
  • The tags vocabulary supplied for article nodes is intended for freetagging, so a description field doesn't really fit the usecase for that vocabulary.

Proposed resolution

  • Remove the description base field from taxonomy.
  • Do not add a description field to term bundles by default.
  • Do not add it for tags.
  • Do add a fixed, locked description for forum terms, in forum.module, so that the templates and code there can rely on it.
  • Most likely what we need to do is convert it to a configurable field with the same name and add it to all bundles on existing installations, but we have \Drupal\taxonomy\TermInterface::getDescription(), so terms having a description is part of the API. so likely we need to install this configurable field even for new D9 installations, deprecate it for D10 and then remove the default config. But to not break the API, we'd literally need to *disallow* deleting and always force-enable that field on all vocabularies.

    #242 →

Remaining tasks

  • Update the patch for this issue to implement the proposed resolution, without any upgrade path.
  • TBD, potentially a followup discussion: For D7 -> D8 migrations, any term bundle having a populated description field for any terms in the vocabulary should be migrated into a new configurable description field on that term bundle on the destination site. How do we make this easy for people?

User interface changes

There is no longer a description field available on taxonomy terms by default.

API changes

Removed TermInterface methods as follows:
- public function getDescription();
- public function setDescription($description);
- public function getFormat();
- public function setFormat($format);

Beta phase evaluation

📌 Task
Status

Needs work

Version

11.0 🔥

Component
Taxonomy  →

Last updated 1 day ago

  • Maintained by
  • 🇺🇸United States @xjm
  • 🇬🇧United Kingdom @catch
Created by

🇺🇸United States mlncn Minneapolis, MN, USA

Live updates comments and jobs are added and updated live.
  • API clean-up

    Refactors an existing API or subsystem for consistency, performance, modularization, flexibility, third-party integration, etc. May imply an API change. Frequently used during the Code Slush phase of the release cycle.

  • VDC

    Related to the Views in Drupal Core initiative.

  • DrupalWTF

    Worse Than Failure. Approximates the unpleasant remark made by Drupal developers when they first encounter a particular (mis)feature.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Comment 20 days ago →
    🇺🇸United States mlncn Minneapolis, MN, USA

    Forum is gone now making the forum-specific parts of this contrib's problem now. As a former core module we should still coordinate but are forum module → maintainers comfortable with core getting this transition done ASAP? It's a real shock when this mystery description field shows up on the "Manage form display" but not the manage field list, given that the node body field has been removable for so long.

    Not a great time in 11's cycle but maybe we can do this first thing in 12?

contrib.social Blog FAQ Discussions
Production build 0.69.0 2024