Contrib.social

"Additional Text Format/Filter" is misleading

Open on Drupal.org →
Created on 10 July 2024, 9 months ago

Problem/Motivation

The field setting "Additional Text Format/Filter" gives the impression that the text format and its filters will be applied in addition to the filters that are in the text format set for the field. The help text correctly states that it will be used "instead" of what is set for the field, but this can be easy to miss.

The project page for this module also alludes to this being an additional format instead of a replacement:

The normal per-node text format filter will always be run first so security filters are still in place. This display tweak runs an additional process as part of the rendering.

Steps to reproduce

Proposed resolution

Ideally, the module would work as labeled, and the filter would be applied in addition to what is already set. Alternatively, relabel the setting to something like "Replacement Text Format/Filter" to make it clear what the setting does without the need to refer to the help text.

Update the module page to clearly communicate that this is not an additional process but replaces the text format set on the field.

Remaining tasks

User interface changes

API changes

Data model changes

🐛 Bug report
Status

Active

Version

2.0

Component

Documentation

Created by

🇺🇸United States byrond

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @byrond
  • Comment 9 months ago →
    🇳🇿New Zealand dman Koh Samui, Thailand

    If it is not getting the double-filter behavior, then yes, this is a regression. Possibly happened during the major version update when things needed to be entirely re-written.
    For security reasons, yes, the admin-set filters should always be in place and run first. Field Formatter Filter is intended to be primarily cosmetic, and should not be able to override system-wide default behaviors.

  • Comment 1 day ago →
    🇳🇿New Zealand dieuwe Auckland, NZ

    This is an interesting dilemma.

    Practically, we use this to use formats intended for various teaser contexts where the replacement text format is always more restrictive.

    Restoring the originally intended behaviour could also cause side effects on some websites, although only if the additional format is less restrictive than the default one.

    Fixing the label and project description to reflect current behaviour would certainly be the easiest.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024