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. core.design_token.*:

  93.   type: config_entity

  94.   label: 'Design token'

  95.   constraints:

  96.     FullyValidatable: ~

  97.   mapping:

  98.     id:

  99.       type: machine_name

  100.       label: 'ID'

  101.     path:

  102.       type: string

  103.       label: 'The CSS variable path'

  104.       constraints:

  105.         Regex:

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

  107.           message: "The %value path is not valid."

  108.     type:

  109.       type: string

  110.       label: 'The design token value type'

  111.       constraints:

  112.         PluginExists:

  113.           manager: plugin.manager.design_token_value

  114.           interface: 'Drupal\Core\Theme\DesignToken\DesignTokenValueInterface'

  115.     scopes:

  116.       type: sequence

  117.       label: 'The scopes of the value overrides.'

  118.       sequence:

  119.         type: design_token_value.[%parent.%parent.type]

  120.       constraints:

  121.         ValidSequenceKeys:

  122.           constraints:

  123.             CssSelector: []

  124. 

  125. field_formatter:

  126.   type: mapping

  127.   label: 'Field formatter'

  128.   mapping:

  129.     type:

  130.       type: string

  131.       label: 'Format type machine name'

  132.       constraints:

  133.         PluginExists:

  134.           manager: plugin.manager.field.formatter

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

  136.     label:

  137.       type: string

  138.       label: 'Label setting machine name'

  139.     settings:

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

  141.       label: 'Settings'

  142.     third_party_settings:

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

  144.       # point.

  145.       requiredKey: false

  146.       type: sequence

  147.       label: 'Third party settings'

  148.       sequence:

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

  150. 

  151. field_formatter.entity_view_display:

  152.   type: field_formatter

  153.   mapping:

  154.     weight:

  155.       type: weight

  156.       label: 'Weight'

  157.     region:

  158.       type: string

  159.       label: 'Region'

  160. 

  161. # Overview configuration information for form mode displays.

  162. core.entity_form_display.*.*.*:

  163.   type: config_entity

  164.   label: 'Entity form display'

  165.   mapping:

  166.     id:

  167.       type: string

  168.       label: 'ID'

  169.     targetEntityType:

  170.       type: string

  171.       label: 'Target entity type'

  172.     bundle:

  173.       type: string

  174.       label: 'Bundle'

  175.       constraints:

  176.         EntityBundleExists:

  177.           entityTypeId: '%parent.targetEntityType'

  178.     mode:

  179.       type: string

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

  181.     status:

  182.       type: boolean

  183.       label: 'Enabled'

  184.     content:

  185.       type: sequence

  186.       label: 'Field widgets'

  187.       sequence:

  188.         type: mapping

  189.         label: 'Field widget'

  190.         mapping:

  191.           type:

  192.             type: string

  193.             label: 'Widget type machine name'

  194.             constraints:

  195.               PluginExists:

  196.                 manager: plugin.manager.field.widget

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

  198.           weight:

  199.             type: weight

  200.             label: 'Weight'

  201.           region:

  202.             type: string

  203.             label: 'Region'

  204.           settings:

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

  206.             label: 'Settings'

  207.           third_party_settings:

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

  209.             # point.

  210.             requiredKey: false

  211.             type: sequence

  212.             label: 'Third party settings'

  213.             sequence:

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

  215.     hidden:

  216.       type: sequence

  217.       label: 'Hidden'

  218.       sequence:

  219.         type: boolean

  220.         label: 'Component'

  221. 

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

  223. field.formatter.settings.*:

  224.   type: mapping

  225. 

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

  227. field.widget.settings.*:

  228.   type: mapping

  229. 

  230. field.widget.settings.string_textfield:

  231.   type: mapping

  232.   label: 'Text field display format settings'

  233.   mapping:

  234.     size:

  235.       type: integer

  236.       label: 'Size of textfield'

  237.     placeholder:

  238.       type: label

  239.       label: 'Placeholder'

  240. 

  241. field.widget.settings.string_textarea:

  242.   type: mapping

  243.   label: 'Textarea display format settings'

  244.   mapping:

  245.     rows:

  246.       type: integer

  247.       label: 'Rows'

  248.     placeholder:

  249.       type: label

  250.       label: 'Placeholder'

  251. 

  252. field.widget.settings.uri:

  253.   type: mapping

  254.   label: 'URI field'

  255.   mapping:

  256.     size:

  257.       type: integer

  258.       label: 'Size of URI field'

  259.     placeholder:

  260.       type: label

  261.       label: 'Placeholder'

  262. 

  263. field.widget.settings.email_default:

  264.   type: mapping

  265.   label: 'Email field display format settings'

  266.   mapping:

  267.     placeholder:

  268.       type: label

  269.       label: 'Placeholder'

  270.     size:

  271.       type: integer

  272.       label: 'Size of email field'

  273. 

  274. field.widget.settings.datetime_timestamp:

  275.   type: mapping

  276.   label: 'Datetime timestamp display format settings'

  277. 

  278. field.widget.settings.boolean_checkbox:

  279.   type: mapping

  280.   label: 'Boolean checkbox display format settings'

  281.   mapping:

  282.     display_label:

  283.       type: boolean

  284.       label: 'Display label'

  285. 

  286. field.widget.settings.hidden:

  287.   type: mapping

  288.   label: '- Hidden - format settings'

  289. 

  290. field.widget.settings.number:

  291.   type: mapping

  292.   label: 'Number default display format settings'

  293.   mapping:

  294.     placeholder:

  295.       type: label

  296.       label: 'Placeholder'

  297. 

  298. field.widget.settings.checkbox:

  299.   type: mapping

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

  301.   mapping:

  302.     display_label:

  303.       type: boolean

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

  305. 

  306. field.widget.settings.language_select:

  307.   type: mapping

  308.   label: 'Language format settings'

  309.   mapping:

  310.     include_locked:

  311.       type: boolean

  312.       label: 'Include locked languages'

  313. 

  314. field.widget.settings.entity_reference_autocomplete_tags:

  315.   type: mapping

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

  317.   mapping:

  318.     match_operator:

  319.       type: string

  320.       label: 'Autocomplete matching'

  321.     match_limit:

  322.       type: integer

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

  324.     size:

  325.       type: integer

  326.       label: 'Size of textfield'

  327.     placeholder:

  328.       type: label

  329.       label: 'Placeholder'

  330. 

  331. field.widget.settings.entity_reference_autocomplete:

  332.   type: mapping

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

  334.   mapping:

  335.     match_operator:

  336.       type: string

  337.       label: 'Autocomplete matching'

  338.     match_limit:

  339.       type: integer

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

  341.     size:

  342.       type: integer

  343.       label: 'Size of textfield'

  344.     placeholder:

  345.       type: label

  346.       label: 'Placeholder'

  347. 

  348. field.formatter.settings.boolean:

  349.   type: mapping

  350.   mapping:

  351.     format:

  352.       type: string

  353.       label: 'Output format'

  354.     format_custom_false:

  355.       type: label

  356.       label: 'Custom output for FALSE'

  357.     format_custom_true:

  358.       type: label

  359.       label: 'Custom output for TRUE'

  360. 

  361. field.formatter.settings.string:

  362.   type: mapping

  363.   mapping:

  364.     link_to_entity:

  365.       type: boolean

  366.       label: 'Link to the entity'

  367.     link_rel:

  368.       type: string

  369.       label: 'Link destination'

  370.       constraints:

  371.         Choice:

  372.           choices:

  373.             - canonical

  374.             - edit-form

  375.       requiredKey: false

  376. 

  377. field.formatter.settings.language:

  378.   type: field.formatter.settings.string

  379.   mapping:

  380.     native_language:

  381.       type: boolean

  382.       label: 'Display in native language'

  383. 

  384. field.formatter.settings.number_decimal:

  385.   type: mapping

  386.   label: 'Number decimal display format settings'

  387.   mapping:

  388.     thousand_separator:

  389.       type: string

  390.       label: 'Thousand marker'

  391.     decimal_separator:

  392.       type: string

  393.       label: 'Decimal marker'

  394.     scale:

  395.       type: integer

  396.       label: 'Scale'

  397.     prefix_suffix:

  398.       type: boolean

  399.       label: 'Display prefix and suffix.'

  400. 

  401. field.formatter.settings.number_integer:

  402.   type: mapping

  403.   label: 'Number integer display format settings'

  404.   mapping:

  405.     thousand_separator:

  406.       type: string

  407.       label: 'Thousand marker'

  408.     prefix_suffix:

  409.       type: boolean

  410.       label: 'Display prefix and suffix.'

  411. 

  412. field.formatter.settings.number_unformatted:

  413.   type: mapping

  414.   label: 'Number unformatted display format settings'

  415. 

  416. field.formatter.settings.uri_link:

  417.   type: mapping

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

  419. 

  420. field.formatter.settings.timestamp:

  421.   type: mapping

  422.   label: 'Timestamp display format settings'

  423.   mapping:

  424.     date_format:

  425.       type: string

  426.       label: 'Date format'

  427.     custom_date_format:

  428.       type: string

  429.       label: 'Custom date format'

  430.     timezone:

  431.       type: string

  432.       label: 'Time zone'

  433.     tooltip:

  434.       type: mapping

  435.       label: Tooltip

  436.       mapping:

  437.         date_format:

  438.           type: string

  439.           label: 'Tooltip date format'

  440.         custom_date_format:

  441.           type: string

  442.           label: 'Tooltip custom date format'

  443.     time_diff:

  444.       type: mapping

  445.       label: 'Time difference'

  446.       mapping:

  447.         enabled:

  448.           type: boolean

  449.           label: 'Show as time difference'

  450.         future_format:

  451.           type: string

  452.           label: 'Future format'

  453.         past_format:

  454.           type: string

  455.           label: 'Past format'

  456.         granularity:

  457.           type: integer

  458.           label: 'Time units'

  459.         refresh:

  460.           type: integer

  461.           label: 'Refresh interval in seconds'

  462. 

  463. field.formatter.settings.timestamp_ago:

  464.   type: mapping

  465.   label: 'Timestamp ago display format settings'

  466.   mapping:

  467.     future_format:

  468.       type: required_label

  469.       label: 'Future format'

  470.     past_format:

  471.       type: required_label

  472.       label: 'Past format'

  473.     granularity:

  474.       type: integer

  475.       label: 'Granularity'

  476. 

  477. field.formatter.settings.entity_reference_entity_view:

  478.   type: mapping

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

  480.   mapping:

  481.     view_mode:

  482.       type: string

  483.       label: 'View mode'

  484.     link:

  485.       type: boolean

  486.       label: 'Show links'

  487. 

  488. field.formatter.settings.entity_reference_entity_id:

  489.   type: mapping

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

  491. 

  492. field.formatter.settings.entity_reference_label:

  493.   type: mapping

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

  495.   mapping:

  496.     link:

  497.       type: boolean

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

  499. 

  500. block.settings.field_block:*:*:*:

  501.   type: block_settings

  502.   mapping:

  503.     formatter:

  504.       type: field_formatter

  505.   constraints:

  506.     FullyValidatable: ~

  507. 

  508. block.settings.extra_field_block:*:*:*:

  509.   type: block_settings

  510.   mapping:

  511.     formatter:

  512.       type: field_formatter

  513. 

  514. # Schema for entity actions.

  515. action.configuration.entity:*:*:

  516.   type: action_configuration_default

  517.   label: 'Entity action'

  518. 

  519. action.configuration.action_send_email_action:

  520.   type: mapping

  521.   label: 'Send email configuration'

  522.   mapping:

  523.     recipient:

  524.       type: string

  525.       label: 'Recipient'

  526.     subject:

  527.       type: label

  528.       label: 'Subject'

  529.     message:

  530.       type: text

  531.       label: 'Message'

  532. 

  533. action.configuration.action_goto_action:

  534.   type: mapping

  535.   label: 'Redirect to URL configuration'

  536.   mapping:

  537.     url:

  538.       type: string

  539.       label: 'URL'

  540. 

  541. action.configuration.action_message_action:

  542.   type: mapping

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

  544.   mapping:

  545.     message:

  546.       type: text

  547.       label: 'Message'

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