function CacheableDependencyInterface::getCacheContexts

Same name and namespace in other branches
  1. 11.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. 8.9.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()

1 method overrides CacheableDependencyInterface::getCacheContexts()
MediaLibraryState::getCacheContexts in core/modules/media_library/src/MediaLibraryState.php
The cache contexts associated with this object.

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.