function FieldItemDataDefinition::getMainPropertyName

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php \Drupal\Core\Field\TypedData\FieldItemDataDefinition::getMainPropertyName()
  2. 8.9.x core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php \Drupal\Core\Field\TypedData\FieldItemDataDefinition::getMainPropertyName()
  3. 10 core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php \Drupal\Core\Field\TypedData\FieldItemDataDefinition::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.

Overrides ComplexDataDefinitionInterface::getMainPropertyName

File

core/lib/Drupal/Core/Field/TypedData/FieldItemDataDefinition.php, line 71

Class

FieldItemDataDefinition
A typed data definition class for defining field items.

Namespace

Drupal\Core\Field\TypedData

Code

public function getMainPropertyName() {
  return $this->fieldDefinition
    ->getFieldStorageDefinition()
    ->getMainPropertyName();
}

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