function CacheContextInterface::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.

15 methods override CacheContextInterface::getCacheableMetadata()
AccountPermissionsCacheContext::getCacheableMetadata in core/lib/Drupal/Core/Cache/Context/AccountPermissionsCacheContext.php
Gets the cacheability metadata for the context.
IpCacheContext::getCacheableMetadata in core/lib/Drupal/Core/Cache/Context/IpCacheContext.php
Gets the cacheability metadata for the context.
IsFrontPathCacheContext::getCacheableMetadata in core/lib/Drupal/Core/Cache/Context/IsFrontPathCacheContext.php
Gets the cacheability metadata for the context.
IsSuperUserCacheContext::getCacheableMetadata in core/lib/Drupal/Core/Cache/Context/IsSuperUserCacheContext.php
Gets the cacheability metadata for the context.
PathCacheContext::getCacheableMetadata in core/lib/Drupal/Core/Cache/Context/PathCacheContext.php
Gets the cacheability metadata for the context.

... See full list

File

core/lib/Drupal/Core/Cache/Context/CacheContextInterface.php, line 44

Class

CacheContextInterface
Provides an interface for defining a cache context service.

Namespace

Drupal\Core\Cache\Context

Code

public function getCacheableMetadata();