function EntityDefinitionUpdateManagerInterface::getFieldStorageDefinition

Same name in other branches
  1. 9 core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface::getFieldStorageDefinition()
  2. 8.9.x core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface::getFieldStorageDefinition()
  3. 10 core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface::getFieldStorageDefinition()

Returns a field storage definition ready to be manipulated.

When needing to apply updates to existing field storage definitions, this method should always be used to retrieve a storage definition ready to be manipulated.

@todo Make this return a mutable storage definition interface when we have one. See https://www.drupal.org/node/2346329.

Parameters

string $name: The field name.

string $entity_type_id: The entity type identifier.

Return value

\Drupal\Core\Field\FieldStorageDefinitionInterface|null The field storage definition or NULL if there is none for the given field name and entity type.

1 method overrides EntityDefinitionUpdateManagerInterface::getFieldStorageDefinition()
EntityDefinitionUpdateManager::getFieldStorageDefinition in core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManager.php
Returns a field storage definition ready to be manipulated.

File

core/lib/Drupal/Core/Entity/EntityDefinitionUpdateManagerInterface.php, line 194

Class

EntityDefinitionUpdateManagerInterface
Defines an interface for managing entity definition updates.

Namespace

Drupal\Core\Entity

Code

public function getFieldStorageDefinition($name, $entity_type_id);

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