public function SiteCacheContext::getCacheableMetadata in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Cache/Context/SiteCacheContext.php \Drupal\Core\Cache\Context\SiteCacheContext::getCacheableMetadata()
2. 9 core/lib/Drupal/Core/Cache/Context/SiteCacheContext.php \Drupal\Core\Cache\Context\SiteCacheContext::getCacheableMetadata()

Gets the cacheability metadata for the context.

There are three valid cases for the returned CacheableMetadata object:

• An empty object means this can be optimized away safely.
• A max-age of 0 means that this context can never be optimized away. It will never bubble up and cache tags will not be used.
• Any non-zero max-age and cache tags will bubble up into the cache item if this is optimized away to allow for invalidation if the context value changes.

Return value

\Drupal\Core\Cache\CacheableMetadata A cacheable metadata object.

Overrides CacheContextInterface::getCacheableMetadata

File

core/lib/Drupal/Core/Cache/Context/SiteCacheContext.php, line 40

Class

SiteCacheContext

Defines the SiteCacheContext service, for "per site" caching.

Namespace

Drupal\Core\Cache\Context

Code

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