Warning when passing a nowdoc string to t()

Open on Drupal.org →

Created on 26 May 2023, about 1 year ago

Updated 16 June 2023, about 1 year ago

Problem/Motivation

I get a warning from Drupal.Semantics.FunctionT.NotLiteralString if I pass a nowdoc string to t().

Steps to reproduce

    $help_text = $this->t(<<<'HTML'
      <p>
        For information about what an item is and how to complete it, click it in
        the list below.
      </p>
    HTML);

Note that unlike heredoc strings, which would have no quotes around the terminator like: <<<HTML, nowdoc strings do not allow variable interpolation, so they truly are string literals.

Proposed resolution

Allow translation of nowdoc strings.

✨ Feature request

Status

Closed: won't fix

Version

8.3

Component

Coder Sniffer

Created by

Live updates comments and jobs are added and updated live.

Sign in to follow issues

Comments & Activities

Issue created by @solideogloria
Comment about 1 year ago →
solideogloria
Comment about 1 year ago →
solideogloria
Status changed to Closed: won't fix about 1 year ago9:01am 16 June 2023
Comment about 1 year ago →
🇦🇹Austria klausi 🇦🇹 Vienna
Thanks for reporting!

It is important for automatic translation extraction tools that string literals are used. We are having a discussion in ✨ REVERTED: Allow passing constants to t() translate function to prevent 'Only string literals should be passed to t() where possible' CS warning Fixed about a potential revert because even using constants might not be a good idea.

For private projects I would recommend to disable this sniff or ignore that error explicitly if you don't care about translation extraction.

If the potx extraction tools support nowdoc/heredoc please let me know and we can reopen this.

contrib.social Blog FAQ Discussions

Production build 0.69.0 2024