function FieldItemInterface::mainPropertyName

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

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.

See also

\Drupal\Core\Field\BaseFieldDefinition

1 method overrides FieldItemInterface::mainPropertyName()
FieldItemBase::mainPropertyName in core/lib/Drupal/Core/Field/FieldItemBase.php
Returns the name of the main property, if any.

File

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

Class

FieldItemInterface
Interface for entity field items.

Namespace

Drupal\Core\Field

Code

public static function mainPropertyName();

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