How to add block template suggestions?

Question

I want to be able to create a block or place a block into a region and theme it according to the selected view mode from Panels. I have noticed a discrepancy between Custom Block and Entity Block where one form gives you the view mode to show the block in, and the other does not (Custom Block).

I want the template suggestion to be along the lines of block--provider/module--block-bundle--view-mode.html.twig but struggling to find consistency in the variables in hook_theme_suggestions_block_alter() in order to add the suggestion. At the same time, I want to enforce the template that is used no matter if the user created the block inline, or referenced an existing block via Entity Block. What keys or identifiers can I look for to make this work?

Answer 1

Normally a content entity has a template, like node.html.twig for node, so for custom blocks there should be block-content.html.twig. To avoid overhead it was decided to remove this template. This means you can't add template suggestions to the entity template, instead you have to add them to the block template. In this case you get the variables from the plugin when adding suggestions and you don't find the view mode or other details in a consistent way like for entities.

Additionally you use two different plugins to place the block:

• Original block plugin for Custom Blocks (core)

  http://cgit.drupalcode.org/drupal/tree/core/modules/block_content/src/Plugin/Block/BlockContentBlock.php?h=8.4.x

• Block plugin from Entity Block (contrib)

  http://cgit.drupalcode.org/entity_block/tree/src/Plugin/Block/EntityBlock.php?h=8.x-1.x

The second method, this is using custom blocks outside of the core block content plugin is not officially supported, because the pair of both are optimized to work together.

For the second method a custom entity might be a better choice (then of course one which has a template, which is standard for entities built by Drupal Console ).

---

I have noticed a discrepancy between Custom Block and Entity Block where one form gives you the view mode to show the block in, and the other does not (Custom Block).

Checking the linked code from the Custom Block plugin. It should show the view mode, if there is more than one to choose from:

$form['view_mode'] = [
  '#type' => 'select',
  '#options' => $options,
  '#title' => $this->t('View mode'),
  '#description' => $this->t('Output the block in this view mode.'),
  '#default_value' => $this->configuration['view_mode'],
  '#access' => (count($options) > 1),
];

Answer 2

I like to reuse basic block for a lot, so I added a List(text) field called "field_role" With this, I can reuse the basic block type in lots of places, each with unique templates. The following provides template suggestions:

function mymodule_theme_suggestions_block_alter(array &$suggestions, array $variables, $hook) {
  if (isset($variables['elements']['content']['#block_content'])) {
    /** @var \Drupal\block_content\Entity\BlockContent $content */
    $content = $variables['elements']['content']['#block_content'];
    $view_mode = $variables['elements']['content']['#view_mode'];
    if (isset($content->get('field_role')->getValue()[0]['value'])) {
      $role = $content->get('field_role')->getValue()[0]['value'];
      $suggestions[] = "block__block_content__{$role}";
      $suggestions[] = "block__block_content__{$role}__{$view_mode}";
      if ($label = $variables['elements']['#configuration']['label']) {
        $label = preg_replace("/[^a-zA-Z0-9\s]+/", "", trim(strtolower($label)));
        $label = str_replace(" ", "_", $label);
        $suggestions[] = "block__block_content__{$role}__{$label}";
        $suggestions[] = "block__block_content__{$role}__{$label}__{$view_mode}";
      }
    }
  }
}