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
  4. main 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.     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:

  141.                   choices: [0, 1, 2]

  142.             warn:

  143.               type: boolean

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

  145. 

  146. system.diff:

  147.   type: config_object

  148.   label: 'Diff settings'

  149.   constraints:

  150.     FullyValidatable: ~

  151.   mapping:

  152.     context:

  153.       type: mapping

  154.       label: 'Context'

  155.       mapping:

  156.         lines_leading:

  157.           type: integer

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

  159.           constraints:

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

  161.             PositiveOrZero: ~

  162.         lines_trailing:

  163.           type: integer

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

  165.           constraints:

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

  167.             PositiveOrZero: ~

  168. 

  169. system.logging:

  170.   type: config_object

  171.   label: 'Logging settings'

  172.   constraints:

  173.     FullyValidatable: ~

  174.   mapping:

  175.     error_level:

  176.       type: string

  177.       label: 'Error messages to display'

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

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

  180.       constraints:

  181.         Choice:

  182.           choices:

  183.             - 'hide'

  184.             - 'some'

  185.             - 'all'

  186.             - 'verbose'

  187. 

  188. system.performance:

  189.   type: config_object

  190.   label: 'Performance settings'

  191.   mapping:

  192.     cache:

  193.       type: mapping

  194.       label: 'Caching'

  195.       mapping:

  196.         page:

  197.           type: mapping

  198.           label: 'Page caching'

  199.           mapping:

  200.             max_age:

  201.               type: integer

  202.               label: 'Max age'

  203.     css:

  204.       type: mapping

  205.       label: 'CSS performance settings'

  206.       mapping:

  207.         preprocess:

  208.           type: boolean

  209.           label: 'Aggregate CSS files'

  210.         gzip:

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

  212.           type: boolean

  213.           label: 'Compress CSS files'

  214.           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."

  215.         compress:

  216.           type: boolean

  217.           label: 'Compress CSS files'

  218.     fast_404:

  219.       type: mapping

  220.       label: 'Fast 404 settings'

  221.       mapping:

  222.         enabled:

  223.           type: boolean

  224.           label: 'Fast 404 enabled'

  225.         paths:

  226.           type: string

  227.           label: 'Regular expression to match'

  228.         exclude_paths:

  229.           type: string

  230.           label: 'Regular expression to not match'

  231.         html:

  232.           type: string

  233.           label: 'Fast 404 page html'

  234.     js:

  235.       type: mapping

  236.       label: 'JavaScript performance settings'

  237.       mapping:

  238.         preprocess:

  239.           type: boolean

  240.           label: 'JavaScript preprocess'

  241.         gzip:

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

  243.           type: boolean

  244.           label: 'Compress JavaScript files'

  245.           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."

  246.         compress:

  247.           type: boolean

  248.           label: 'Compress JavaScript files.'

  249. 

  250. system.theme:

  251.   type: config_object

  252.   label: 'Theme settings'

  253.   mapping:

  254.     admin:

  255.       type: string

  256.       label: 'Administration theme'

  257.     default:

  258.       type: string

  259.       label: 'Default theme'

  260. 

  261. system.menu.*:

  262.   type: config_entity

  263.   label: 'Menu'

  264.   mapping:

  265.     id:

  266.       type: machine_name

  267.       label: 'ID'

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

  269.       # underscores.

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

  271.       constraints:

  272.         Regex:

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

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

  275.         Length:

  276.           max: 32

  277.     label:

  278.       type: required_label

  279.       label: 'Label'

  280.     description:

  281.       type: label

  282.       label: 'Menu description'

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

  284.       nullable: true

  285.       constraints:

  286.         Length:

  287.           max: 512

  288.     locked:

  289.       type: boolean

  290.       label: 'Locked'

  291.   constraints:

  292.     FullyValidatable: ~

  293. 

  294. system.action.*:

  295.   type: config_entity

  296.   label: 'System action'

  297.   constraints:

  298.     FullyValidatable: ~

  299.   mapping:

  300.     id:

  301.       type: machine_name

  302.       label: 'ID'

  303.       constraints:

  304.         # Action IDs also allow periods.

  305.         # @see user_user_role_insert()

  306.         Regex:

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

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

  309.     label:

  310.       type: required_label

  311.       label: 'Label'

  312.     type:

  313.       type: string

  314.       label: 'Type'

  315.       # Action can be specified without type.

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

  317.       nullable: true

  318.       constraints:

  319.         NotBlank:

  320.           allowNull: true

  321.     plugin:

  322.       type: string

  323.       label: 'Plugin'

  324.       constraints:

  325.         PluginExists:

  326.           manager: plugin.manager.action

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

  328.     configuration:

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

  330. 

  331. system.file:

  332.   type: config_object

  333.   label: 'File system'

  334.   constraints:

  335.     FullyValidatable: ~

  336.   mapping:

  337.     allow_insecure_uploads:

  338.       type: boolean

  339.       label: 'Allow insecure uploads'

  340.     default_scheme:

  341.       type: string

  342.       label: 'Default download method'

  343.       constraints:

  344.         ClassResolver:

  345.           classOrService: 'stream_wrapper_manager'

  346.           method: 'isValidScheme'

  347.     path:

  348.       type: mapping

  349.       label: 'Path settings'

  350.       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."

  351.     temporary_maximum_age:

  352.       type: integer

  353.       label: 'Maximum age for temporary files'

  354.       constraints:

  355.         PositiveOrZero: ~

  356. 

  357. system.image:

  358.   type: config_object

  359.   label: 'Image settings'

  360.   constraints:

  361.     FullyValidatable: ~

  362.   mapping:

  363.     toolkit:

  364.       type: string

  365.       label: 'Toolkit'

  366.       constraints:

  367.         PluginExists:

  368.           manager: 'image.toolkit.manager'

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

  370. 

  371. system.image.gd:

  372.   type: config_object

  373.   label: 'Image settings'

  374.   constraints:

  375.     FullyValidatable: ~

  376.   mapping:

  377.     jpeg_quality:

  378.       type: integer

  379.       label: 'JPEG quality'

  380.       constraints:

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

  382.         Range:

  383.           min: 0

  384.           max: 100

  385. 

  386. system.mail:

  387.   type: config_object

  388.   label: 'Mail system'

  389.   constraints:

  390.     FullyValidatable: ~

  391.   mapping:

  392.     interface:

  393.       type: sequence

  394.       label: 'Interfaces'

  395.       sequence:

  396.         type: string

  397.         label: 'Interface'

  398.         constraints:

  399.           PluginExists:

  400.             manager: plugin.manager.mail

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

  402.     mailer_dsn:

  403.       type: mailer_dsn

  404.       label: 'Symfony mailer transport DSN'

  405. 

  406. system.theme.global:

  407.   type: theme_settings

  408.   label: 'Theme global settings'

  409. 

  410. system.advisories:

  411.   type: config_object

  412.   label: 'Security advisory settings'

  413.   constraints:

  414.     FullyValidatable: ~

  415.   mapping:

  416.     enabled:

  417.       type: boolean

  418.       label: 'Display critical security advisories'

  419.     interval_hours:

  420.       type: integer

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

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

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

  424.       constraints:

  425.         PositiveOrZero: ~

  426. 

  427. block.settings.system_branding_block:

  428.   type: block_settings

  429.   label: 'Branding block'

  430.   constraints:

  431.     FullyValidatable: ~

  432.   mapping:

  433.     use_site_logo:

  434.       type: boolean

  435.       label: 'Use site logo'

  436.     use_site_name:

  437.       type: boolean

  438.       label: 'Use site name'

  439.     use_site_slogan:

  440.       type: boolean

  441.       label: 'Use site slogan'

  442. 

  443. block.settings.system_menu_block:*:

  444.   type: block_settings

  445.   label: 'Menu block'

  446.   constraints:

  447.     FullyValidatable: ~

  448.     IgnoreActiveTrail: ~

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

  468.       type: boolean

  469.       label: 'Ignore active trail'

  470.       requiredKey: false

  471. 

  472. block.settings.local_tasks_block:

  473.   type: block_settings

  474.   label: 'Tabs block'

  475.   constraints:

  476.     FullyValidatable: ~

  477.   mapping:

  478.     primary:

  479.       type: boolean

  480.       label: 'Whether primary tabs are shown'

  481.     secondary:

  482.       type: boolean

  483.       label: 'Whether secondary tabs are shown'

  484. 

  485. condition.plugin.request_path:

  486.   type: condition.plugin

  487.   mapping:

  488.     pages:

  489.       type: string

  490. 

  491. condition.plugin.response_status:

  492.   type: condition.plugin

  493.   constraints:

  494.     FullyValidatable: ~

  495.   mapping:

  496.     status_codes:

  497.       type: sequence

  498.       sequence:

  499.         type: integer

  500.         constraints:

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

  502.           Choice:

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

  504.             choices: [200, 403, 404]

  505. 

  506. system.feature_flags:

  507.   type: config_object

  508.   label: 'System Feature Flags'

  509.   constraints:

  510.     FullyValidatable: ~

  511.   mapping:

  512.     linkset_endpoint:

  513.       type: boolean

  514.       label: 'Enable the menu linkset endpoint'

  515. 

  516. condition.plugin.current_theme:

  517.   type: condition.plugin

  518.   mapping:

  519.     theme:

  520.       type: string

  521.       label: Theme

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