Where to define custom entity caching rules of detail pages

Stef Van Looveren

2/18/23, 1:19 PM

When you have a larger project you probably have both internal page cache as internal dynamic page cache module enabled. In my case I do. But I have a section on my website containing custom entities ('Contest') where I would like to have custom-tailored control of caching of the detail page (contest/1). This is what I found so far:

/**
 * Implements hook_entity_view_alter()
 * Disable caching on all contest entity types
 */
function mymodule_entity_view_alter(array &$build, Drupal\Core\Entity\EntityInterface $entity, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) {
  $types = ['contest'];
  if (in_array($entity->bundle(), $types)) {
    $build['#cache']['max-age'] = 0;
    \Drupal::service('page_cache_kill_switch')->trigger();
  }
}

Is this the only way? I'd expect to have a more clean way, in my Contest.php perhaps? Looking forward to possible answers!

0 + 0

caching

entities

4uk4

2/18/23, 1:33 PM

It's unclear what you are asking. The Dynamic Page Cache respects max-age = 0, so there is no more clean way to disable it. Do you mean the [Internal Page Cache](https://www.drupal.org/docs/administering-a-drupal-site/internal-page-cache)? Only if you've enabled this module you would need the additional kill switch. Or do you mean the response headers to control the browser cache?

Stef Van Looveren

2/18/23, 2:06 PM

Thanks for replying. Sorry, I mean both internal page cache as Internal Dynamic Page Cache. Let's consider both modules to be enabled. I was just wondering if there is a more OO way to define the caching of the custom entity detail pages.

4uk4

2/18/23, 2:12 PM

There are more things unclear. Your code is checking for a bundle, but it seems like you want to check `getEntityTypeId()`. If this is the case you could add the option `no_cache: TRUE` to the entity routes (route_provider in your entity class **Contest**).

Stef Van Looveren

2/19/23, 6:56 AM

Correct answer below was exactly what I was looking for. Thanks.

Score:2

Drupal

4uk4

2/18/23, 3:04 PM

I was just wondering if there is a more OO way to define the caching of the custom entity detail pages.

This would be extending the route provider you are using now (DefaultHtmlRouteProvider or AdminHtmlRouteProvider), specifying it in the custom entity class

*     "route_provider" = {
*       "html" = "Drupal\mymodule\MyEntityRouteProvider",
*     },

and overriding getCanonicalRoute to add the no_cache option:

protected function getCanonicalRoute(EntityTypeInterface $entity_type) {
  $route = parent::getCanonicalRoute($entity_type);
  $route->setOption('no_cache', TRUE);
  return $route;
}

0 + 0

Stef Van Looveren

2/18/23, 3:14 PM

Great. I did not know this. Thanks.

Elon Musk

I sit in a Tesla and translated this thread with Ai:

EN: Where to define custom entity caching rules of detail pages

TH: ตำแหน่งที่จะกำหนดกฎการแคชเอนทิตีแบบกำหนดเองของหน้ารายละเอียด

RO: Unde să definiți regulile personalizate de stocare în cache a entităților pentru paginile de detalii

RU: Где определить настраиваемые правила кэширования сущностей для страниц сведений

VI: Nơi xác định quy tắc bộ nhớ đệm thực thể tùy chỉnh của các trang chi tiết

Post an answer

Most people don’t grasp that asking a lot of questions unlocks learning and improves interpersonal bonding. In Alison’s studies, for example, though people could accurately recall how many questions had been asked in their conversations, they didn’t intuit the link between questions and liking. Across four studies, in which participants were engaged in conversations themselves or read transcripts of others’ conversations, people tended not to realize that question asking would influence—or had influenced—the level of amity between the conversationalists.