How to cache block for logged in user?

Question

I have a block, created with a custom block plugin (extending BlockBase), that shows on every page, and I want to cache its data, to speed up performance.

I have added cache tags to the build() function:

$build['#cache']['tags'] = $cache_tags;

But the build() function is still executing on each page load. I guess because the cache tags are for render cache, not data cache.

Is there a built in way to cache the data in the build() function for a block for logged in users?

Or do I have to add custom caching in the build function, like this:

if ($cache = \Drupal::cache()->get($cid)) {

https://api.drupal.org/api/drupal/core!core.api.php/group/cache/8.2.x

Answer 1

Blocks are cached by default. A block class with this build method:

public function build() {
    return [
      '#markup' => 'Block content',
    ];
  }

gets cached indefinitely or as long as you set in cache max-age.

If you add cache tags to the block that doesn't change whether the block is cached or not. The cache tags are used to invalidate cache items, not to store them. That is what cache keys are used for.

If the block gets cached, this is for logged in users, because the cache for anonymous users doesn't cache blocks, only pages.

Answer 2

One way to configure cache for a block is implement getCacheTags and getCacheContexts in your Block.

To cache per user, you can use this code:

PHP Code:

public function getCacheTags() {
  if ($user = \Drupal::currentUser()) {
    return Cache::mergeTags(parent::getCacheTags(), array('user:' . $user->id()));
  } else {
    return parent::getCacheTags();
  }
}

public function getCacheContexts() {
  return Cache::mergeContexts(parent::getCacheContexts(), array('user'));
}

Remember to import Drupal\Core\Cache\Cache in your Block class.

Copy this code to your Block and clear cache.