function CalculatedCacheContextInterface::getCacheableMetadata
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Cache/Context/CalculatedCacheContextInterface.php \Drupal\Core\Cache\Context\CalculatedCacheContextInterface::getCacheableMetadata()
- 10 core/lib/Drupal/Core/Cache/Context/CalculatedCacheContextInterface.php \Drupal\Core\Cache\Context\CalculatedCacheContextInterface::getCacheableMetadata()
- 11.x core/lib/Drupal/Core/Cache/Context/CalculatedCacheContextInterface.php \Drupal\Core\Cache\Context\CalculatedCacheContextInterface::getCacheableMetadata()
Gets the cacheability metadata for the context based on the parameter value.
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.
Parameters
string|null $parameter: The parameter, or NULL to indicate all possible parameter values.
Return value
\Drupal\Core\Cache\CacheableMetadata A cacheable metadata object.
Throws
\LogicException Thrown if the passed in parameter is invalid.
10 methods override CalculatedCacheContextInterface::getCacheableMetadata()
- BazCacheContext::getCacheableMetadata in core/
tests/ Drupal/ Tests/ Core/ Cache/ Context/ CacheContextsManagerTest.php - Gets the cacheability metadata for the context based on the parameter value.
- CookiesCacheContext::getCacheableMetadata in core/
lib/ Drupal/ Core/ Cache/ Context/ CookiesCacheContext.php - Gets the cacheability metadata for the context based on the parameter value.
- HeadersCacheContext::getCacheableMetadata in core/
lib/ Drupal/ Core/ Cache/ Context/ HeadersCacheContext.php - Gets the cacheability metadata for the context based on the parameter value.
- LanguagesCacheContext::getCacheableMetadata in core/
lib/ Drupal/ Core/ Cache/ Context/ LanguagesCacheContext.php - Gets the cacheability metadata for the context based on the parameter value.
- LayoutBuilderIsActiveCacheContext::getCacheableMetadata in core/
modules/ layout_builder/ src/ Cache/ LayoutBuilderIsActiveCacheContext.php - Gets the cacheability metadata for the context based on the parameter value.
File
-
core/
lib/ Drupal/ Core/ Cache/ Context/ CalculatedCacheContextInterface.php, line 58
Class
- CalculatedCacheContextInterface
- Provides an interface for defining a calculated cache context service.
Namespace
Drupal\Core\Cache\ContextCode
public function getCacheableMetadata($parameter = NULL);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.