Drupal 8添加javascript并使用自定义模块在钩子中传递数据

Posted 2021-05-05

我正在使用Drupal 8构建自定义模块。该模块的一个要求是它根据配置设置设置javascript文件，模块用户在模块配置中设置。

需要添加到页面的javascript取决于配置设置。因此，我不能使用本文中提到的库来添加它：Adding assets to Drupal module。

我首先用块实现它。我使用Twig模板将php中的配置变量传递给twig文件，在twig文件中，我有一个标签来添加基于配置变量的javascript。请参阅Using twig templates。

这种方法的问题是用户需要在页面上添加块，并且该块上没有面向UI的元素。我也觉得很乱。

有没有更简洁的方法来添加我的javascript使用钩子并传递变量？我环顾四周，找到了hook_install和hook_page_attachments。所以我可以添加Javascript，但不知道如何将任何php变量传递给它。

我是Drupal开发的新手。任何帮助都非常感谢。

TL; DR我需要找到一种方法来使用Drupal钩子添加Javascript并将一些PHP变量传递给它。

答案

在hook_page_attachments中使用：

$attachments['#attached']['drupalSettings']['myvar'] = $myVariable;

然后在你的js（我假设你已经知道how to attach js library）：

(function ($, Drupal, drupalSettings) {

  Drupal.behaviors.my_custom_behavior = {
    attach: function (context, settings) {
      var strings = drupalSettings.myvar;
      ...
    }
  }

})(jQuery, Drupal, drupalSettings);

有关更多示例，请参阅nice Acquia tutorial。