system.schema.yml

Same filename and directory in other branches
  1. 11.x core/modules/system/config/schema/system.schema.yml
  2. 10 core/modules/system/config/schema/system.schema.yml
  3. 9 core/modules/system/config/schema/system.schema.yml
  4. 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

View on git.drupalcode.org

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

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.       deprecated: "The 'admin_compact_mode' config is deprecated in drupal:11.5.0 and is removed from drupal:12.0.0. There is no replacement. See https://www.drupal.org/node/3588109."

  39.     weight_select_max:

  40.       type: integer

  41.       label: 'Weight element maximum value'

  42.     default_langcode:

  43.       type: langcode

  44.       label: 'Site default language code'

  45.     mail_notification:

  46.       type: string

  47.       label: 'Notification email address'

  48. 

  49. system.maintenance:

  50.   type: config_object

  51.   label: 'Maintenance mode'

  52.   constraints:

  53.     FullyValidatable: ~

  54.   mapping:

  55.     message:

  56.       type: text

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

  58. 

  59. system.cron:

  60.   type: config_object

  61.   label: 'Cron settings'

  62.   constraints:

  63.     FullyValidatable: ~

  64.   mapping:

  65.     threshold:

  66.       type: mapping

  67.       label: 'Thresholds'

  68.       mapping:

  69.         requirements_warning:

  70.           type: integer

  71.           label: 'Requirements warning period'

  72.           constraints:

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

  74.             Range:

  75.               min: 60

  76.         requirements_error:

  77.           type: integer

  78.           label: 'Requirements error period'

  79.           constraints:

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

  81.             Range:

  82.               min: 300

  83.     logging:

  84.       type: boolean

  85.       label: 'Detailed cron logging'

  86. 

  87. system.date:

  88.   type: config_object

  89.   label: 'Date settings'

  90.   constraints:

  91.     FullyValidatable: ~

  92.   mapping:

  93.     first_day:

  94.       type: integer

  95.       label: 'First day of week'

  96.       constraints:

  97.         Range:

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

  99.           min: 0

  100.           max: 6

  101.     country:

  102.       type: mapping

  103.       label: 'Country'

  104.       mapping:

  105.         default:

  106.           nullable: true

  107.           type: string

  108.           label: 'Default country'

  109.           constraints:

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

  111.             CountryCode: []

  112.     timezone:

  113.       type: mapping

  114.       label: 'Time zone settings'

  115.       mapping:

  116.         default:

  117.           type: string

  118.           label: 'Default time zone'

  119.           nullable: true

  120.           constraints:

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

  122.             Choice:

  123.               callback: 'DateTimeZone::listIdentifiers'

  124.         user:

  125.           type: mapping

  126.           label: 'User'

  127.           mapping:

  128.             configurable:

  129.               type: boolean

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

  131.             default:

  132.               type: integer

  133.               label: 'Time zone for new users'

  134.               constraints:

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

  136.                 # - UserInterface::TIMEZONE_DEFAULT

  137.                 # - UserInterface::TIMEZONE_EMPTY

  138.                 # - UserInterface::TIMEZONE_SELECT

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

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

  141.                 Choice:

  142.                   choices: [0, 1, 2]

  143.             warn:

  144.               type: boolean

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

  146. 

  147. system.diff:

  148.   type: config_object

  149.   label: 'Diff settings'

  150.   constraints:

  151.     FullyValidatable: ~

  152.   mapping:

  153.     context:

  154.       type: mapping

  155.       label: 'Context'

  156.       mapping:

  157.         lines_leading:

  158.           type: integer

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

  160.           constraints:

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

  162.             PositiveOrZero: ~

  163.         lines_trailing:

  164.           type: integer

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

  166.           constraints:

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

  168.             PositiveOrZero: ~

  169. 

  170. system.logging:

  171.   type: config_object

  172.   label: 'Logging settings'

  173.   constraints:

  174.     FullyValidatable: ~

  175.   mapping:

  176.     error_level:

  177.       type: string

  178.       label: 'Error messages to display'

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

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

  181.       constraints:

  182.         Choice:

  183.           choices:

  184.             - 'hide'

  185.             - 'some'

  186.             - 'all'

  187.             - 'verbose'

  188. 

  189. system.performance:

  190.   type: config_object

  191.   label: 'Performance settings'

  192.   mapping:

  193.     cache:

  194.       type: mapping

  195.       label: 'Caching'

  196.       mapping:

  197.         page:

  198.           type: mapping

  199.           label: 'Page caching'

  200.           mapping:

  201.             max_age:

  202.               type: integer

  203.               label: 'Max age'

  204.     css:

  205.       type: mapping

  206.       label: 'CSS performance settings'

  207.       mapping:

  208.         preprocess:

  209.           type: boolean

  210.           label: 'Aggregate CSS files'

  211.         gzip:

  212.           # @see Drupal\Core\Asset\AssetDumper::dumpToUri()

  213.           type: boolean

  214.           label: 'Compress CSS files'

  215.           deprecated: "The 'gzip' config schema is deprecated in drupal:11.4.0 and is removed from drupal:12.0.0. Use the 'compress' config schema instead. See https://www.drupal.org/node/3526344."

  216.         compress:

  217.           type: boolean

  218.           label: 'Compress CSS files'

  219.     fast_404:

  220.       type: mapping

  221.       label: 'Fast 404 settings'

  222.       mapping:

  223.         enabled:

  224.           type: boolean

  225.           label: 'Fast 404 enabled'

  226.         paths:

  227.           type: string

  228.           label: 'Regular expression to match'

  229.         exclude_paths:

  230.           type: string

  231.           label: 'Regular expression to not match'

  232.         html:

  233.           type: string

  234.           label: 'Fast 404 page html'

  235.     js:

  236.       type: mapping

  237.       label: 'JavaScript performance settings'

  238.       mapping:

  239.         preprocess:

  240.           type: boolean

  241.           label: 'JavaScript preprocess'

  242.         gzip:

  243.           # @see Drupal\Core\Asset\AssetDumper::dumpToUri()

  244.           type: boolean

  245.           label: 'Compress JavaScript files'

  246.           deprecated: "The 'gzip' config schema is deprecated in drupal:11.4.0 and is removed from drupal:12.0.0. Use the 'compress' config schema instead. See https://www.drupal.org/node/3526344."

  247.         compress:

  248.           type: boolean

  249.           label: 'Compress JavaScript files.'

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

  349.       type: integer

  350.       label: 'Maximum age for temporary files'

  351.       constraints:

  352.         PositiveOrZero: ~

  353. 

  354. system.image:

  355.   type: config_object

  356.   label: 'Image settings'

  357.   constraints:

  358.     FullyValidatable: ~

  359.   mapping:

  360.     toolkit:

  361.       type: string

  362.       label: 'Toolkit'

  363.       constraints:

  364.         PluginExists:

  365.           manager: 'image.toolkit.manager'

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

  367. 

  368. system.image.gd:

  369.   type: config_object

  370.   label: 'Image settings'

  371.   constraints:

  372.     FullyValidatable: ~

  373.   mapping:

  374.     jpeg_quality:

  375.       type: integer

  376.       label: 'JPEG quality'

  377.       constraints:

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

  379.         Range:

  380.           min: 0

  381.           max: 100

  382. 

  383. system.mail:

  384.   type: config_object

  385.   label: 'Mail system'

  386.   constraints:

  387.     FullyValidatable: ~

  388.   mapping:

  389.     interface:

  390.       type: sequence

  391.       label: 'Interfaces'

  392.       sequence:

  393.         type: string

  394.         label: 'Interface'

  395.         constraints:

  396.           PluginExists:

  397.             manager: plugin.manager.mail

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

  399.     mailer_dsn:

  400.       type: mailer_dsn

  401.       label: 'Symfony mailer transport DSN'

  402. 

  403. system.theme.global:

  404.   type: theme_settings

  405.   label: 'Theme global settings'

  406. 

  407. system.advisories:

  408.   type: config_object

  409.   label: 'Security advisory settings'

  410.   constraints:

  411.     FullyValidatable: ~

  412.   mapping:

  413.     enabled:

  414.       type: boolean

  415.       label: 'Display critical security advisories'

  416.     interval_hours:

  417.       type: integer

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

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

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

  421.       constraints:

  422.         PositiveOrZero: ~

  423. 

  424. block.settings.system_branding_block:

  425.   type: block_settings

  426.   label: 'Branding block'

  427.   constraints:

  428.     FullyValidatable: ~

  429.   mapping:

  430.     use_site_logo:

  431.       type: boolean

  432.       label: 'Use site logo'

  433.     use_site_name:

  434.       type: boolean

  435.       label: 'Use site name'

  436.     use_site_slogan:

  437.       type: boolean

  438.       label: 'Use site slogan'

  439. 

  440. block.settings.system_menu_block:*:

  441.   type: block_settings

  442.   label: 'Menu block'

  443.   constraints:

  444.     FullyValidatable: ~

  445.     IgnoreActiveTrail: ~

  446.   mapping:

  447.     level:

  448.       type: integer

  449.       label: 'Starting level'

  450.       constraints:

  451.         MenuLinkDepth:

  452.           min: 0

  453.     depth:

  454.       type: integer

  455.       label: 'Maximum number of levels'

  456.       nullable: true

  457.       constraints:

  458.         MenuLinkDepth:

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

  460.           min: 1

  461.     expand_all_items:

  462.       type: boolean

  463.       label: 'Expand all items'

  464.     ignore_active_trail:

  465.       type: boolean

  466.       label: 'Ignore active trail'

  467.       requiredKey: false

  468. 

  469. block.settings.local_tasks_block:

  470.   type: block_settings

  471.   label: 'Tabs block'

  472.   constraints:

  473.     FullyValidatable: ~

  474.   mapping:

  475.     primary:

  476.       type: boolean

  477.       label: 'Whether primary tabs are shown'

  478.     secondary:

  479.       type: boolean

  480.       label: 'Whether secondary tabs are shown'

  481. 

  482. condition.plugin.request_path:

  483.   type: condition.plugin

  484.   mapping:

  485.     pages:

  486.       type: string

  487. 

  488. condition.plugin.response_status:

  489.   type: condition.plugin

  490.   constraints:

  491.     FullyValidatable: ~

  492.   mapping:

  493.     status_codes:

  494.       type: sequence

  495.       sequence:

  496.         type: integer

  497.         constraints:

  498.           # @see \Drupal\system\Plugin\Condition\ResponseStatus::buildConfigurationForm()

  499.           Choice:

  500.             # HTTP 200 OK, HTTP 403 FORBIDDEN, HTTP 404 NOT FOUND.

  501.             choices: [200, 403, 404]

  502. 

  503. system.feature_flags:

  504.   type: config_object

  505.   label: 'System Feature Flags'

  506.   constraints:

  507.     FullyValidatable: ~

  508.   mapping:

  509.     linkset_endpoint:

  510.       type: boolean

  511.       label: 'Enable the menu linkset endpoint'

  512. 

  513. condition.plugin.current_theme:

  514.   type: condition.plugin

  515.   mapping:

  516.     theme:

  517.       type: string

  518.       label: Theme

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