Access variable in Twig template of custom module Drupal 8

2
votes

I want to use a variable in the Twig file of Drupal 8. And that twig variable should be available for all pages of the site.

Suppose I have a variable $my_variable created in my Form or in Controller. so now I want to use this $my_variable in my twig file. 

Like this {{ my_variable }}.

I have already tried this approach :

get $tempstore inside a twig file drupal 8

My Module file:

function my_module_theme() {
    return [
        'theme_tag' => [
        'variables' => ['my_variable' => NULL],
        ],
    ];
}

My Controller :

public function callMe() {
     $my_variable= "some data here";
     return [
          '#theme' => 'theme_tag',
          '#my_variable' => $my_variable,
     ];
}

My Twig :

<p> {{ my_variable}} </p>

any help would be appreciated. Thanks!

2
phpsymfonymoduletwigdrupal-8
Maybe this question should be on: drupal.stackexchange.com - felipsmartins
@felipsmartins, please find the solution and share the exact link not a link to the whole site. - Nasser Ali Karimi
@Nasser actually, this question is a little bit of off-topic, cause there's a specific channel for drupal+twig related questions. - felipsmartins

2 Answers

2
votes

A complete test module with template created on git hub you can check that as well. https://github.com/nassernak/drupal8-custom-template

You need to define the path of twig template

'path' => $path . '/templates',
'template' => 'twig-template-file-name',

$path -> refer to you module directory

templates ->is a folder that contains your templates

template -> just the file name without extension, in my case without .html.twig.

Totally, define your theme hook like this and set your variable in variables array.

   function your_module_name_theme($existing, $type, $theme, $path) {
      return [
        'theme_tag' => [
          'variables' => [
            'var2' => NULL,
            'var2' => NULL,
          ],
          'path' => $path . '/templates',
          'template' => 'twig-template-file-name-without-extention',
        ],
      ];
    }

Then in your callback function that will refer to your template use this sample.

public function basePageCallback() {
    return [
      '#theme' => 'theme_tag',
      '#var1' => 'test',
      '#var2' => 'test2',
    ];

And then access it on your twig {{var1}}

0
votes

Create the twig file in mymodulename/templates/my-template-name.html.twig

<div>{{ my_variable }}</div>

Then add hook_theme in mymodulename.module:

function mymodulename_theme($existing, $type, $theme, $path) {
  return [
    'my_template_name' => [
      'variables' => [
        'my_variable' => 'default value',
      ],
    ],
  ];
}

Call template:

  // Call the mail template
  $template = [
    '#theme' => 'my_template_name',
    '#my_variable' => 'my variable value',
  ];
  // Render the template
  $rendered_template = \Drupal::service('renderer')->render($template);

  return ['#markup' => $rendered_template];