function CacheableDependencyInterface::getCacheContexts

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Cache/CacheableDependencyInterface.php \Drupal\Core\Cache\CacheableDependencyInterface::getCacheContexts()
  2. 10 core/lib/Drupal/Core/Cache/CacheableDependencyInterface.php \Drupal\Core\Cache\CacheableDependencyInterface::getCacheContexts()
  3. 11.x core/lib/Drupal/Core/Cache/CacheableDependencyInterface.php \Drupal\Core\Cache\CacheableDependencyInterface::getCacheContexts()

The cache contexts associated with this object.

These identify a specific variation/representation of the object.

Cache contexts are tokens: placeholders that are converted to cache keys by the @cache_contexts_manager service. The replacement value depends on the request context (the current URL, language, and so on). They're converted before storing an object in cache.

Return value

string[] An array of cache context tokens, used to generate a cache ID.

See also

\Drupal\Core\Cache\Context\CacheContextsManager::convertTokensToKeys()

34 methods override CacheableDependencyInterface::getCacheContexts()
ArgumentPluginBase::getCacheContexts in core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php
The cache contexts associated with this object.
BulkForm::getCacheContexts in core/modules/views/src/Plugin/views/field/BulkForm.php
The cache contexts associated with this object.
CacheableMetadataCalculationTest::getCacheContexts in core/modules/views/tests/modules/views_test_cacheable_metadata_calculation/src/Plugin/views/access/CacheableMetadataCalculationTest.php
The cache contexts associated with this object.
ComputedString::getCacheContexts in core/modules/system/tests/modules/entity_test/src/TypedData/ComputedString.php
The cache contexts associated with this object.
Context::getCacheContexts in core/lib/Drupal/Core/Plugin/Context/Context.php
The cache contexts associated with this object.

... See full list

File

core/lib/Drupal/Core/Cache/CacheableDependencyInterface.php, line 32

Class

CacheableDependencyInterface
Defines an interface for objects which may be used by other cached objects.

Namespace

Drupal\Core\Cache

Code

public function getCacheContexts();

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.