Verified Commit b050dbf4 authored by Théodore Biadala's avatar Théodore Biadala
Browse files

Issue #3062376 by smustgrave, rlnorthcutt, Krzysztof Domański, ravi.shankar,...

Issue #3062376 by smustgrave, rlnorthcutt, Krzysztof Domański, ravi.shankar, robpowell, acbramley, Abhijith S, larowlan, Anybody, lauriii, phenaproxima, brandonratz, danflanagan8, quietone, longwave: Template suggestions for custom block view modes
parent f2ba76f1
Loading
Loading
Loading
Loading
Loading
+31 −0
Original line number Diff line number Diff line
@@ -5,6 +5,7 @@
 * Allows the creation of content blocks through the user interface.
 */

use Drupal\block_content\BlockContentInterface;
use Drupal\Core\Url;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\field\Entity\FieldConfig;
@@ -183,3 +184,33 @@ function _block_content_has_reusable_condition(array $condition, array $tables)
  }
  return FALSE;
}

/**
 * Implements hook_theme_suggestions_HOOK_alter() for block templates.
 */
function block_content_theme_suggestions_block_alter(array &$suggestions, array $variables) {
  $suggestions_new = [];
  $content = $variables['elements']['content'];

  $block_content = $variables['elements']['content']['#block_content'] ?? NULL;

  if ($block_content instanceof BlockContentInterface) {
    $bundle = $content['#block_content']->bundle();
    $view_mode = strtr($variables['elements']['#configuration']['view_mode'], '.', '_');

    $suggestions_new[] = 'block__block_content__view__' . $view_mode;
    $suggestions_new[] = 'block__block_content__type__' . $bundle;
    $suggestions_new[] = 'block__block_content__view_type__' . $bundle . '__' . $view_mode;

    if (!empty($variables['elements']['#id'])) {
      $suggestions_new[] = 'block__block_content__id__' . $variables['elements']['#id'];
      $suggestions_new[] = 'block__block_content__id_view__' . $variables['elements']['#id'] . '__' . $view_mode;
    }

    // Remove duplicate block__block_content.
    $suggestions = array_unique($suggestions);
    array_splice($suggestions, 1, 0, $suggestions_new);
  }

  return $suggestions;
}
+86 −0
Original line number Diff line number Diff line
<?php

namespace Drupal\Tests\block_content\Kernel;

use Drupal\block\Entity\Block;
use Drupal\block_content\Entity\BlockContent;
use Drupal\block_content\Entity\BlockContentType;
use Drupal\KernelTests\KernelTestBase;

/**
 * Tests the block_content_theme_suggestions_block() function.
 *
 * @group block_content
 */
class BlockTemplateSuggestionsTest extends KernelTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'user',
    'block',
    'block_content',
    'system',
  ];

  /**
   * The BlockContent entity used for testing.
   *
   * @var \Drupal\block_content\Entity\BlockContent
   */
  protected $blockContent;

  /**
   * {@inheritdoc}
   */
  protected function setUp(): void {
    parent::setUp();

    $this->installEntitySchema('block_content');

    // Create a block content type.
    $block_content_type = BlockContentType::create([
      'id' => 'test_block',
      'label' => 'A test block type',
      'description' => "Provides a test block type.",
    ]);
    $block_content_type->save();

    $this->blockContent = BlockContent::create([
      'info' => 'The Test Block',
      'type' => 'test_block',
    ]);
    $this->blockContent->save();
  }

  /**
   * Tests template suggestions from block_content_theme_suggestions_block().
   */
  public function testBlockThemeHookSuggestions() {
    // Create a block using a block_content plugin.
    $block = Block::create([
      'plugin' => 'block_content:' . $this->blockContent->uuid(),
      'region' => 'footer',
      'id' => 'machine_name',
    ]);

    $variables['elements']['#id'] = $block->id();
    $variables['elements']['#configuration']['provider'] = 'block_content';
    $variables['elements']['#configuration']['view_mode'] = 'full';
    $variables['elements']['content']['#block_content'] = $this->blockContent;
    $suggestions_empty = [];
    $suggestions_empty[] = 'block__block_content__' . $block->uuid();
    $suggestions = block_content_theme_suggestions_block_alter($suggestions_empty, $variables);

    $this->assertSame([
      'block__block_content__' . $block->uuid(),
      'block__block_content__view__full',
      'block__block_content__type__test_block',
      'block__block_content__view_type__test_block__full',
      'block__block_content__id__machine_name',
      'block__block_content__id_view__machine_name__full',
    ], $suggestions);
  }

}