system.schema.yml

Same filename and directory in other branches
  1. 10 core/modules/system/config/schema/system.schema.yml
  2. 9 core/modules/system/config/schema/system.schema.yml
  3. 8.9.x core/modules/system/config/schema/system.schema.yml
core/modules/system/config/schema/system.schema.yml
2 string references to 'system.schema'
UpdateHookRegistry::__construct in core/lib/Drupal/Core/Update/UpdateHookRegistry.php
Constructs a new UpdateHookRegistry.
UpdateHookRegistryTest::setUp in core/tests/Drupal/Tests/Core/Update/UpdateHookRegistryTest.php

File

core/modules/system/config/schema/system.schema.yml

View on git.drupalcode.org
View source 
  1. # Schema for the configuration files of the System module.

  2. 

  3. system.site:

  4.   type: config_object

  5.   label: 'Site information'

  6.   mapping:

  7.     uuid:

  8.       type: uuid

  9.       label: 'Site UUID'

  10.       constraints:

  11.         Uuid: []

  12.         NotNull: []

  13.     name:

  14.       type: label

  15.       label: 'Site name'

  16.     mail:

  17.       type: email

  18.       label: 'Email address'

  19.     slogan:

  20.       type: label

  21.       label: 'Slogan'

  22.     page:

  23.       type: mapping

  24.       label: 'Pages'

  25.       mapping:

  26.         403:

  27.           type: path

  28.           label: 'Default 403 (access denied) page'

  29.         404:

  30.           type: path

  31.           label: 'Default 404 (not found) page'

  32.         front:

  33.           type: path

  34.           label: 'Default front page'

  35.     admin_compact_mode:

  36.       type: boolean

  37.       label: 'Compact mode'

  38.     weight_select_max:

  39.       type: integer

  40.       label: 'Weight element maximum value'

  41.     default_langcode:

  42.       type: langcode

  43.       label: 'Site default language code'

  44.     mail_notification:

  45.       type: string

  46.       label: 'Notification email address'

  47. 

  48. system.maintenance:

  49.   type: config_object

  50.   label: 'Maintenance mode'

  51.   constraints:

  52.     FullyValidatable: ~

  53.   mapping:

  54.     message:

  55.       type: text

  56.       label: 'Message to display when in maintenance mode'

  57. 

  58. system.cron:

  59.   type: config_object

  60.   label: 'Cron settings'

  61.   constraints:

  62.     FullyValidatable: ~

  63.   mapping:

  64.     threshold:

  65.       type: mapping

  66.       label: 'Thresholds'

  67.       mapping:

  68.         requirements_warning:

  69.           type: integer

  70.           label: 'Requirements warning period'

  71.           constraints:

  72.             # @see \Drupal\system\Hook\SystemRequirementsHooks

  73.             Range:

  74.               min: 60

  75.         requirements_error:

  76.           type: integer

  77.           label: 'Requirements error period'

  78.           constraints:

  79.             # @see \Drupal\system\Hook\SystemRequirementsHooks

  80.             Range:

  81.               min: 300

  82.     logging:

  83.       type: boolean

  84.       label: 'Detailed cron logging'

  85. 

  86. system.date:

  87.   type: config_object

  88.   label: 'Date settings'

  89.   constraints:

  90.     FullyValidatable: ~

  91.   mapping:

  92.     first_day:

  93.       type: integer

  94.       label: 'First day of week'

  95.       constraints:

  96.         Range:

  97.           # @see \Drupal\system\Form\RegionalForm::buildForm()

  98.           min: 0

  99.           max: 6

  100.     country:

  101.       type: mapping

  102.       label: 'Country'

  103.       mapping:

  104.         default:

  105.           nullable: true

  106.           type: string

  107.           label: 'Default country'

  108.           constraints:

  109.             # @see \Drupal\system\Form\RegionalForm::buildForm()

  110.             CountryCode: []

  111.     timezone:

  112.       type: mapping

  113.       label: 'Time zone settings'

  114.       mapping:

  115.         default:

  116.           type: string

  117.           label: 'Default time zone'

  118.           nullable: true

  119.           constraints:

  120.             # @see \Drupal\system\Form\RegionalForm::buildForm()

  121.             Choice:

  122.               callback: 'DateTimeZone::listIdentifiers'

  123.         user:

  124.           type: mapping

  125.           label: 'User'

  126.           mapping:

  127.             configurable:

  128.               type: boolean

  129.               label: 'Users may set their own time zone'

  130.             default:

  131.               type: integer

  132.               label: 'Time zone for new users'

  133.               constraints:

  134.                 # Time zone for new users can have one of the following values:

  135.                 # - UserInterface::TIMEZONE_DEFAULT

  136.                 # - UserInterface::TIMEZONE_EMPTY

  137.                 # - UserInterface::TIMEZONE_SELECT

  138.                 # @see \Drupal\user\UserInterface::TIMEZONE_*

  139.                 # @todo Update this to use enum in https://www.drupal.org/project/drupal/issues/3402178

  140.                 Choice: [0, 1, 2]

  141.             warn:

  142.               type: boolean

  143.               label: 'Remind users at login if their time zone is not set'

  144. 

  145. system.diff:

  146.   type: config_object

  147.   label: 'Diff settings'

  148.   constraints:

  149.     FullyValidatable: ~

  150.   mapping:

  151.     context:

  152.       type: mapping

  153.       label: 'Context'

  154.       mapping:

  155.         lines_leading:

  156.           type: integer

  157.           label: 'Number of leading lines in a diff'

  158.           constraints:

  159.             # @see \Drupal\Component\Diff\DiffFormatter

  160.             PositiveOrZero: ~

  161.         lines_trailing:

  162.           type: integer

  163.           label: 'Number of trailing lines in a diff'

  164.           constraints:

  165.             # @see \Drupal\Component\Diff\DiffFormatter

  166.             PositiveOrZero: ~

  167. 

  168. system.logging:

  169.   type: config_object

  170.   label: 'Logging settings'

  171.   constraints:

  172.     FullyValidatable: ~

  173.   mapping:

  174.     error_level:

  175.       type: string

  176.       label: 'Error messages to display'

  177.       # @see core/includes/bootstrap.inc

  178.       # @todo Update this to use enum in https://www.drupal.org/project/drupal/issues/2951046

  179.       constraints:

  180.         Choice:

  181.           choices:

  182.             - 'hide'

  183.             - 'some'

  184.             - 'all'

  185.             - 'verbose'

  186. 

  187. system.performance:

  188.   type: config_object

  189.   label: 'Performance settings'

  190.   mapping:

  191.     cache:

  192.       type: mapping

  193.       label: 'Caching'

  194.       mapping:

  195.         page:

  196.           type: mapping

  197.           label: 'Page caching'

  198.           mapping:

  199.             max_age:

  200.               type: integer

  201.               label: 'Max age'

  202.     css:

  203.       type: mapping

  204.       label: 'CSS performance settings'

  205.       mapping:

  206.         preprocess:

  207.           type: boolean

  208.           label: 'Aggregate CSS files'

  209.         gzip:

  210.           type: boolean

  211.           label: 'Compress CSS files'

  212.     fast_404:

  213.       type: mapping

  214.       label: 'Fast 404 settings'

  215.       mapping:

  216.         enabled:

  217.           type: boolean

  218.           label: 'Fast 404 enabled'

  219.         paths:

  220.           type: string

  221.           label: 'Regular expression to match'

  222.         exclude_paths:

  223.           type: string

  224.           label: 'Regular expression to not match'

  225.         html:

  226.           type: string

  227.           label: 'Fast 404 page html'

  228.     js:

  229.       type: mapping

  230.       label: 'JavaScript performance settings'

  231.       mapping:

  232.         preprocess:

  233.           type: boolean

  234.           label: 'JavaScript preprocess'

  235.         gzip:

  236.           type: boolean

  237.           label: 'Compress JavaScript files.'

  238. 

  239. system.rss:

  240.   type: config_object

  241.   label: 'Feed settings'

  242.   mapping:

  243.     items:

  244.       type: mapping

  245.       label: 'Feed items'

  246.       mapping:

  247.         view_mode:

  248.           type: string

  249.           label: 'Feed content'

  250. 

  251. system.theme:

  252.   type: config_object

  253.   label: 'Theme settings'

  254.   mapping:

  255.     admin:

  256.       type: string

  257.       label: 'Administration theme'

  258.     default:

  259.       type: string

  260.       label: 'Default theme'

  261. 

  262. system.menu.*:

  263.   type: config_entity

  264.   label: 'Menu'

  265.   mapping:

  266.     id:

  267.       type: machine_name

  268.       label: 'ID'

  269.       # Menu IDs are specifically limited to 32 characters, and allow dashes but not

  270.       # underscores.

  271.       # @see \Drupal\menu_ui\MenuForm::form()

  272.       constraints:

  273.         Regex:

  274.           pattern: '/^[a-z0-9-]+$/'

  275.           message: "The %value machine name is not valid."

  276.         Length:

  277.           max: 32

  278.     label:

  279.       type: required_label

  280.       label: 'Label'

  281.     description:

  282.       type: label

  283.       label: 'Menu description'

  284.       # @see \Drupal\menu_ui\MenuForm::form()

  285.       nullable: true

  286.       constraints:

  287.         Length:

  288.           max: 512

  289.     locked:

  290.       type: boolean

  291.       label: 'Locked'

  292.   constraints:

  293.     FullyValidatable: ~

  294. 

  295. system.action.*:

  296.   type: config_entity

  297.   label: 'System action'

  298.   constraints:

  299.     FullyValidatable: ~

  300.   mapping:

  301.     id:

  302.       type: machine_name

  303.       label: 'ID'

  304.       constraints:

  305.         # Action IDs also allow periods.

  306.         # @see user_user_role_insert()

  307.         Regex:

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

  309.           message: "The %value machine name is not valid."

  310.     label:

  311.       type: required_label

  312.       label: 'Label'

  313.     type:

  314.       type: string

  315.       label: 'Type'

  316.       # Action can be specified without type.

  317.       # @see \Drupal\action_test\Plugin\Action\NoType

  318.       nullable: true

  319.       constraints:

  320.         NotBlank:

  321.           allowNull: true

  322.     plugin:

  323.       type: string

  324.       label: 'Plugin'

  325.       constraints:

  326.         PluginExists:

  327.           manager: plugin.manager.action

  328.           interface: 'Drupal\Core\Action\ActionInterface'

  329.     configuration:

  330.       type: action.configuration.[%parent.plugin]

  331. 

  332. system.file:

  333.   type: config_object

  334.   label: 'File system'

  335.   constraints:

  336.     FullyValidatable: ~

  337.   mapping:

  338.     allow_insecure_uploads:

  339.       type: boolean

  340.       label: 'Allow insecure uploads'

  341.     default_scheme:

  342.       type: string

  343.       label: 'Default download method'

  344.       constraints:

  345.         ClassResolver:

  346.           classOrService: 'stream_wrapper_manager'

  347.           method: 'isValidScheme'

  348.     path:

  349.       type: mapping

  350.       label: 'Path settings'

  351.       deprecated: "The 'path' config schema is deprecated in drupal:11.2.0 and will be removed from drupal 12.0.0. Use 'file_temp_path' key in settings.php instead. See https://www.drupal.org/node/3039255."

  352.     temporary_maximum_age:

  353.       type: integer

  354.       label: 'Maximum age for temporary files'

  355.       constraints:

  356.         PositiveOrZero: ~

  357. 

  358. system.image:

  359.   type: config_object

  360.   label: 'Image settings'

  361.   constraints:

  362.     FullyValidatable: ~

  363.   mapping:

  364.     toolkit:

  365.       type: string

  366.       label: 'Toolkit'

  367.       constraints:

  368.         PluginExists:

  369.           manager: 'image.toolkit.manager'

  370.           interface: '\Drupal\Core\ImageToolkit\ImageToolkitInterface'

  371. 

  372. system.image.gd:

  373.   type: config_object

  374.   label: 'Image settings'

  375.   constraints:

  376.     FullyValidatable: ~

  377.   mapping:

  378.     jpeg_quality:

  379.       type: integer

  380.       label: 'JPEG quality'

  381.       constraints:

  382.         # @see \Drupal\system\Plugin\ImageToolkit\GDToolkit::buildConfigurationForm()

  383.         Range:

  384.           min: 0

  385.           max: 100

  386. 

  387. system.mail:

  388.   type: config_object

  389.   label: 'Mail system'

  390.   constraints:

  391.     FullyValidatable: ~

  392.   mapping:

  393.     interface:

  394.       type: sequence

  395.       label: 'Interfaces'

  396.       sequence:

  397.         type: string

  398.         label: 'Interface'

  399.         constraints:

  400.           PluginExists:

  401.             manager: plugin.manager.mail

  402.             interface: 'Drupal\Core\Mail\MailInterface'

  403.     mailer_dsn:

  404.       type: mailer_dsn

  405.       label: 'Symfony mailer transport DSN'

  406. 

  407. system.theme.global:

  408.   type: theme_settings

  409.   label: 'Theme global settings'

  410. 

  411. system.advisories:

  412.   type: config_object

  413.   label: 'Security advisory settings'

  414.   constraints:

  415.     FullyValidatable: ~

  416.   mapping:

  417.     enabled:

  418.       type: boolean

  419.       label: 'Display critical security advisories'

  420.     interval_hours:

  421.       type: integer

  422.       label: 'How often to check for security advisories, in hours'

  423.       # Minimum can be set to 0 as it just means the advisories will be retrieved on every call.

  424.       # @see \Drupal\system\SecurityAdvisories\SecurityAdvisoriesFetcher::getSecurityAdvisories

  425.       constraints:

  426.         PositiveOrZero: ~

  427. 

  428. block.settings.system_branding_block:

  429.   type: block_settings

  430.   label: 'Branding block'

  431.   constraints:

  432.     FullyValidatable: ~

  433.   mapping:

  434.     use_site_logo:

  435.       type: boolean

  436.       label: 'Use site logo'

  437.     use_site_name:

  438.       type: boolean

  439.       label: 'Use site name'

  440.     use_site_slogan:

  441.       type: boolean

  442.       label: 'Use site slogan'

  443. 

  444. block.settings.system_menu_block:*:

  445.   type: block_settings

  446.   label: 'Menu block'

  447.   constraints:

  448.     FullyValidatable: ~

  449.   mapping:

  450.     level:

  451.       type: integer

  452.       label: 'Starting level'

  453.       constraints:

  454.         MenuLinkDepth:

  455.           min: 0

  456.     depth:

  457.       type: integer

  458.       label: 'Maximum number of levels'

  459.       nullable: true

  460.       constraints:

  461.         MenuLinkDepth:

  462.           baseLevel: '[%parent.level]'

  463.           min: 1

  464.     expand_all_items:

  465.       type: boolean

  466.       label: 'Expand all items'

  467. 

  468. block.settings.local_tasks_block:

  469.   type: block_settings

  470.   label: 'Tabs block'

  471.   constraints:

  472.     FullyValidatable: ~

  473.   mapping:

  474.     primary:

  475.       type: boolean

  476.       label: 'Whether primary tabs are shown'

  477.     secondary:

  478.       type: boolean

  479.       label: 'Whether secondary tabs are shown'

  480. 

  481. condition.plugin.request_path:

  482.   type: condition.plugin

  483.   mapping:

  484.     pages:

  485.       type: string

  486. 

  487. condition.plugin.response_status:

  488.   type: condition.plugin

  489.   mapping:

  490.     status_codes:

  491.       type: sequence

  492.       sequence:

  493.         type: integer

  494. 

  495. system.feature_flags:

  496.   type: config_object

  497.   label: 'System Feature Flags'

  498.   constraints:

  499.     FullyValidatable: ~

  500.   mapping:

  501.     linkset_endpoint:

  502.       type: boolean

  503.       label: 'Enable the menu linkset endpoint'

  504. 

  505. condition.plugin.current_theme:

  506.   type: condition.plugin

  507.   mapping:

  508.     theme:

  509.       type: string

  510.       label: Theme

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