function FieldStorageDefinitionInterface::getMainPropertyName

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

Returns the name of the main property, if any.

Some field items consist mainly of one main property, e.g. the value of a text field or the 

target_id;

of an entity reference. If the field item has no main property, the method returns NULL.

Return value

string|null The name of the value property, or NULL if there is none.

2 methods override FieldStorageDefinitionInterface::getMainPropertyName()
BaseFieldDefinition::getMainPropertyName in core/lib/Drupal/Core/Field/BaseFieldDefinition.php
Returns the name of the main property, if any.
FieldStorageConfig::getMainPropertyName in core/modules/field/src/Entity/FieldStorageConfig.php
Returns the name of the main property, if any.

File

core/lib/Drupal/Core/Field/FieldStorageDefinitionInterface.php, line 209

Class

FieldStorageDefinitionInterface
Defines an interface for entity field storage definitions.

Namespace

Drupal\Core\Field

Code

public function getMainPropertyName();

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