field.schema.yml

Same filename and directory in other branches
  1. 11.x core/modules/field/config/schema/field.schema.yml
  2. 10 core/modules/field/config/schema/field.schema.yml
  3. 9 core/modules/field/config/schema/field.schema.yml
  4. 8.9.x core/modules/field/config/schema/field.schema.yml
core/modules/field/config/schema/field.schema.yml

File

core/modules/field/config/schema/field.schema.yml

View source
  1. # Schema for configuration files of the Field module.
  2. field.settings:
  3. type: config_object
  4. label: 'Field settings'
  5. deprecated: "The 'field.settings' config is deprecated in drupal:11.4.0 and is removed from drupal:13.0.0. Use the field_purge_batch_size setting instead. See https://www.drupal.org/node/3494023."
  6. constraints:
  7. FullyValidatable: ~
  8. mapping:
  9. purge_batch_size:
  10. type: integer
  11. label: 'Maximum number of field data records to purge'
  12. constraints:
  13. NotNull: []
  14. Range:
  15. min: 1
  16. field.storage.*.*:
  17. type: config_entity
  18. label: 'Field'
  19. mapping:
  20. id:
  21. type: string
  22. label: 'ID'
  23. field_name:
  24. type: string
  25. label: 'Field name'
  26. entity_type:
  27. type: string
  28. label: 'Entity type'
  29. type:
  30. type: string
  31. label: 'Type'
  32. constraints:
  33. PluginExists:
  34. manager: plugin.manager.field.field_type
  35. interface: '\Drupal\Core\Field\FieldItemInterface'
  36. settings:
  37. type: field.storage_settings.[%parent.type]
  38. module:
  39. type: string
  40. label: 'Module'
  41. locked:
  42. type: boolean
  43. label: 'Locked'
  44. cardinality:
  45. type: integer
  46. label: 'Maximum number of values users can enter'
  47. constraints:
  48. NoFieldItemsExistWithHigherCardinality:
  49. entityType: '%parent.entity_type'
  50. fieldName: '%parent.field_name'
  51. translatable:
  52. type: boolean
  53. label: 'Translatable'
  54. indexes:
  55. type: sequence
  56. label: 'Indexes'
  57. constraints:
  58. FieldStorageIndexes: ~
  59. sequence:
  60. type: sequence
  61. label: 'Indexes'
  62. sequence:
  63. type: ignore
  64. label: 'Index'
  65. persist_with_no_fields:
  66. type: boolean
  67. label: 'Persist field storage with no fields'
  68. custom_storage:
  69. type: boolean
  70. label: 'Enable custom storage'
  71. field.field.*.*.*:
  72. type: field_config_base
  73. label: 'Field'
  74. constraints:
  75. FullyValidatable: ~

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.