function FieldItemInterface::storageSettingsForm
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::storageSettingsForm()
- 10 core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::storageSettingsForm()
- 11.x core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::storageSettingsForm()
Returns a form for the storage-level settings.
Invoked from \Drupal\field_ui\Form\FieldStorageConfigEditForm to allow administrators to configure storage-level settings.
Field storage might reject settings changes that affect the field storage schema if the storage already has data. When the $has_data parameter is TRUE, the form should not allow changing the settings that take part in the schema() method. It is recommended to set #access to FALSE on the corresponding elements.
Parameters
array $form: The form where the settings form is being included in.
\Drupal\Core\Form\FormStateInterface $form_state: The form state of the (entire) configuration form.
bool $has_data: TRUE if the field already has data, FALSE if not.
Return value
array The form definition for the field settings.
1 method overrides FieldItemInterface::storageSettingsForm()
- FieldItemBase::storageSettingsForm in core/
lib/ Drupal/ Core/ Field/ FieldItemBase.php - Returns a form for the storage-level settings.
File
-
core/
lib/ Drupal/ Core/ Field/ FieldItemInterface.php, line 370
Class
- FieldItemInterface
- Interface for entity field items.
Namespace
Drupal\Core\FieldCode
public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.