ProcessedText filter doesn't pass in correct language when using language fallback

Created on 15 July 2019, about 5 years ago

Updated 31 January 2023, over 1 year ago

Problem/Motivation

Drupal\filter\Element\ProcessedText::preRenderText() presently grabs the langcode from $element['#langcode'] and then passes it into respective text filters.

  public static function preRenderText($element) {
    // ...
    $langcode = $element['#langcode'];
    // ...

    // Get a complete list of filters, ordered properly.
    /** @var \Drupal\filter\Plugin\FilterInterface[] $filters **/
    $filters = $format->filters();

    // Give filters a chance to escape HTML-like data such as code or formulas.
    foreach ($filters as $filter) {
      if ($filter_must_be_applied($filter)) {
        $text = $filter->prepare($text, $langcode);
      }
    }

    // Perform filtering.
    $metadata = BubbleableMetadata::createFromRenderArray($element);
    foreach ($filters as $filter) {
      if ($filter_must_be_applied($filter)) {
        $result = $filter->process($text, $langcode);
        $metadata = $metadata->merge($result);
        $text = $result->getProcessedText();
      }
    }
    // ...

However, as identified in #3063657: Token always output in wrong / default language → , if a node is referencing a token that has a translation for a particular language it will only load those translations if the node itself is translated into that same language:

1. You use a module like language hierarchy to provide language fallback functionality for various regions. For example:
English:
-> /en-us
-> /en-gb
2. You create a node in the base English language that contains a token.
3. You visit that node in /en-gb. Because the node was created using the primary english translation, if you visit /en-gb, the filter module will pass in `en` as the langcode, despite the fact you're visiting the page in en-gb.

Proposed resolution

Use the current langcode (\Drupal::languageManager()->getCurrentLanguage()->getId()) instead of $element['#langcode']

Remaining tasks

1.
2.

User interface changes

n/a

API changes

n/a

Data model changes

n/a

Release notes snippet

TBD

🐛 Bug report

Status

Needs work

Version

10.1 ✨

Component

Filter →

Last updated about 11 hours ago

No maintainer

Created by

🇺🇸United States WidgetsBurritos San Antonio, TX

Live updates comments and jobs are added and updated live.

Needs tests
The change is currently missing an automated test that fails when run with the original code, and succeeds when the bug has been fixed.

i18n

language

Needs subsystem maintainer review
It is used to alert the maintainer(s) of a particular core subsystem that an issue significantly impacts their subsystem, and their signoff is needed (see the governance policy draft for more information). Also, if you use this tag, make sure the issue component is set to the correct subsystem. If an issue significantly impacts more than one subsystem, use needs framework manager review instead.

Incomplete comments

Comments & Activities

Not all content is available!

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

Comment over 1 year ago →
needs-review-queue-bot
The Needs Review Queue Bot → tested this issue. It either no longer applies to Drupal core, or fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.
Comment over 1 year ago →
🇩🇪Germany Anybody Porta Westfalica

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024