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

  36.       type: integer

  37.       label: 'Weight element maximum value'

  38.     default_langcode:

  39.       type: langcode

  40.       label: 'Site default language code'

  41.     mail_notification:

  42.       type: string

  43.       label: 'Notification email address'

  44. 

  45. system.maintenance:

  46.   type: config_object

  47.   label: 'Maintenance mode'

  48.   constraints:

  49.     FullyValidatable: ~

  50.   mapping:

  51.     message:

  52.       type: text

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

  54. 

  55. system.cron:

  56.   type: config_object

  57.   label: 'Cron settings'

  58.   constraints:

  59.     FullyValidatable: ~

  60.   mapping:

  61.     threshold:

  62.       type: mapping

  63.       label: 'Thresholds'

  64.       mapping:

  65.         requirements_warning:

  66.           type: integer

  67.           label: 'Requirements warning period'

  68.           constraints:

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

  70.             Range:

  71.               min: 60

  72.         requirements_error:

  73.           type: integer

  74.           label: 'Requirements error period'

  75.           constraints:

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

  77.             Range:

  78.               min: 300

  79.     logging:

  80.       type: boolean

  81.       label: 'Detailed cron logging'

  82. 

  83. system.date:

  84.   type: config_object

  85.   label: 'Date settings'

  86.   constraints:

  87.     FullyValidatable: ~

  88.   mapping:

  89.     first_day:

  90.       type: integer

  91.       label: 'First day of week'

  92.       constraints:

  93.         Range:

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

  95.           min: 0

  96.           max: 6

  97.     country:

  98.       type: mapping

  99.       label: 'Country'

  100.       mapping:

  101.         default:

  102.           nullable: true

  103.           type: string

  104.           label: 'Default country'

  105.           constraints:

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

  107.             CountryCode: []

  108.     timezone:

  109.       type: mapping

  110.       label: 'Time zone settings'

  111.       mapping:

  112.         default:

  113.           type: string

  114.           label: 'Default time zone'

  115.           nullable: true

  116.           constraints:

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

  118.             Choice:

  119.               callback: 'DateTimeZone::listIdentifiers'

  120.         user:

  121.           type: mapping

  122.           label: 'User'

  123.           mapping:

  124.             configurable:

  125.               type: boolean

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

  127.             default:

  128.               type: integer

  129.               label: 'Time zone for new users'

  130.               constraints:

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

  132.                 # - UserInterface::TIMEZONE_DEFAULT

  133.                 # - UserInterface::TIMEZONE_EMPTY

  134.                 # - UserInterface::TIMEZONE_SELECT

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

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

  137.                 Choice:

  138.                   choices: [0, 1, 2]

  139.             warn:

  140.               type: boolean

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

  142. 

  143. system.diff:

  144.   type: config_object

  145.   label: 'Diff settings'

  146.   constraints:

  147.     FullyValidatable: ~

  148.   mapping:

  149.     context:

  150.       type: mapping

  151.       label: 'Context'

  152.       mapping:

  153.         lines_leading:

  154.           type: integer

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

  156.           constraints:

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

  158.             PositiveOrZero: ~

  159.         lines_trailing:

  160.           type: integer

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

  162.           constraints:

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

  164.             PositiveOrZero: ~

  165. 

  166. system.logging:

  167.   type: config_object

  168.   label: 'Logging settings'

  169.   constraints:

  170.     FullyValidatable: ~

  171.   mapping:

  172.     error_level:

  173.       type: string

  174.       label: 'Error messages to display'

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

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

  177.       constraints:

  178.         Choice:

  179.           choices:

  180.             - 'hide'

  181.             - 'some'

  182.             - 'all'

  183.             - 'verbose'

  184. 

  185. system.performance:

  186.   type: config_object

  187.   label: 'Performance settings'

  188.   mapping:

  189.     cache:

  190.       type: mapping

  191.       label: 'Caching'

  192.       mapping:

  193.         page:

  194.           type: mapping

  195.           label: 'Page caching'

  196.           mapping:

  197.             max_age:

  198.               type: integer

  199.               label: 'Max age'

  200.     css:

  201.       type: mapping

  202.       label: 'CSS performance settings'

  203.       mapping:

  204.         preprocess:

  205.           type: boolean

  206.           label: 'Aggregate CSS files'

  207.         compress:

  208.           type: boolean

  209.           label: 'Compress CSS files'

  210.     fast_404:

  211.       type: mapping

  212.       label: 'Fast 404 settings'

  213.       mapping:

  214.         enabled:

  215.           type: boolean

  216.           label: 'Fast 404 enabled'

  217.         paths:

  218.           type: string

  219.           label: 'Regular expression to match'

  220.         exclude_paths:

  221.           type: string

  222.           label: 'Regular expression to not match'

  223.         html:

  224.           type: string

  225.           label: 'Fast 404 page html'

  226.     js:

  227.       type: mapping

  228.       label: 'JavaScript performance settings'

  229.       mapping:

  230.         preprocess:

  231.           type: boolean

  232.           label: 'JavaScript preprocess'

  233.         compress:

  234.           type: boolean

  235.           label: 'Compress JavaScript files.'

  236. 

  237. system.theme:

  238.   type: config_object

  239.   label: 'Theme settings'

  240.   mapping:

  241.     admin:

  242.       type: string

  243.       label: 'Administration theme'

  244.     default:

  245.       type: string

  246.       label: 'Default theme'

  247. 

  248. system.menu.*:

  249.   type: config_entity

  250.   label: 'Menu'

  251.   mapping:

  252.     id:

  253.       type: machine_name

  254.       label: 'ID'

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

  256.       # underscores.

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

  258.       constraints:

  259.         Regex:

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

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

  262.         Length:

  263.           max: 32

  264.     label:

  265.       type: required_label

  266.       label: 'Label'

  267.     description:

  268.       type: label

  269.       label: 'Menu description'

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

  271.       nullable: true

  272.       constraints:

  273.         Length:

  274.           max: 512

  275.     locked:

  276.       type: boolean

  277.       label: 'Locked'

  278.   constraints:

  279.     FullyValidatable: ~

  280. 

  281. system.action.*:

  282.   type: config_entity

  283.   label: 'System action'

  284.   constraints:

  285.     FullyValidatable: ~

  286.   mapping:

  287.     id:

  288.       type: machine_name

  289.       label: 'ID'

  290.       constraints:

  291.         # Action IDs also allow periods.

  292.         # @see user_user_role_insert()

  293.         Regex:

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

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

  296.     label:

  297.       type: required_label

  298.       label: 'Label'

  299.     type:

  300.       type: string

  301.       label: 'Type'

  302.       # Action can be specified without type.

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

  304.       nullable: true

  305.       constraints:

  306.         NotBlank:

  307.           allowNull: true

  308.     plugin:

  309.       type: string

  310.       label: 'Plugin'

  311.       constraints:

  312.         PluginExists:

  313.           manager: plugin.manager.action

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

  315.     configuration:

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

  317. 

  318. system.file:

  319.   type: config_object

  320.   label: 'File system'

  321.   constraints:

  322.     FullyValidatable: ~

  323.   mapping:

  324.     allow_insecure_uploads:

  325.       type: boolean

  326.       label: 'Allow insecure uploads'

  327.     default_scheme:

  328.       type: string

  329.       label: 'Default download method'

  330.       constraints:

  331.         ClassResolver:

  332.           classOrService: 'stream_wrapper_manager'

  333.           method: 'isValidScheme'

  334.     temporary_maximum_age:

  335.       type: integer

  336.       label: 'Maximum age for temporary files'

  337.       constraints:

  338.         PositiveOrZero: ~

  339. 

  340. system.image:

  341.   type: config_object

  342.   label: 'Image settings'

  343.   constraints:

  344.     FullyValidatable: ~

  345.   mapping:

  346.     toolkit:

  347.       type: string

  348.       label: 'Toolkit'

  349.       constraints:

  350.         PluginExists:

  351.           manager: 'image.toolkit.manager'

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

  353. 

  354. system.image.gd:

  355.   type: config_object

  356.   label: 'Image settings'

  357.   constraints:

  358.     FullyValidatable: ~

  359.   mapping:

  360.     jpeg_quality:

  361.       type: integer

  362.       label: 'JPEG quality'

  363.       constraints:

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

  365.         Range:

  366.           min: 0

  367.           max: 100

  368. 

  369. system.mail:

  370.   type: config_object

  371.   label: 'Mail system'

  372.   constraints:

  373.     FullyValidatable: ~

  374.   mapping:

  375.     interface:

  376.       type: sequence

  377.       label: 'Interfaces'

  378.       sequence:

  379.         type: string

  380.         label: 'Interface'

  381.         constraints:

  382.           PluginExists:

  383.             manager: plugin.manager.mail

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

  385.     mailer_dsn:

  386.       type: mailer_dsn

  387.       label: 'Symfony mailer transport DSN'

  388. 

  389. system.theme.global:

  390.   type: theme_settings

  391.   label: 'Theme global settings'

  392. 

  393. system.advisories:

  394.   type: config_object

  395.   label: 'Security advisory settings'

  396.   constraints:

  397.     FullyValidatable: ~

  398.   mapping:

  399.     enabled:

  400.       type: boolean

  401.       label: 'Display critical security advisories'

  402.     interval_hours:

  403.       type: integer

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

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

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

  407.       constraints:

  408.         PositiveOrZero: ~

  409. 

  410. block.settings.system_branding_block:

  411.   type: block_settings

  412.   label: 'Branding block'

  413.   constraints:

  414.     FullyValidatable: ~

  415.   mapping:

  416.     use_site_logo:

  417.       type: boolean

  418.       label: 'Use site logo'

  419.     use_site_name:

  420.       type: boolean

  421.       label: 'Use site name'

  422.     use_site_slogan:

  423.       type: boolean

  424.       label: 'Use site slogan'

  425. 

  426. block.settings.system_menu_block:*:

  427.   type: block_settings

  428.   label: 'Menu block'

  429.   constraints:

  430.     FullyValidatable: ~

  431.     IgnoreActiveTrail: ~

  432.   mapping:

  433.     level:

  434.       type: integer

  435.       label: 'Starting level'

  436.       constraints:

  437.         MenuLinkDepth:

  438.           min: 0

  439.     depth:

  440.       type: integer

  441.       label: 'Maximum number of levels'

  442.       nullable: true

  443.       constraints:

  444.         MenuLinkDepth:

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

  446.           min: 1

  447.     expand_all_items:

  448.       type: boolean

  449.       label: 'Expand all items'

  450.     ignore_active_trail:

  451.       type: boolean

  452.       label: 'Ignore active trail'

  453.       requiredKey: false

  454. 

  455. block.settings.local_tasks_block:

  456.   type: block_settings

  457.   label: 'Tabs block'

  458.   constraints:

  459.     FullyValidatable: ~

  460.   mapping:

  461.     primary:

  462.       type: boolean

  463.       label: 'Whether primary tabs are shown'

  464.     secondary:

  465.       type: boolean

  466.       label: 'Whether secondary tabs are shown'

  467. 

  468. condition.plugin.request_path:

  469.   type: condition.plugin

  470.   mapping:

  471.     pages:

  472.       type: string

  473. 

  474. condition.plugin.response_status:

  475.   type: condition.plugin

  476.   constraints:

  477.     FullyValidatable: ~

  478.   mapping:

  479.     status_codes:

  480.       type: sequence

  481.       sequence:

  482.         type: integer

  483.         constraints:

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

  485.           Choice:

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

  487.             choices: [200, 403, 404]

  488. 

  489. system.feature_flags:

  490.   type: config_object

  491.   label: 'System Feature Flags'

  492.   constraints:

  493.     FullyValidatable: ~

  494.   mapping:

  495.     linkset_endpoint:

  496.       type: boolean

  497.       label: 'Enable the menu linkset endpoint'

  498. 

  499. condition.plugin.current_theme:

  500.   type: condition.plugin

  501.   mapping:

  502.     theme:

  503.       type: string

  504.       label: Theme

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