public static function EntityReferenceHierarchy::getPreconfiguredOptions in Entity Reference Hierarchy 3.x
Same name and namespace in other branches
- 8.2 src/Plugin/Field/FieldType/EntityReferenceHierarchy.php \Drupal\entity_hierarchy\Plugin\Field\FieldType\EntityReferenceHierarchy::getPreconfiguredOptions()
Returns preconfigured field options for a field type.
Note that if you want to give modules an opportunity to alter the result of this method, you should call \Drupal\Core\Field\FieldTypePluginManagerInterface::getPreconfiguredOptions() instead.
Return value
mixed[][] A multi-dimensional array with string keys and the following structure:
- label: The label to show in the field type selection list.
- category: (optional) The category in which to put the field label. Defaults to the category of the field type.
- field_storage_config: An array with the following supported keys:
- cardinality: The field cardinality.
- settings: Field-type specific storage settings.
- field_config: An array with the following supported keys:
- required: Indicates whether the field is required.
- settings: Field-type specific settings.
- entity_form_display: An array with the following supported keys:
- type: The widget to be used in the 'default' form mode.
- entity_view_display: An array with the following supported keys:
- type: The formatter to be used in the 'default' view mode.
Overrides EntityReferenceItem::getPreconfiguredOptions
See also
\Drupal\field\Entity\FieldStorageConfig
\Drupal\field\Entity\FieldConfig
\Drupal\Core\Entity\Display\EntityDisplayInterface::setComponent()
\Drupal\Core\Field\FieldTypePluginManagerInterface::getPreconfiguredOptions()
File
- src/
Plugin/ Field/ FieldType/ EntityReferenceHierarchy.php, line 111
Class
- EntityReferenceHierarchy
- Plugin implementation of the 'entity_reference_hierarchy' field type.
Namespace
Drupal\entity_hierarchy\Plugin\Field\FieldTypeCode
public static function getPreconfiguredOptions() {
// In the base EntityReference class, this is used to populate the
// list of field-types with options for each destination entity type.
// Too much work, we'll just make people fill that out later.
// Also, keeps the field type dropdown from getting too cluttered.
return [];
}