core.entity.schema.yml

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

File

View on git.drupalcode.org

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: 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:

  76.           entityTypeId: '%parent.targetEntityType'

  77.     mode:

  78.       type: string

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

  80.     content:

  81.       type: sequence

  82.       label: 'Field formatters'

  83.       sequence:

  84.         type: field_formatter.entity_view_display

  85.     hidden:

  86.       type: sequence

  87.       label: 'Field display setting'

  88.       sequence:

  89.         type: boolean

  90.         label: 'Value'

  91. 

  92. field_formatter:

  93.   type: mapping

  94.   label: 'Field formatter'

  95.   mapping:

  96.     type:

  97.       type: string

  98.       label: 'Format type machine name'

  99.       constraints:

  100.         PluginExists:

  101.           manager: plugin.manager.field.formatter

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

  103.     label:

  104.       type: string

  105.       label: 'Label setting machine name'

  106.     settings:

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

  108.       label: 'Settings'

  109.     third_party_settings:

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

  111.       # point.

  112.       requiredKey: false

  113.       type: sequence

  114.       label: 'Third party settings'

  115.       sequence:

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

  117. 

  118. field_formatter.entity_view_display:

  119.   type: field_formatter

  120.   mapping:

  121.     weight:

  122.       type: weight

  123.       label: 'Weight'

  124.     region:

  125.       type: string

  126.       label: 'Region'

  127. 

  128. # Overview configuration information for form mode displays.

  129. core.entity_form_display.*.*.*:

  130.   type: config_entity

  131.   label: 'Entity form display'

  132.   mapping:

  133.     id:

  134.       type: string

  135.       label: 'ID'

  136.     targetEntityType:

  137.       type: string

  138.       label: 'Target entity type'

  139.     bundle:

  140.       type: string

  141.       label: 'Bundle'

  142.       constraints:

  143.         EntityBundleExists:

  144.           entityTypeId: '%parent.targetEntityType'

  145.     mode:

  146.       type: string

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

  148.     status:

  149.       type: boolean

  150.       label: 'Enabled'

  151.     content:

  152.       type: sequence

  153.       label: 'Field widgets'

  154.       sequence:

  155.         type: mapping

  156.         label: 'Field widget'

  157.         mapping:

  158.           type:

  159.             type: string

  160.             label: 'Widget type machine name'

  161.             constraints:

  162.               PluginExists:

  163.                 manager: plugin.manager.field.widget

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

  165.           weight:

  166.             type: weight

  167.             label: 'Weight'

  168.           region:

  169.             type: string

  170.             label: 'Region'

  171.           settings:

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

  173.             label: 'Settings'

  174.           third_party_settings:

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

  176.             # point.

  177.             requiredKey: false

  178.             type: sequence

  179.             label: 'Third party settings'

  180.             sequence:

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

  182.     hidden:

  183.       type: sequence

  184.       label: 'Hidden'

  185.       sequence:

  186.         type: boolean

  187.         label: 'Component'

  188. 

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

  190. field.formatter.settings.*:

  191.   type: mapping

  192. 

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

  194. field.widget.settings.*:

  195.   type: mapping

  196. 

  197. field.widget.settings.string_textfield:

  198.   type: mapping

  199.   label: 'Text field display format settings'

  200.   mapping:

  201.     size:

  202.       type: integer

  203.       label: 'Size of textfield'

  204.     placeholder:

  205.       type: label

  206.       label: 'Placeholder'

  207. 

  208. field.widget.settings.string_textarea:

  209.   type: mapping

  210.   label: 'Textarea display format settings'

  211.   mapping:

  212.     rows:

  213.       type: integer

  214.       label: 'Rows'

  215.     placeholder:

  216.       type: label

  217.       label: 'Placeholder'

  218. 

  219. field.widget.settings.uri:

  220.   type: mapping

  221.   label: 'URI field'

  222.   mapping:

  223.     size:

  224.       type: integer

  225.       label: 'Size of URI field'

  226.     placeholder:

  227.       type: label

  228.       label: 'Placeholder'

  229. 

  230. field.widget.settings.email_default:

  231.   type: mapping

  232.   label: 'Email field display format settings'

  233.   mapping:

  234.     placeholder:

  235.       type: label

  236.       label: 'Placeholder'

  237.     size:

  238.       type: integer

  239.       label: 'Size of email field'

  240. 

  241. field.widget.settings.datetime_timestamp:

  242.   type: mapping

  243.   label: 'Datetime timestamp display format settings'

  244. 

  245. field.widget.settings.boolean_checkbox:

  246.   type: mapping

  247.   label: 'Boolean checkbox display format settings'

  248.   mapping:

  249.     display_label:

  250.       type: boolean

  251.       label: 'Display label'

  252. 

  253. field.widget.settings.hidden:

  254.   type: mapping

  255.   label: '- Hidden - format settings'

  256. 

  257. field.widget.settings.number:

  258.   type: mapping

  259.   label: 'Number default display format settings'

  260.   mapping:

  261.     placeholder:

  262.       type: label

  263.       label: 'Placeholder'

  264. 

  265. field.widget.settings.checkbox:

  266.   type: mapping

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

  268.   mapping:

  269.     display_label:

  270.       type: boolean

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

  272. 

  273. field.widget.settings.language_select:

  274.   type: mapping

  275.   label: 'Language format settings'

  276.   mapping:

  277.     include_locked:

  278.       type: boolean

  279.       label: 'Include locked languages'

  280. 

  281. field.widget.settings.entity_reference_autocomplete_tags:

  282.   type: mapping

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

  284.   mapping:

  285.     match_operator:

  286.       type: string

  287.       label: 'Autocomplete matching'

  288.     match_limit:

  289.       type: integer

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

  291.     size:

  292.       type: integer

  293.       label: 'Size of textfield'

  294.     placeholder:

  295.       type: label

  296.       label: 'Placeholder'

  297. 

  298. field.widget.settings.entity_reference_autocomplete:

  299.   type: mapping

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

  301.   mapping:

  302.     match_operator:

  303.       type: string

  304.       label: 'Autocomplete matching'

  305.     match_limit:

  306.       type: integer

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

  308.     size:

  309.       type: integer

  310.       label: 'Size of textfield'

  311.     placeholder:

  312.       type: label

  313.       label: 'Placeholder'

  314. 

  315. field.formatter.settings.boolean:

  316.   type: mapping

  317.   mapping:

  318.     format:

  319.       type: string

  320.       label: 'Output format'

  321.     format_custom_false:

  322.       type: label

  323.       label: 'Custom output for FALSE'

  324.     format_custom_true:

  325.       type: label

  326.       label: 'Custom output for TRUE'

  327. 

  328. field.formatter.settings.string:

  329.   type: mapping

  330.   mapping:

  331.     link_to_entity:

  332.       type: boolean

  333.       label: 'Link to the entity'

  334. 

  335. field.formatter.settings.language:

  336.   type: field.formatter.settings.string

  337.   mapping:

  338.     native_language:

  339.       type: boolean

  340.       label: 'Display in native language'

  341. 

  342. field.formatter.settings.number_decimal:

  343.   type: mapping

  344.   label: 'Number decimal display format settings'

  345.   mapping:

  346.     thousand_separator:

  347.       type: string

  348.       label: 'Thousand marker'

  349.     decimal_separator:

  350.       type: string

  351.       label: 'Decimal marker'

  352.     scale:

  353.       type: integer

  354.       label: 'Scale'

  355.     prefix_suffix:

  356.       type: boolean

  357.       label: 'Display prefix and suffix.'

  358. 

  359. field.formatter.settings.number_integer:

  360.   type: mapping

  361.   label: 'Number integer display format settings'

  362.   mapping:

  363.     thousand_separator:

  364.       type: string

  365.       label: 'Thousand marker'

  366.     prefix_suffix:

  367.       type: boolean

  368.       label: 'Display prefix and suffix.'

  369. 

  370. field.formatter.settings.number_unformatted:

  371.   type: mapping

  372.   label: 'Number unformatted display format settings'

  373. 

  374. field.formatter.settings.uri_link:

  375.   type: mapping

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

  377. 

  378. field.formatter.settings.timestamp:

  379.   type: mapping

  380.   label: 'Timestamp display format settings'

  381.   mapping:

  382.     date_format:

  383.       type: string

  384.       label: 'Date format'

  385.     custom_date_format:

  386.       type: string

  387.       label: 'Custom date format'

  388.     timezone:

  389.       type: string

  390.       label: 'Time zone'

  391.     tooltip:

  392.       type: mapping

  393.       label: Tooltip

  394.       mapping:

  395.         date_format:

  396.           type: string

  397.           label: 'Tooltip date format'

  398.         custom_date_format:

  399.           type: string

  400.           label: 'Tooltip custom date format'

  401.     time_diff:

  402.       type: mapping

  403.       label: 'Time difference'

  404.       mapping:

  405.         enabled:

  406.           type: boolean

  407.           label: 'Show as time difference'

  408.         future_format:

  409.           type: string

  410.           label: 'Future format'

  411.         past_format:

  412.           type: string

  413.           label: 'Past format'

  414.         granularity:

  415.           type: integer

  416.           label: 'Time units'

  417.         refresh:

  418.           type: integer

  419.           label: 'Refresh interval in seconds'

  420. 

  421. field.formatter.settings.timestamp_ago:

  422.   type: mapping

  423.   label: 'Timestamp ago display format settings'

  424.   mapping:

  425.     future_format:

  426.       type: required_label

  427.       label: 'Future format'

  428.     past_format:

  429.       type: required_label

  430.       label: 'Past format'

  431.     granularity:

  432.       type: integer

  433.       label: 'Granularity'

  434. 

  435. field.formatter.settings.entity_reference_entity_view:

  436.   type: mapping

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

  438.   mapping:

  439.     view_mode:

  440.       type: string

  441.       label: 'View mode'

  442.     link:

  443.       type: boolean

  444.       label: 'Show links'

  445. 

  446. field.formatter.settings.entity_reference_entity_id:

  447.   type: mapping

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

  449. 

  450. field.formatter.settings.entity_reference_label:

  451.   type: mapping

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

  453.   mapping:

  454.     link:

  455.       type: boolean

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

  457. 

  458. block.settings.field_block:*:*:*:

  459.   type: block_settings

  460.   mapping:

  461.     formatter:

  462.       type: field_formatter

  463.   constraints:

  464.     FullyValidatable: ~

  465. 

  466. block.settings.extra_field_block:*:*:*:

  467.   type: block_settings

  468.   mapping:

  469.     formatter:

  470.       type: field_formatter

  471. 

  472. # Schema for entity actions.

  473. action.configuration.entity:*:*:

  474.   type: action_configuration_default

  475.   label: 'Entity action'

  476. 

  477. action.configuration.action_send_email_action:

  478.   type: mapping

  479.   label: 'Send email configuration'

  480.   mapping:

  481.     recipient:

  482.       type: string

  483.       label: 'Recipient'

  484.     subject:

  485.       type: label

  486.       label: 'Subject'

  487.     message:

  488.       type: text

  489.       label: 'Message'

  490. 

  491. action.configuration.action_goto_action:

  492.   type: mapping

  493.   label: 'Redirect to URL configuration'

  494.   mapping:

  495.     url:

  496.       type: string

  497.       label: 'URL'

  498. 

  499. action.configuration.action_message_action:

  500.   type: mapping

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

  502.   mapping:

  503.     message:

  504.       type: text

  505.       label: 'Message'

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