Cache API

              

                Copy

                  Download

              
              
/**
* Implements hook_entity_view_alter() to add cache contexts.
*/
function my_module_entity_view_alter(array &$build, \Drupal\Core\Entity\EntityInterface $entity, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode) {
   $build['#cache']['contexts'][] = 'user.permissions';
}
 
            

              

                Copy

                  Download

              
              
namespace Drupal\my_module\Service;
use Drupal\Core\Cache\CacheableMetadata;

class MyDataService {
   public function buildData(): array {
      $build = [
         '#markup' => 'Dynamic data output.',
      ];
      $cache_metadata = new CacheableMetadata();
      $cache_metadata->setCacheContexts(['route', 'user.roles']);
      $cache_metadata->applyTo($build);
      return $build;
   }
}
 
            

              

                Copy

                  Download

              
              
/**
* Basic example of using the Cache API to get and set data.
*/
namespace Drupal\my_module;

use Drupal\Core\Cache\Cache;

$cid = 'my_module:unique_cache_id';
$cache = \Drupal::cache()->get($cid);
if ($cache) {
   $data = $cache->data;
} else {
   $data = 'result of expensive processing';
   \Drupal::cache()->set($cid, $data, Cache::PERMANENT);
}
 
            

              

                Copy

                  Download

              
              
/**
* Provides a 'CachedContentBlock' block.
* @Block annotation is assumed to be defined in the plugin YAML.
*/
use Drupal\Core\Block\BlockBase;

class CachedContentBlock extends BlockBase {
   /**
   * {@inheritdoc}
   */
   public function build(): array {
      $build = [
         '#markup' => $this->t('This content is cached.'),
         '#cache' => [
            'contexts' => ['url.path'],
            'tags' => ['my_module_block'],
            'max-age' => 600,
         ],
      ];
      return $build;
   }
}
 
            

              

                Copy

                  Download

              
              
/**
* Retrieve data from a custom cache bin or generate and store it.
*/
$cid = 'my_module:custom_item';
$cache_bin = \Drupal::service('cache.my_module_bin');
if ($item = $cache_bin->get($cid))) {
   $data = $item->data;
} else {
   $data = 'Expensive data calculation';
   $cache_bin->set($cid, $data, Cache::PERMANENT);
}
 
            

              

                Copy

                  Download

              
              
namespace Drupal\my_module\Cache\Context;

use Drupal\Core\Cache\Context\CacheContextInterface;
use Drupal\Core\Cache\CacheableMetadata;
/**
* Provides a custom cache context based on the current hour.
*
* @CacheContext(
* id = "my_custom_time",
* label = @Translation("Custom Time Cache Context")
* )
*/

class MyCustomTimeCacheContext implements CacheContextInterface {
   public function getContext(): string {
      return date('H');
   }

   public function getCacheableMetadata(): CacheableMetadata {
      return new CacheableMetadata();
   }
}
 
            

              

                Copy

                  Download

              
              
/**
* Service class for caching data using dependency injection.
*/

use Drupal\Core\Cache\CacheBackendInterface;

class MyCacheService {
   /**
   * The cache backend service.
   */
   protected CacheBackendInterface $cacheBackend;

   /**
   * Constructs a MyCacheService object.
   */
   public function __construct(CacheBackendInterface $cache_backend) {
      $this->$cacheBackend = $cache_backend;
   }

   public function getData(string $cid): ?string {
      $cache = $this->$cacheBackend->get($cid);
      return $cache ? $cache->data : NULL;
   }

   public function setData(string $cid, string $data, int $expire = CacheBackendInterface::CACHE_PERMANENT): void {
      $this->$cacheBackend->set($cid, $data, $expire);
   }
}
 
            

              

                Copy

                  Download

              
              
/**
* Invalidate cache entries tagged with 'my_module_tag'.
*/
\Drupal::cache()->invalidateTags(['my_module_tag']);
 
            

              

                Copy

                  Download

              
              
namespace Drupal\my_module\Controller;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Ajax\CacheableJsonResponse;
use Drupal\Core\Cache\CacheableMetadata;
use Symfony\Component\DependencyInjection\ContainerInterface;
 
/**
* Returns a JSON response with overridden cache metadata.
*/
class OverrideCacheController extends ControllerBase {
   /**
    * {@inheritdoc}
    */
   public static function create(ContainerInterface $container) {
      return new static();
   }

   public function overrideCache(): CacheableJsonResponse {
      $data = [
         'content' => $this->t('Response with overridden cache metadata.'),
      ];
      $response = new CacheableJsonResponse($data);
      $cache_metadata = new CacheableMetadata();
      $cache_metadata->setCacheTags(['override_tag']);
      $cache_metadata->setCacheContexts(['user.uid']);
      $cache_metadata->setCacheMaxAge(0); // Non-cacheable
      $response->addCacheableDependency($cache_metadata);
      return $response;
   }
}
 
            

              

                Copy

                  Download

              
              
$build = [
   '#markup' => 'Hello, world!',
   '#cache' => [
      'contexts' => ['user.roles'],
   ],
];
return $build;
 
            

              

                Copy

                  Download

              
              
/**
* Render array with Cache API metadata.
*/
$form = [];
$form['content'] = [
   '#markup' => 'Hello World',
   '#cache' => [
      'contexts' => ['user.permissions'],
      'tags' => ['node_list'],
      'max-age' => 3600,
   ],
];
return $form;
 
            

              

                Copy

                  Download

              
              
namespace Drupal\my_module\Controller;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Ajax\CacheableJsonResponse;

class MyController extends ControllerBase {
   /**
    * Returns a cacheable JSON response with custom metadata.
    */
   public function jsonContent(): CacheableResponseInterface {
      $data = [
         'message' => $this->t('Hello, cacheable JSON response!'),
      ];
      $cache_metadata = new CacheableMetadata();
      $cache_metadata->setCacheTags(['my_module_tag']);
      $cache_metadata->setCacheContexts(['url.path', 'user.roles']);
      $cache_metadata->setCacheMaxAge(3600);

      $response = new \Drupal\Core\Ajax\CacheableJsonResponse($data);
      $response->addCacheableDependency($cache_metadata);

      return $response;
   }
}