You are here

Home » API reference » Drupal 9

core.entity.schema.yml in Drupal 9

Same filename and directory in other branches
  1. 8 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. 

  3. core.entity_view_mode.*.*:

  4.   type: config_entity

  5.   label: 'Entity view mode settings'

  6.   mapping:

  7.     id:

  8.       type: string

  9.       label: 'ID'

  10.     label:

  11.       type: label

  12.       label: 'The human-readable name of the view mode'

  13.     targetEntityType:

  14.       type: string

  15.       label: 'Target entity type'

  16.     cache:

  17.       type: boolean

  18.       label: 'Cached'

  19. 

  20. core.entity_form_mode.*.*:

  21.   type: config_entity

  22.   label: 'Entity form mode settings'

  23.   mapping:

  24.     id:

  25.       type: string

  26.       label: 'ID'

  27.     label:

  28.       type: label

  29.       label: 'Label'

  30.     targetEntityType:

  31.       type: string

  32.       label: 'Target entity type'

  33.     cache:

  34.       type: boolean

  35.       label: 'Cache'

  36. 

  37. # Overview configuration information for view mode or form mode displays.

  38. core.entity_view_display.*.*.*:

  39.   type: config_entity

  40.   label: 'Entity display'

  41.   mapping:

  42.     id:

  43.       type: string

  44.       label: 'ID'

  45.     targetEntityType:

  46.       type: string

  47.       label: 'Target entity type'

  48.     bundle:

  49.       type: string

  50.       label: 'Bundle'

  51.     mode:

  52.       type: string

  53.       label: 'View or form mode machine name'

  54.     content:

  55.       type: sequence

  56.       label: 'Field formatters'

  57.       sequence:

  58.         type: field_formatter.entity_view_display

  59.     hidden:

  60.       type: sequence

  61.       label: 'Field display setting'

  62.       sequence:

  63.         type: boolean

  64.         label: 'Value'

  65. 

  66. field_formatter:

  67.   type: mapping

  68.   label: 'Field formatter'

  69.   mapping:

  70.     type:

  71.       type: string

  72.       label: 'Format type machine name'

  73.     label:

  74.        type: string

  75.        label: 'Label setting machine name'

  76.     settings:

  77.       type: field.formatter.settings.[%parent.type]

  78.       label: 'Settings'

  79.     third_party_settings:

  80.        type: sequence

  81.        label: 'Third party settings'

  82.        sequence:

  83.          type: field.formatter.third_party.[%key]

  84. 

  85. field_formatter.entity_view_display:

  86.   type: field_formatter

  87.   mapping:

  88.     weight:

  89.       type: integer

  90.       label: 'Weight'

  91.     region:

  92.       type: string

  93.       label: 'Region'

  94. 

  95. # Overview configuration information for form mode displays.

  96. core.entity_form_display.*.*.*:

  97.   type: config_entity

  98.   label: 'Entity form display'

  99.   mapping:

  100.     id:

  101.       type: string

  102.       label: 'ID'

  103.     targetEntityType:

  104.       type: string

  105.       label: 'Target entity type'

  106.     bundle:

  107.       type: string

  108.       label: 'Bundle'

  109.     mode:

  110.       type: string

  111.       label: 'View or form mode machine name'

  112.     status:

  113.       type: boolean

  114.       label: 'Enabled'

  115.     content:

  116.       type: sequence

  117.       label: 'Field widgets'

  118.       sequence:

  119.         type: mapping

  120.         label: 'Field widget'

  121.         mapping:

  122.           type:

  123.             type: string

  124.             label: 'Widget type machine name'

  125.           weight:

  126.             type: integer

  127.             label: 'Weight'

  128.           region:

  129.             type: string

  130.             label: 'Region'

  131.           settings:

  132.             type: field.widget.settings.[%parent.type]

  133.             label: 'Settings'

  134.           third_party_settings:

  135.             type: sequence

  136.             label: 'Third party settings'

  137.             sequence:

  138.               type: field.widget.third_party.[%key]

  139.     hidden:

  140.       type: sequence

  141.       label: 'Hidden'

  142.       sequence:

  143.         type: boolean

  144.         label: 'Component'

  145. 

  146. # Default schema for entity display field with undefined type.

  147. field.formatter.settings.*:

  148.   type: mapping

  149. 

  150. # Default schema for entity form display field with undefined type.

  151. field.widget.settings.*:

  152.   type: mapping

  153. 

  154. field.widget.settings.string_textfield:

  155.   type: mapping

  156.   label: 'Text field display format settings'

  157.   mapping:

  158.     size:

  159.       type: integer

  160.       label: 'Size of textfield'

  161.     placeholder:

  162.       type: label

  163.       label: 'Placeholder'

  164. 

  165. field.widget.settings.string_textarea:

  166.   type: mapping

  167.   label: 'Textarea display format settings'

  168.   mapping:

  169.     rows:

  170.       type: integer

  171.       label: 'Rows'

  172.     placeholder:

  173.       type: label

  174.       label: 'Placeholder'

  175. 

  176. field.widget.settings.uri:

  177.   type: mapping

  178.   label: 'URI field'

  179.   mapping:

  180.     size:

  181.       type: integer

  182.       label: 'Size of URI field'

  183.     placeholder:

  184.       type: label

  185.       label: 'Placeholder'

  186. 

  187. field.widget.settings.email_default:

  188.   type: mapping

  189.   label: 'Email field display format settings'

  190.   mapping:

  191.     placeholder:

  192.       type: label

  193.       label: 'Placeholder'

  194.     size:

  195.       type: integer

  196.       label: 'Size of email field'

  197. 

  198. field.widget.settings.datetime_timestamp:

  199.   type: mapping

  200.   label: 'Datetime timestamp display format settings'

  201. 

  202. field.widget.settings.boolean_checkbox:

  203.   type: mapping

  204.   label: 'Boolean checkbox display format settings'

  205.   mapping:

  206.     display_label:

  207.       type: boolean

  208.       label: 'Display label'

  209. 

  210. field.widget.settings.hidden:

  211.   type: mapping

  212.   label: '- Hidden - format settings'

  213. 

  214. field.widget.settings.number:

  215.   type: mapping

  216.   label: 'Number default display format settings'

  217.   mapping:

  218.     placeholder:

  219.       type: label

  220.       label: 'Placeholder'

  221. 

  222. field.widget.settings.checkbox:

  223.   type: mapping

  224.   label: 'Single on/off checkbox format settings'

  225.   mapping:

  226.     display_label:

  227.       type: boolean

  228.       label: 'Use field label instead of the "On value" as label'

  229. 

  230. field.widget.settings.entity_reference_autocomplete_tags:

  231.   type: mapping

  232.   label: 'Entity reference autocomplete (Tags style) display format settings'

  233.   mapping:

  234.     match_operator:

  235.       type: string

  236.       label: 'Autocomplete matching'

  237.     match_limit:

  238.       type: integer

  239.       label: 'Maximum number of autocomplete suggestions.'

  240.     size:

  241.       type: integer

  242.       label: 'Size of textfield'

  243.     placeholder:

  244.       type: label

  245.       label: 'Placeholder'

  246. 

  247. field.widget.settings.entity_reference_autocomplete:

  248.   type: mapping

  249.   label: 'Entity reference autocomplete display format settings'

  250.   mapping:

  251.     match_operator:

  252.       type: string

  253.       label: 'Autocomplete matching'

  254.     match_limit:

  255.       type: integer

  256.       label: 'Maximum number of autocomplete suggestions.'

  257.     size:

  258.       type: integer

  259.       label: 'Size of textfield'

  260.     placeholder:

  261.       type: label

  262.       label: 'Placeholder'

  263. 

  264. field.formatter.settings.boolean:

  265.   type: mapping

  266.   mapping:

  267.     format:

  268.       type: string

  269.       label: 'Output format'

  270.     format_custom_false:

  271.       type: label

  272.       label: 'Custom output for FALSE'

  273.     format_custom_true:

  274.       type: label

  275.       label: 'Custom output for TRUE'

  276. 

  277. field.formatter.settings.string:

  278.   type: mapping

  279.   mapping:

  280.     link_to_entity:

  281.       type: boolean

  282.       label: 'Link to the entity'

  283. 

  284. field.formatter.settings.language:

  285.   type: field.formatter.settings.string

  286.   mapping:

  287.     native_language:

  288.       type: boolean

  289.       label: 'Display in native language'

  290. 

  291. field.formatter.settings.number_decimal:

  292.   type: mapping

  293.   label: 'Number decimal display format settings'

  294.   mapping:

  295.     thousand_separator:

  296.       type: string

  297.       label: 'Thousand marker'

  298.     decimal_separator:

  299.       type: string

  300.       label: 'Decimal marker'

  301.     scale:

  302.       type: integer

  303.       label: 'Scale'

  304.     prefix_suffix:

  305.       type: boolean

  306.       label: 'Display prefix and suffix.'

  307. 

  308. field.formatter.settings.number_integer:

  309.   type: mapping

  310.   label: 'Number integer display format settings'

  311.   mapping:

  312.     thousand_separator:

  313.       type: string

  314.       label: 'Thousand marker'

  315.     prefix_suffix:

  316.       type: boolean

  317.       label: 'Display prefix and suffix.'

  318. 

  319. field.formatter.settings.number_unformatted:

  320.   type: mapping

  321.   label: 'Number unformatted display format settings'

  322. 

  323. field.formatter.settings.uri_link:

  324.   type: mapping

  325.   label: 'URI as link display format settings'

  326. 

  327. field.formatter.settings.timestamp:

  328.   type: mapping

  329.   label: 'Timestamp display format settings'

  330.   mapping:

  331.     date_format:

  332.       type: string

  333.       label: 'Date format'

  334.     custom_date_format:

  335.       type: string

  336.       label: 'Custom date format'

  337.     timezone:

  338.       type: string

  339.       label: 'Time zone'

  340. 

  341. field.formatter.settings.timestamp_ago:

  342.   type: mapping

  343.   label: 'Timestamp ago display format settings'

  344.   mapping:

  345.     future_format:

  346.       type: label

  347.       label: 'Future format'

  348.     past_format:

  349.       type: label

  350.       label: 'Past format'

  351.     granularity:

  352.       type: integer

  353.       label: 'Granularity'

  354. 

  355. field.formatter.settings.entity_reference_entity_view:

  356.   type: mapping

  357.   label: 'Entity reference rendered entity display format settings'

  358.   mapping:

  359.     view_mode:

  360.       type: string

  361.       label: 'View mode'

  362.     link:

  363.       type: boolean

  364.       label: 'Show links'

  365. 

  366. field.formatter.settings.entity_reference_entity_id:

  367.   type: mapping

  368.   label: 'Entity reference entity ID display format settings'

  369. 

  370. field.formatter.settings.entity_reference_label:

  371.   type: mapping

  372.   label: 'Entity reference label display format settings'

  373.   mapping:

  374.     link:

  375.       type: boolean

  376.       label: 'Link label to the referenced entity'

  377. 

  378. block.settings.field_block:*:*:*:

  379.   type: block_settings

  380.   mapping:

  381.     formatter:

  382.       type: field_formatter

  383. 

  384. block.settings.extra_field_block:*:*:*:

  385.   type: block_settings

  386.   mapping:

  387.     formatter:

  388.       type: field_formatter

  389. 

  390. # Schema for entity actions.

  391. action.configuration.entity:*:*:

  392.   type: action_configuration_default

  393.   label: 'Entity action'

  394. 

  395. action.configuration.action_send_email_action:

  396.   type: mapping

  397.   label: 'Send email configuration'

  398.   mapping:

  399.     recipient:

  400.       type: string

  401.       label: 'Recipient'

  402.     subject:

  403.       type: label

  404.       label: 'Subject'

  405.     message:

  406.       type: text

  407.       label: 'Message'

  408. 

  409. action.configuration.action_goto_action:

  410.   type: mapping

  411.   label: 'Redirect to URL configuration'

  412.   mapping:

  413.     url:

  414.       type: string

  415.       label: 'URL'

  416. 

  417. action.configuration.action_message_action:

  418.   type: mapping

  419.   label: 'Display a message to the user configuration'

  420.   mapping:

  421.     message:

  422.       type: text

  423.       label: 'Message'