Drupal 8 自定义块（模块）创建树枝模板文件

Question

我有一个自定义模块，它创建一个具有字段元素的自定义块。

这一切都很好，但我需要为这个块设置主题。我已经检查了这里的其他帖子，但没有成功。

我已启用 Twig 调试并获得主题建议。还是没有运气。

谁能指点我正确的方向。

这是我目前所拥有的：

my_module/my_module.module

// nothing related in here

my_module/src/Plugin/Block/myModuleBlock.php

<?php

namespace Drupal\my_module\Plugin\Block;

use Drupal\Core\Block\BlockBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * Provides a 'ModuleBlock' block.
 *
 * @Block(
 *  id = "module_block",
 *  admin_label = @Translation("My Module"),
 * )
 */
class ModuleBlock extends BlockBase {

  public function blockForm($form, FormStateInterface $form_state) {
    $form['test'] = array(
      '#type' => 'select',
      '#title' => $this->t('test'),
      '#description' => $this->t('test list'),
      '#options' => array(
        'Test' => $this->t('Test'), 
      ),
      '#default_value' => isset($this->configuration['test']) ? $this->configuration['test'] : 'Test',
      '#size' => 0,
      '#weight' => '10',
      '#required' => TRUE,
    );    
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['test'] = $form_state->getValue('test');
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    $build['module_block_test']['#markup'] = '<p>' . $this->configuration['test'] . '</p>';
    return $build;
  }


}

my_module/templates/block--my-module.html.twig // 按照 twig debug 的建议

<h1>This is a test</h1>
<div id="test-widget">{{ content }}</div>

我还应该注意，在我的 my_theme.theme 我有这个，但我不认为它相关：

// Add content type suggestions.
function my_theme_theme_suggestions_page_alter(array &$suggestions, array $variables) {
  if ($node = \Drupal::request()->attributes->get('node')) {
    array_splice($suggestions, 1, 0, 'page__node__' . $node->getType());
  }
}

至于我试过的是这样的：

public function build() {
    return array(
      '#theme' => 'block--my-module'
    );
}

但还是不行。

非常感谢这里的任何帮助。

更新：所以我刚刚开始工作，但我仍然需要帮助。我将模板 block--my-module.html.twig 移到了我的主题目录中，并且成功了。

如何让它在我的模块目录中工作？

Answer 1

更新：所以我刚刚开始工作，但我仍然需要帮助。我移动了 模板块--my-module.html.twig 到我的主题目录和它 工作。

如何让它在我的模块目录中工作？

您可以在模块根目录中创建一个名为templates/ 的目录。 将您的模板放在这里。

现在让 Drupal 知道您将模板存储在模块中。 在your_module.module添加这个函数：

function YOUR_MODULE_theme($existing, $type, $theme, $path) {
  return array(
    'block__my_module' => array(
      'render element' => 'elements',
      'template' => 'block--my-module',
      'base hook' => 'block'
    )
  );
}

这未经测试。这就是我的自定义块的工作方式。

不要忘记清除缓存。

Answer 2

为了能够在模块中添加 twig 文件，您需要确保模块定义了引用，而不是主题。

您仍然可以在模块的 .module 文件中实现 hook_theme()，如下所示：

function mymodule_theme($existing, $type, $theme, $path) {
  return [
    'mymodule_block'     => [
      'variables' => [
        // define defaults for any variables you want in the twig file
        'attributes' => [
           'class' => ['my-module-class'],
         ], //etc
      ],
    ],
  ];
}

然后在你的块的 build() 实现中，你可以添加对新主题函数的引用：

public function build() {
    // Load the configuration from the form
    $config = $this->getConfiguration();
    $test_value = isset($config['test']) ? $config['test'] : '';

    $build = [];
    $build['#theme'] = 'mymodule_block';

    // You would not do both of these things...
    $build['#test_value'] = $test_value;
    $build['module_block_test']['#markup'] = '<p>' . $test_value . '</p>';

    return $build;
}

最后要小心你放置你的树枝文件的位置和你的名字。在你的模块目录下创建templates目录，将主题函数名中的_替换为-：mymodule-block.html.twig