public function SortPluginBase::getCacheContexts in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/views/src/Plugin/views/sort/SortPluginBase.php \Drupal\views\Plugin\views\sort\SortPluginBase::getCacheContexts()
2. 9 core/modules/views/src/Plugin/views/sort/SortPluginBase.php \Drupal\views\Plugin\views\sort\SortPluginBase::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.

Overrides CacheableDependencyInterface::getCacheContexts

See also

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

File

core/modules/views/src/Plugin/views/sort/SortPluginBase.php, line 289

Class

SortPluginBase

Base sort handler that has no options and performs a simple sort.

Namespace

Drupal\views\Plugin\views\sort

Code

public function getCacheContexts() {
  $cache_contexts = [];

  // Exposed sorts use GET parameters, so it depends on the current URL.
  if ($this
    ->isExposed()) {
    $cache_contexts[] = 'url.query_args:sort_by';
  }
  return $cache_contexts;
}