function FieldItemInterface::storageSettingsSummary
Same name in other branches
- 11.x core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::storageSettingsSummary()
Returns a short summary of the field's storage-level settings.
All information returned by this function should communicate fundamental information about the field storage settings for users. For example, in the case of a reference field, the configured target entity type is a crucial piece of information for understanding how the field can be used.
Parameters
\Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition: The field storage definition.
Return value
array A renderable array summarizing storage-level settings.
1 method overrides FieldItemInterface::storageSettingsSummary()
- FieldItemBase::storageSettingsSummary in core/
lib/ Drupal/ Core/ Field/ FieldItemBase.php - Returns a short summary of the field's storage-level settings.
File
-
core/
lib/ Drupal/ Core/ Field/ FieldItemInterface.php, line 279
Class
- FieldItemInterface
- Interface for entity field items.
Namespace
Drupal\Core\FieldCode
public static function storageSettingsSummary(FieldStorageDefinitionInterface $storage_definition) : array;
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.