function Cache::mergeTags

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

Merges arrays of cache tags and removes duplicates.

The cache tags array is returned in a format that is valid for \Drupal\Core\Cache\CacheBackendInterface::set().

When caching elements, it is necessary to collect all cache tags into a single array, from both the element itself and all child elements. This allows items to be invalidated based on all tags attached to the content they're constituted from.

Parameters

string[] ...: Cache tags arrays to merge.

Return value

string[] The merged array of cache tags.

67 calls to Cache::mergeTags()
ArgumentPluginBase::getCacheTags in core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php
The cache tags associated with this object.
AssertPageCacheContextsAndTagsTrait::assertCacheTags in core/modules/system/tests/src/Functional/Cache/AssertPageCacheContextsAndTagsTrait.php
Ensures that some cache tags are present in the current response.
BlockContentCacheTagsTest::testBlock in core/modules/block_content/tests/src/Functional/BlockContentCacheTagsTest.php
Tests that the block is cached with the correct contexts and tags.
BlockContentResourceTestBase::getExpectedCacheTags in core/modules/block_content/tests/src/Functional/Rest/BlockContentResourceTestBase.php
The expected cache tags for the GET/HEAD response of the test entity.
BlockContentTest::getExpectedCacheTags in core/modules/jsonapi/tests/src/Functional/BlockContentTest.php
The expected cache tags for the GET/HEAD response of the test entity.

... See full list

File

core/lib/Drupal/Core/Cache/Cache.php, line 52

Class

Cache
Helper methods for cache.

Namespace

Drupal\Core\Cache

Code

public static function mergeTags(array ...$cache_tags) {
    $cache_tags = array_unique(array_merge(...$cache_tags));
    assert(Inspector::assertAllStrings($cache_tags), 'Cache tags must be valid strings');
    return $cache_tags;
}

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