core.entity.schema.yml

Same filename and directory 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 on git.drupalcode.org
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: required_label

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

  13.     description:

  14.       type: text

  15.       label: 'Description'

  16.     targetEntityType:

  17.       type: string

  18.       label: 'Target entity type'

  19.     cache:

  20.       type: boolean

  21.       label: 'Cached'

  22. 

  23. core.entity_form_mode.*.*:

  24.   type: config_entity

  25.   label: 'Entity form mode settings'

  26.   constraints:

  27.     FullyValidatable: ~

  28.   mapping:

  29.     id:

  30.       type: string

  31.       label: 'ID'

  32.       # Form mode IDs can only contain lowercase letters, numbers, and underscores

  33.       # prefixed by entity type name this form mode is used for and a dot.

  34.       # @see \Drupal\field_ui\Form\EntityDisplayModeFormBase::form()

  35.       constraints:

  36.         Regex:

  37.           pattern: '/^[a-z0-9_]+\.[a-z0-9_]+$/'

  38.           message: "The ID %value is not valid."

  39.     label:

  40.       type: required_label

  41.       label: 'Label'

  42.     description:

  43.       type: text

  44.       label: 'Description'

  45.       nullable: true

  46.       constraints:

  47.         NotBlank:

  48.           allowNull: true

  49.     targetEntityType:

  50.       type: string

  51.       label: 'Target entity type'

  52.       constraints:

  53.         PluginExists:

  54.           manager: entity_type.manager

  55.           interface: Drupal\Core\Entity\ContentEntityInterface

  56.     cache:

  57.       type: boolean

  58.       label: 'Cache'

  59. 

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

  61. core.entity_view_display.*.*.*:

  62.   type: config_entity

  63.   label: 'Entity display'

  64.   mapping:

  65.     id:

  66.       type: string

  67.       label: 'ID'

  68.     targetEntityType:

  69.       type: string

  70.       label: 'Target entity type'

  71.     bundle:

  72.       type: string

  73.       label: 'Bundle'

  74.       constraints:

  75.         EntityBundleExists: '%parent.targetEntityType'

  76.     mode:

  77.       type: string

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

  79.     content:

  80.       type: sequence

  81.       label: 'Field formatters'

  82.       sequence:

  83.         type: field_formatter.entity_view_display

  84.     hidden:

  85.       type: sequence

  86.       label: 'Field display setting'

  87.       sequence:

  88.         type: boolean

  89.         label: 'Value'

  90. 

  91. field_formatter:

  92.   type: mapping

  93.   label: 'Field formatter'

  94.   mapping:

  95.     type:

  96.       type: string

  97.       label: 'Format type machine name'

  98.       constraints:

  99.         PluginExists:

  100.           manager: plugin.manager.field.formatter

  101.           interface: 'Drupal\Core\Field\FormatterInterface'

  102.     label:

  103.       type: string

  104.       label: 'Label setting machine name'

  105.     settings:

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

  107.       label: 'Settings'

  108.     third_party_settings:

  109.       # Third party settings are always optional: they're an optional extension

  110.       # point.

  111.       requiredKey: false

  112.       type: sequence

  113.       label: 'Third party settings'

  114.       sequence:

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

  116. 

  117. field_formatter.entity_view_display:

  118.   type: field_formatter

  119.   mapping:

  120.     weight:

  121.       type: weight

  122.       label: 'Weight'

  123.     region:

  124.       type: string

  125.       label: 'Region'

  126. 

  127. # Overview configuration information for form mode displays.

  128. core.entity_form_display.*.*.*:

  129.   type: config_entity

  130.   label: 'Entity form display'

  131.   mapping:

  132.     id:

  133.       type: string

  134.       label: 'ID'

  135.     targetEntityType:

  136.       type: string

  137.       label: 'Target entity type'

  138.     bundle:

  139.       type: string

  140.       label: 'Bundle'

  141.       constraints:

  142.         EntityBundleExists: '%parent.targetEntityType'

  143.     mode:

  144.       type: string

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

  146.     status:

  147.       type: boolean

  148.       label: 'Enabled'

  149.     content:

  150.       type: sequence

  151.       label: 'Field widgets'

  152.       sequence:

  153.         type: mapping

  154.         label: 'Field widget'

  155.         mapping:

  156.           type:

  157.             type: string

  158.             label: 'Widget type machine name'

  159.             constraints:

  160.               PluginExists:

  161.                 manager: plugin.manager.field.widget

  162.                 interface: '\Drupal\Core\Field\WidgetInterface'

  163.           weight:

  164.             type: weight

  165.             label: 'Weight'

  166.           region:

  167.             type: string

  168.             label: 'Region'

  169.           settings:

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

  171.             label: 'Settings'

  172.           third_party_settings:

  173.             # Third party settings are always optional: they're an optional extension

  174.             # point.

  175.             requiredKey: false

  176.             type: sequence

  177.             label: 'Third party settings'

  178.             sequence:

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

  180.     hidden:

  181.       type: sequence

  182.       label: 'Hidden'

  183.       sequence:

  184.         type: boolean

  185.         label: 'Component'

  186. 

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

  188. field.formatter.settings.*:

  189.   type: mapping

  190. 

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

  192. field.widget.settings.*:

  193.   type: mapping

  194. 

  195. field.widget.settings.string_textfield:

  196.   type: mapping

  197.   label: 'Text field display format settings'

  198.   mapping:

  199.     size:

  200.       type: integer

  201.       label: 'Size of textfield'

  202.     placeholder:

  203.       type: label

  204.       label: 'Placeholder'

  205. 

  206. field.widget.settings.string_textarea:

  207.   type: mapping

  208.   label: 'Textarea display format settings'

  209.   mapping:

  210.     rows:

  211.       type: integer

  212.       label: 'Rows'

  213.     placeholder:

  214.       type: label

  215.       label: 'Placeholder'

  216. 

  217. field.widget.settings.uri:

  218.   type: mapping

  219.   label: 'URI field'

  220.   mapping:

  221.     size:

  222.       type: integer

  223.       label: 'Size of URI field'

  224.     placeholder:

  225.       type: label

  226.       label: 'Placeholder'

  227. 

  228. field.widget.settings.email_default:

  229.   type: mapping

  230.   label: 'Email field display format settings'

  231.   mapping:

  232.     placeholder:

  233.       type: label

  234.       label: 'Placeholder'

  235.     size:

  236.       type: integer

  237.       label: 'Size of email field'

  238. 

  239. field.widget.settings.datetime_timestamp:

  240.   type: mapping

  241.   label: 'Datetime timestamp display format settings'

  242. 

  243. field.widget.settings.boolean_checkbox:

  244.   type: mapping

  245.   label: 'Boolean checkbox display format settings'

  246.   mapping:

  247.     display_label:

  248.       type: boolean

  249.       label: 'Display label'

  250. 

  251. field.widget.settings.hidden:

  252.   type: mapping

  253.   label: '- Hidden - format settings'

  254. 

  255. field.widget.settings.number:

  256.   type: mapping

  257.   label: 'Number default display format settings'

  258.   mapping:

  259.     placeholder:

  260.       type: label

  261.       label: 'Placeholder'

  262. 

  263. field.widget.settings.checkbox:

  264.   type: mapping

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

  266.   mapping:

  267.     display_label:

  268.       type: boolean

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

  270. 

  271. field.widget.settings.language_select:

  272.   type: mapping

  273.   label: 'Language format settings'

  274.   mapping:

  275.     include_locked:

  276.       type: boolean

  277.       label: 'Include locked languages'

  278. 

  279. field.widget.settings.entity_reference_autocomplete_tags:

  280.   type: mapping

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

  282.   mapping:

  283.     match_operator:

  284.       type: string

  285.       label: 'Autocomplete matching'

  286.     match_limit:

  287.       type: integer

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

  289.     size:

  290.       type: integer

  291.       label: 'Size of textfield'

  292.     placeholder:

  293.       type: label

  294.       label: 'Placeholder'

  295. 

  296. field.widget.settings.entity_reference_autocomplete:

  297.   type: mapping

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

  299.   mapping:

  300.     match_operator:

  301.       type: string

  302.       label: 'Autocomplete matching'

  303.     match_limit:

  304.       type: integer

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

  306.     size:

  307.       type: integer

  308.       label: 'Size of textfield'

  309.     placeholder:

  310.       type: label

  311.       label: 'Placeholder'

  312. 

  313. field.formatter.settings.boolean:

  314.   type: mapping

  315.   mapping:

  316.     format:

  317.       type: string

  318.       label: 'Output format'

  319.     format_custom_false:

  320.       type: label

  321.       label: 'Custom output for FALSE'

  322.     format_custom_true:

  323.       type: label

  324.       label: 'Custom output for TRUE'

  325. 

  326. field.formatter.settings.string:

  327.   type: mapping

  328.   mapping:

  329.     link_to_entity:

  330.       type: boolean

  331.       label: 'Link to the entity'

  332. 

  333. field.formatter.settings.language:

  334.   type: field.formatter.settings.string

  335.   mapping:

  336.     native_language:

  337.       type: boolean

  338.       label: 'Display in native language'

  339. 

  340. field.formatter.settings.number_decimal:

  341.   type: mapping

  342.   label: 'Number decimal display format settings'

  343.   mapping:

  344.     thousand_separator:

  345.       type: string

  346.       label: 'Thousand marker'

  347.     decimal_separator:

  348.       type: string

  349.       label: 'Decimal marker'

  350.     scale:

  351.       type: integer

  352.       label: 'Scale'

  353.     prefix_suffix:

  354.       type: boolean

  355.       label: 'Display prefix and suffix.'

  356. 

  357. field.formatter.settings.number_integer:

  358.   type: mapping

  359.   label: 'Number integer display format settings'

  360.   mapping:

  361.     thousand_separator:

  362.       type: string

  363.       label: 'Thousand marker'

  364.     prefix_suffix:

  365.       type: boolean

  366.       label: 'Display prefix and suffix.'

  367. 

  368. field.formatter.settings.number_unformatted:

  369.   type: mapping

  370.   label: 'Number unformatted display format settings'

  371. 

  372. field.formatter.settings.uri_link:

  373.   type: mapping

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

  375. 

  376. field.formatter.settings.timestamp:

  377.   type: mapping

  378.   label: 'Timestamp display format settings'

  379.   mapping:

  380.     date_format:

  381.       type: string

  382.       label: 'Date format'

  383.     custom_date_format:

  384.       type: string

  385.       label: 'Custom date format'

  386.     timezone:

  387.       type: string

  388.       label: 'Time zone'

  389.     tooltip:

  390.       type: mapping

  391.       label: Tooltip

  392.       mapping:

  393.         date_format:

  394.           type: string

  395.           label: 'Tooltip date format'

  396.         custom_date_format:

  397.           type: string

  398.           label: 'Tooltip custom date format'

  399.     time_diff:

  400.       type: mapping

  401.       label: 'Time difference'

  402.       mapping:

  403.         enabled:

  404.           type: boolean

  405.           label: 'Show as time difference'

  406.         future_format:

  407.           type: string

  408.           label: 'Future format'

  409.         past_format:

  410.           type: string

  411.           label: 'Past format'

  412.         granularity:

  413.           type: integer

  414.           label: 'Time units'

  415.         refresh:

  416.           type: integer

  417.           label: 'Refresh interval in seconds'

  418. 

  419. field.formatter.settings.timestamp_ago:

  420.   type: mapping

  421.   label: 'Timestamp ago display format settings'

  422.   mapping:

  423.     future_format:

  424.       type: required_label

  425.       label: 'Future format'

  426.     past_format:

  427.       type: required_label

  428.       label: 'Past format'

  429.     granularity:

  430.       type: integer

  431.       label: 'Granularity'

  432. 

  433. field.formatter.settings.entity_reference_entity_view:

  434.   type: mapping

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

  436.   mapping:

  437.     view_mode:

  438.       type: string

  439.       label: 'View mode'

  440.     link:

  441.       type: boolean

  442.       label: 'Show links'

  443. 

  444. field.formatter.settings.entity_reference_entity_id:

  445.   type: mapping

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

  447. 

  448. field.formatter.settings.entity_reference_label:

  449.   type: mapping

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

  451.   mapping:

  452.     link:

  453.       type: boolean

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

  455. 

  456. block.settings.field_block:*:*:*:

  457.   type: block_settings

  458.   mapping:

  459.     formatter:

  460.       type: field_formatter

  461. 

  462. block.settings.extra_field_block:*:*:*:

  463.   type: block_settings

  464.   mapping:

  465.     formatter:

  466.       type: field_formatter

  467. 

  468. # Schema for entity actions.

  469. action.configuration.entity:*:*:

  470.   type: action_configuration_default

  471.   label: 'Entity action'

  472. 

  473. action.configuration.action_send_email_action:

  474.   type: mapping

  475.   label: 'Send email configuration'

  476.   mapping:

  477.     recipient:

  478.       type: string

  479.       label: 'Recipient'

  480.     subject:

  481.       type: label

  482.       label: 'Subject'

  483.     message:

  484.       type: text

  485.       label: 'Message'

  486. 

  487. action.configuration.action_goto_action:

  488.   type: mapping

  489.   label: 'Redirect to URL configuration'

  490.   mapping:

  491.     url:

  492.       type: string

  493.       label: 'URL'

  494. 

  495. action.configuration.action_message_action:

  496.   type: mapping

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

  498.   mapping:

  499.     message:

  500.       type: text

  501.       label: 'Message'

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