function FieldItemInterface::calculateDependencies

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::calculateDependencies()
  2. 8.9.x core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::calculateDependencies()
  3. 10 core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::calculateDependencies()

Calculates dependencies for field items.

Dependencies are saved in the field configuration entity and are used to determine configuration synchronization order. For example, if the field type's default value is a content entity, this method should return an array of dependencies listing the content entities.

Parameters

\Drupal\Core\Field\FieldDefinitionInterface $field_definition: The field definition.

Return value

array An array of dependencies grouped by type (config, content, module, theme). For example:

[
    'config' => [
        'user.role.anonymous',
        'user.role.authenticated',
    ],
    'content' => [
        'node:article:f0a189e6-55fb-47fb-8005-5bef81c44d6d',
    ],
    'module' => [
        'node',
        'user',
    ],
    'theme' => [
        'claro',
    ],
];

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

\Drupal\Core\Config\Entity\ConfigEntityInterface::getConfigDependencyName()

1 method overrides FieldItemInterface::calculateDependencies()
FieldItemBase::calculateDependencies in core/lib/Drupal/Core/Field/FieldItemBase.php
Calculates dependencies for field items.

File

core/lib/Drupal/Core/Field/FieldItemInterface.php, line 449

Class

FieldItemInterface
Interface for entity field items.

Namespace

Drupal\Core\Field

Code

public static function calculateDependencies(FieldDefinitionInterface $field_definition);

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