function CacheContextInterface::getCacheableMetadata
Same name in other branches
- 9 core/lib/Drupal/Core/Cache/Context/CacheContextInterface.php \Drupal\Core\Cache\Context\CacheContextInterface::getCacheableMetadata()
- 8.9.x core/lib/Drupal/Core/Cache/Context/CacheContextInterface.php \Drupal\Core\Cache\Context\CacheContextInterface::getCacheableMetadata()
- 10 core/lib/Drupal/Core/Cache/Context/CacheContextInterface.php \Drupal\Core\Cache\Context\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.
22 methods override CacheContextInterface::getCacheableMetadata()
- AccountPermissionsCacheContext::getCacheableMetadata in core/
lib/ Drupal/ Core/ Cache/ Context/ AccountPermissionsCacheContext.php - Gets the cacheability metadata for the context.
- BookNavigationCacheContext::getCacheableMetadata in core/
modules/ book/ src/ Cache/ BookNavigationCacheContext.php - Gets the cacheability metadata for the context.
- ConfigOverrideIntegrationTestCacheContext::getCacheableMetadata in core/
modules/ config/ tests/ config_override_integration_test/ src/ Cache/ ConfigOverrideIntegrationTestCacheContext.php - EntityTestViewGrantsCacheContext::getCacheableMetadata in core/
modules/ system/ tests/ modules/ entity_test/ src/ Cache/ EntityTestViewGrantsCacheContext.php - Gets the cacheability metadata for the context.
- FooCacheContext::getCacheableMetadata in core/
tests/ Drupal/ Tests/ Core/ Cache/ Context/ CacheContextsManagerTest.php - Gets the cacheability metadata for the context.
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\ContextCode
public function getCacheableMetadata();Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.