5 * Install, update and uninstall functions for the field module.
8 use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
9 use Drupal\field\Entity\FieldConfig;
10 use Drupal\field\Entity\FieldStorageConfig;
13 * Removes the stale 'target_bundle' storage setting on entity_reference fields.
15 function field_update_8001() {
16 $config = \Drupal::configFactory();
17 /** @var \Drupal\Core\Field\FieldTypePluginManager $field_type_manager */
18 $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
20 // Iterate on all fields storage.
21 foreach ($config->listAll('field.storage.') as $field_id) {
22 $field_storage = $config->getEditable($field_id);
23 $class = $field_type_manager->getPluginClass($field_storage->get('type'));
25 // Deal only with entity reference fields and descendants.
26 if ($class == EntityReferenceItem::class || is_subclass_of($class, EntityReferenceItem::class)) {
27 // Remove 'target_bundle' from settings.
28 $field_storage->clear('settings.target_bundle')->save(TRUE);
34 * The 'entity_reference' field type is now provided by core.
36 function field_update_8002() {
37 $config_factory = \Drupal::configFactory();
39 // Iterate on all configuration entities.
40 foreach ($config_factory->listAll() as $id) {
42 $config = $config_factory->getEditable($id);
44 // Update field storage configurations.
45 if (strpos($id, 'field.storage.') === 0) {
46 // Deal only with entity reference fields.
47 if ($config->get('type') == 'entity_reference') {
48 // Fix the type provider.
49 $config->set('module', 'core');
54 // Remove entity_reference module dependency from any configuration entity.
55 if ($dependencies = $config->get('dependencies.module')) {
56 if (($delta = array_search('entity_reference', $dependencies)) !== FALSE) {
57 unset($dependencies[$delta]);
59 $config->set('dependencies.module', array_values($dependencies));
62 $config->clear('dependencies.module');
75 * Populate the new 'auto_create_bundle' setting for entity reference fields.
77 function field_update_8003() {
78 $config = \Drupal::configFactory();
79 /** @var \Drupal\Core\Field\FieldTypePluginManager $field_type_manager */
80 $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
82 // Iterate over all fields.
83 foreach ($config->listAll('field.field.') as $field_id) {
84 $field = $config->getEditable($field_id);
85 $class = $field_type_manager->getPluginClass($field->get('field_type'));
87 // Deal only with entity reference fields and descendants.
88 if ($class == EntityReferenceItem::class || is_subclass_of($class, EntityReferenceItem::class)) {
89 $handler_settings = $field->get('settings.handler_settings');
91 if (is_array($handler_settings) && !empty($handler_settings['auto_create'])) {
92 // If the field can reference multiple bundles, pick the first one
93 // available in order to replicate the previous behavior.
94 if (is_array($handler_settings['target_bundles']) && count($handler_settings['target_bundles']) > 1) {
95 $handler_settings['auto_create_bundle'] = reset($handler_settings['target_bundles']);
97 // Otherwise, we don't know which bundle to use for auto-creation so we
98 // have to disable the functionality completely.
99 elseif (!$handler_settings['target_bundles']) {
100 $handler_settings['auto_create'] = FALSE;
101 $handler_settings['auto_create_bundle'] = NULL;
105 $field->set('settings.handler_settings', $handler_settings)->save(TRUE);
111 * Update the definition of deleted fields.
113 function field_update_8500() {
114 $state = \Drupal::state();
116 // Convert the old deleted field definitions from an array to a FieldConfig
118 $deleted_field_definitions = $state->get('field.field.deleted', []);
119 foreach ($deleted_field_definitions as $key => $deleted_field_definition) {
120 if (is_array($deleted_field_definition)) {
121 $deleted_field_definitions[$key] = new FieldConfig($deleted_field_definition);
124 $state->set('field.field.deleted', $deleted_field_definitions);
126 // Convert the old deleted field storage definitions from an array to a
127 // FieldStorageConfig object.
128 $deleted_field_storage_definitions = $state->get('field.storage.deleted', []);
129 foreach ($deleted_field_storage_definitions as $key => $deleted_field_storage_definition) {
130 if (is_array($deleted_field_storage_definition)) {
131 $deleted_field_storage_definitions[$key] = new FieldStorageConfig($deleted_field_storage_definition);
134 $state->set('field.storage.deleted', $deleted_field_storage_definitions);