core.entity.schema.yml

Same filename in other branches
  1. 9 core/config/schema/core.entity.schema.yml
  2. 8.9.x core/config/schema/core.entity.schema.yml
  3. 10 core/config/schema/core.entity.schema.yml
core/config/schema/core.entity.schema.yml

File

core/config/schema/core.entity.schema.yml

View source
  1. # Schema for Configuration files of the entity module.
  2. core.entity_view_mode.*.*:
  3. type: config_entity
  4. label: 'Entity view mode settings'
  5. mapping:
  6. id:
  7. type: string
  8. label: 'ID'
  9. label:
  10. type: required_label
  11. label: 'The human-readable name of the view mode'
  12. description:
  13. type: text
  14. label: 'Description'
  15. targetEntityType:
  16. type: string
  17. label: 'Target entity type'
  18. cache:
  19. type: boolean
  20. label: 'Cached'
  21. core.entity_form_mode.*.*:
  22. type: config_entity
  23. label: 'Entity form mode settings'
  24. mapping:
  25. id:
  26. type: string
  27. label: 'ID'
  28. label:
  29. type: required_label
  30. label: 'Label'
  31. description:
  32. type: text
  33. label: 'Description'
  34. targetEntityType:
  35. type: string
  36. label: 'Target entity type'
  37. cache:
  38. type: boolean
  39. label: 'Cache'
  40. # Overview configuration information for view mode or form mode displays.
  41. core.entity_view_display.*.*.*:
  42. type: config_entity
  43. label: 'Entity display'
  44. mapping:
  45. id:
  46. type: string
  47. label: 'ID'
  48. targetEntityType:
  49. type: string
  50. label: 'Target entity type'
  51. bundle:
  52. type: string
  53. label: 'Bundle'
  54. constraints:
  55. EntityBundleExists: '%parent.targetEntityType'
  56. mode:
  57. type: string
  58. label: 'View or form mode machine name'
  59. content:
  60. type: sequence
  61. label: 'Field formatters'
  62. sequence:
  63. type: field_formatter.entity_view_display
  64. hidden:
  65. type: sequence
  66. label: 'Field display setting'
  67. sequence:
  68. type: boolean
  69. label: 'Value'
  70. field_formatter:
  71. type: mapping
  72. label: 'Field formatter'
  73. mapping:
  74. type:
  75. type: string
  76. label: 'Format type machine name'
  77. constraints:
  78. PluginExists:
  79. manager: plugin.manager.field.formatter
  80. interface: 'Drupal\Core\Field\FormatterInterface'
  81. label:
  82. type: string
  83. label: 'Label setting machine name'
  84. settings:
  85. type: field.formatter.settings.[%parent.type]
  86. label: 'Settings'
  87. third_party_settings:
  88. # Third party settings are always optional: they're an optional extension
  89. # point.
  90. requiredKey: false
  91. type: sequence
  92. label: 'Third party settings'
  93. sequence:
  94. type: field.formatter.third_party.[%key]
  95. field_formatter.entity_view_display:
  96. type: field_formatter
  97. mapping:
  98. weight:
  99. type: weight
  100. label: 'Weight'
  101. region:
  102. type: string
  103. label: 'Region'
  104. # Overview configuration information for form mode displays.
  105. core.entity_form_display.*.*.*:
  106. type: config_entity
  107. label: 'Entity form display'
  108. mapping:
  109. id:
  110. type: string
  111. label: 'ID'
  112. targetEntityType:
  113. type: string
  114. label: 'Target entity type'
  115. bundle:
  116. type: string
  117. label: 'Bundle'
  118. constraints:
  119. EntityBundleExists: '%parent.targetEntityType'
  120. mode:
  121. type: string
  122. label: 'View or form mode machine name'
  123. status:
  124. type: boolean
  125. label: 'Enabled'
  126. content:
  127. type: sequence
  128. label: 'Field widgets'
  129. sequence:
  130. type: mapping
  131. label: 'Field widget'
  132. mapping:
  133. type:
  134. type: string
  135. label: 'Widget type machine name'
  136. constraints:
  137. PluginExists:
  138. manager: plugin.manager.field.widget
  139. interface: '\Drupal\Core\Field\WidgetInterface'
  140. weight:
  141. type: weight
  142. label: 'Weight'
  143. region:
  144. type: string
  145. label: 'Region'
  146. settings:
  147. type: field.widget.settings.[%parent.type]
  148. label: 'Settings'
  149. third_party_settings:
  150. # Third party settings are always optional: they're an optional extension
  151. # point.
  152. requiredKey: false
  153. type: sequence
  154. label: 'Third party settings'
  155. sequence:
  156. type: field.widget.third_party.[%key]
  157. hidden:
  158. type: sequence
  159. label: 'Hidden'
  160. sequence:
  161. type: boolean
  162. label: 'Component'
  163. # Default schema for entity display field with undefined type.
  164. field.formatter.settings.*:
  165. type: mapping
  166. # Default schema for entity form display field with undefined type.
  167. field.widget.settings.*:
  168. type: mapping
  169. field.widget.settings.string_textfield:
  170. type: mapping
  171. label: 'Text field display format settings'
  172. mapping:
  173. size:
  174. type: integer
  175. label: 'Size of textfield'
  176. placeholder:
  177. type: label
  178. label: 'Placeholder'
  179. field.widget.settings.string_textarea:
  180. type: mapping
  181. label: 'Textarea display format settings'
  182. mapping:
  183. rows:
  184. type: integer
  185. label: 'Rows'
  186. placeholder:
  187. type: label
  188. label: 'Placeholder'
  189. field.widget.settings.uri:
  190. type: mapping
  191. label: 'URI field'
  192. mapping:
  193. size:
  194. type: integer
  195. label: 'Size of URI field'
  196. placeholder:
  197. type: label
  198. label: 'Placeholder'
  199. field.widget.settings.email_default:
  200. type: mapping
  201. label: 'Email field display format settings'
  202. mapping:
  203. placeholder:
  204. type: label
  205. label: 'Placeholder'
  206. size:
  207. type: integer
  208. label: 'Size of email field'
  209. field.widget.settings.datetime_timestamp:
  210. type: mapping
  211. label: 'Datetime timestamp display format settings'
  212. field.widget.settings.boolean_checkbox:
  213. type: mapping
  214. label: 'Boolean checkbox display format settings'
  215. mapping:
  216. display_label:
  217. type: boolean
  218. label: 'Display label'
  219. field.widget.settings.hidden:
  220. type: mapping
  221. label: '- Hidden - format settings'
  222. field.widget.settings.number:
  223. type: mapping
  224. label: 'Number default display format settings'
  225. mapping:
  226. placeholder:
  227. type: label
  228. label: 'Placeholder'
  229. field.widget.settings.checkbox:
  230. type: mapping
  231. label: 'Single on/off checkbox format settings'
  232. mapping:
  233. display_label:
  234. type: boolean
  235. label: 'Use field label instead of the "On value" as label'
  236. field.widget.settings.language_select:
  237. type: mapping
  238. label: 'Language format settings'
  239. mapping:
  240. include_locked:
  241. type: boolean
  242. label: 'Include locked languages'
  243. field.widget.settings.entity_reference_autocomplete_tags:
  244. type: mapping
  245. label: 'Entity reference autocomplete (Tags style) display format settings'
  246. mapping:
  247. match_operator:
  248. type: string
  249. label: 'Autocomplete matching'
  250. match_limit:
  251. type: integer
  252. label: 'Maximum number of autocomplete suggestions.'
  253. size:
  254. type: integer
  255. label: 'Size of textfield'
  256. placeholder:
  257. type: label
  258. label: 'Placeholder'
  259. field.widget.settings.entity_reference_autocomplete:
  260. type: mapping
  261. label: 'Entity reference autocomplete display format settings'
  262. mapping:
  263. match_operator:
  264. type: string
  265. label: 'Autocomplete matching'
  266. match_limit:
  267. type: integer
  268. label: 'Maximum number of autocomplete suggestions.'
  269. size:
  270. type: integer
  271. label: 'Size of textfield'
  272. placeholder:
  273. type: label
  274. label: 'Placeholder'
  275. field.formatter.settings.boolean:
  276. type: mapping
  277. mapping:
  278. format:
  279. type: string
  280. label: 'Output format'
  281. format_custom_false:
  282. type: label
  283. label: 'Custom output for FALSE'
  284. format_custom_true:
  285. type: label
  286. label: 'Custom output for TRUE'
  287. field.formatter.settings.string:
  288. type: mapping
  289. mapping:
  290. link_to_entity:
  291. type: boolean
  292. label: 'Link to the entity'
  293. field.formatter.settings.language:
  294. type: field.formatter.settings.string
  295. mapping:
  296. native_language:
  297. type: boolean
  298. label: 'Display in native language'
  299. field.formatter.settings.number_decimal:
  300. type: mapping
  301. label: 'Number decimal display format settings'
  302. mapping:
  303. thousand_separator:
  304. type: string
  305. label: 'Thousand marker'
  306. decimal_separator:
  307. type: string
  308. label: 'Decimal marker'
  309. scale:
  310. type: integer
  311. label: 'Scale'
  312. prefix_suffix:
  313. type: boolean
  314. label: 'Display prefix and suffix.'
  315. field.formatter.settings.number_integer:
  316. type: mapping
  317. label: 'Number integer display format settings'
  318. mapping:
  319. thousand_separator:
  320. type: string
  321. label: 'Thousand marker'
  322. prefix_suffix:
  323. type: boolean
  324. label: 'Display prefix and suffix.'
  325. field.formatter.settings.number_unformatted:
  326. type: mapping
  327. label: 'Number unformatted display format settings'
  328. field.formatter.settings.uri_link:
  329. type: mapping
  330. label: 'URI as link display format settings'
  331. field.formatter.settings.timestamp:
  332. type: mapping
  333. label: 'Timestamp display format settings'
  334. mapping:
  335. date_format:
  336. type: string
  337. label: 'Date format'
  338. custom_date_format:
  339. type: string
  340. label: 'Custom date format'
  341. timezone:
  342. type: string
  343. label: 'Time zone'
  344. tooltip:
  345. type: mapping
  346. label: Tooltip
  347. mapping:
  348. date_format:
  349. type: string
  350. label: 'Tooltip date format'
  351. custom_date_format:
  352. type: string
  353. label: 'Tooltip custom date format'
  354. time_diff:
  355. type: mapping
  356. label: 'Time difference'
  357. mapping:
  358. enabled:
  359. type: boolean
  360. label: 'Show as time difference'
  361. future_format:
  362. type: string
  363. label: 'Future format'
  364. past_format:
  365. type: string
  366. label: 'Past format'
  367. granularity:
  368. type: integer
  369. label: 'Time units'
  370. refresh:
  371. type: integer
  372. label: 'Refresh interval in seconds'
  373. field.formatter.settings.timestamp_ago:
  374. type: mapping
  375. label: 'Timestamp ago display format settings'
  376. mapping:
  377. future_format:
  378. type: required_label
  379. label: 'Future format'
  380. past_format:
  381. type: required_label
  382. label: 'Past format'
  383. granularity:
  384. type: integer
  385. label: 'Granularity'
  386. field.formatter.settings.entity_reference_entity_view:
  387. type: mapping
  388. label: 'Entity reference rendered entity display format settings'
  389. mapping:
  390. view_mode:
  391. type: string
  392. label: 'View mode'
  393. link:
  394. type: boolean
  395. label: 'Show links'
  396. field.formatter.settings.entity_reference_entity_id:
  397. type: mapping
  398. label: 'Entity reference entity ID display format settings'
  399. field.formatter.settings.entity_reference_label:
  400. type: mapping
  401. label: 'Entity reference label display format settings'
  402. mapping:
  403. link:
  404. type: boolean
  405. label: 'Link label to the referenced entity'
  406. block.settings.field_block:*:*:*:
  407. type: block_settings
  408. mapping:
  409. formatter:
  410. type: field_formatter
  411. block.settings.extra_field_block:*:*:*:
  412. type: block_settings
  413. mapping:
  414. formatter:
  415. type: field_formatter
  416. # Schema for entity actions.
  417. action.configuration.entity:*:*:
  418. type: action_configuration_default
  419. label: 'Entity action'
  420. action.configuration.action_send_email_action:
  421. type: mapping
  422. label: 'Send email configuration'
  423. mapping:
  424. recipient:
  425. type: string
  426. label: 'Recipient'
  427. subject:
  428. type: label
  429. label: 'Subject'
  430. message:
  431. type: text
  432. label: 'Message'
  433. action.configuration.action_goto_action:
  434. type: mapping
  435. label: 'Redirect to URL configuration'
  436. mapping:
  437. url:
  438. type: string
  439. label: 'URL'
  440. action.configuration.action_message_action:
  441. type: mapping
  442. label: 'Display a message to the user configuration'
  443. mapping:
  444. message:
  445. type: text
  446. label: 'Message'

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