Contrib.social

Remove 'filter tips' and deprecate the API

Open on Drupal.org →
Created on 9 February 2025, 3 months ago

Problem/Motivation

Filter tips show up on every text field by default in Drupal. There is no way to switch it off via the UI.

📌 Add access control to /filter/tips Needs work adds a way to hide it (don't give anyone the permission), but I wonder if we really need it at all.

Drupal has shipped with ckeditor for years, and hand editing HTML is at best discouraged with ckeditor5.

When formatting tips are actually needed, we already provide field descriptions which site admins can edit - this would allow them to give a couple of markdown examples, link to external resources etc.

Apart from being mostly redundant, the page also looks extremely dated.

Steps to reproduce

Proposed resolution

Entirely remove the functionality in a minor release of Drupal core.

Remove the 'tips' method from the interface for filter plugins, open a follow-up issue to remove it from the base class for Drupal 12.

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

📌 Task
Status

Active

Version

11.0 🔥

Component

filter.module

Created by

🇬🇧United Kingdom catch

Live updates comments and jobs are added and updated live.
  • Needs product manager review

    It is used to alert the product manager core committer(s) that an issue represents a significant new feature, UI change, or change to the "user experience" of Drupal, and their signoff is needed. If an issue significantly affects the usability of Drupal, use Needs usability review instead (see the governance policy draft for more information).

Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @catch
  • Comment 3 months ago →
    🇬🇧United Kingdom catch
  • Comment 3 months ago →
    🇫🇷France dqd London | N.Y.C | Paris | Hamburg | Berlin

    +1 for raising this. My vote for it and 100% agree with the argumentation and reasons. And it would close a group of other issues. Additionally it minimizes the efforts to keep track with those tips and all possible combinations of allowed tags etc and it never really looked well seated under the textareas of body and comment fields and was kind of circumventing to style. And since we do not have any hard wired dependencies in core with this part of filter.module it would be mainly removing the respective parts in web/core/modules/filter (tips) and making sure that it does not break contrib in case that modules use tips to place their own (if any?)

    When formatting tips are actually needed, we already provide field descriptions which site admins can edit - this would allow them to give a couple of markdown examples, link to external resources etc.

    And which gives far more flexibility. Also in how it looks or how it is implemented (markup). Only drawback is that it do not change it's tips automatically regarding the allowed tags when switching between formats, I worry? Maybe we should provide a token which picks up the allowed tags from the formats to be used in the field description?

  • Comment 3 months ago →
    🇫🇮Finland lauriii Finland

    +1 for the removal as discussed during the Burgas onsite. The content on this page isn't relevant in the world of CKEditor 5.

  • First commit to issue fork.
  • Merge request !11180start removal of filter tips → (Open) created by quietone
  • Comment 2 months ago →
    🇬🇧United Kingdom catch

    MR looks good so far, except I think we probably need to remove the method from FilterInterface rather than deprecate it.

    We also need to remove the filter tips link from Drupal\filter\Element and should deprecate the route that it points to (which we can do now after https://www.drupal.org/node/3317784 → ).

    There are some templates in claro/stable etc. not sure if we can remove those yet or if it would need to happen in a 12.x-only issue.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024