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