I am wondering why the last two entries do not work:

public function getCacheTags() {
  $tags = [
  $cacheTags = Cache::mergeTags(parent::getCacheTags(), $tags);

  return $cacheTags;

When I edit my custom block the URL is:


The actual id of the block (for instance when embedding it) is customblockname.

What are the correct cache tags to include that block in my caching?

  • There is a database table named cachetags. Opening that makes me believe blocks are named like this: config:block.block.bartik_branding Where bartik_branding is the system name. So I suppose the pattern to be config:block.block.SYSNAME. You should however be able to use the getCacheTags() method on the block entity. That should always work. Aug 1 '17 at 9:37
  • its actually just 'block_content:7', :)
    – Alex
    Aug 1 '17 at 9:53
  • It actually is both. block_content:7 is the content entity with the actual data inside. But config:block.block.machine_name is the config entity of the block config entity, which contains placement information (theme, region, weight, settings, ..). What exactly you need depends on what you are doing, you should not have to hardcode your cache tags like that
    – Berdir
    Aug 1 '17 at 15:36

I just figured myself. The cache tag for custom blocks is simply:


  • Still I think it would be better to use getCacheTags on the block entity. Seems more solid and future proof. Aug 1 '17 at 9:55
  • @Neograph734 how would you do that?
    – Alex
    Aug 1 '17 at 10:03
  • 2
    For custom blocks you should be able to do something like $block = \Drupal\block_content\Entity\BlockContent::load($bid); to obtain the block (or maybe you have loaded it already). Then $block->getCacheTags(); to obtain the cache tag(s). Aug 1 '17 at 10:06
  • @Neograph734 That is pretty the correct answer, which remains valid even if the Block entity defines new cache tags, or third-party modules add more tags.
    – apaderno
    Aug 1 '17 at 10:59

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.