system.schema.yml

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

File

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 system_requirements()

  73.             Range:

  74.               min: 60

  75.         requirements_error:

  76.           type: integer

  77.           label: 'Requirements error period'

  78.           constraints:

  79.             # @see system_requirements()

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

  161.               min: 0

  162.         lines_trailing:

  163.           type: integer

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

  165.           constraints:

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

  167.             Range:

  168.               min: 0

  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.           type: boolean

  213.           label: 'Compress CSS files'

  214.     fast_404:

  215.       type: mapping

  216.       label: 'Fast 404 settings'

  217.       mapping:

  218.         enabled:

  219.           type: boolean

  220.           label: 'Fast 404 enabled'

  221.         paths:

  222.           type: string

  223.           label: 'Regular expression to match'

  224.         exclude_paths:

  225.           type: string

  226.           label: 'Regular expression to not match'

  227.         html:

  228.           type: string

  229.           label: 'Fast 404 page html'

  230.     js:

  231.       type: mapping

  232.       label: 'JavaScript performance settings'

  233.       mapping:

  234.         preprocess:

  235.           type: boolean

  236.           label: 'JavaScript preprocess'

  237.         gzip:

  238.           type: boolean

  239.           label: 'Compress JavaScript files.'

  240. 

  241. system.rss:

  242.   type: config_object

  243.   label: 'Feed settings'

  244.   mapping:

  245.     items:

  246.       type: mapping

  247.       label: 'Feed items'

  248.       mapping:

  249.         view_mode:

  250.           type: string

  251.           label: 'Feed content'

  252. 

  253. system.theme:

  254.   type: config_object

  255.   label: 'Theme settings'

  256.   mapping:

  257.     admin:

  258.       type: string

  259.       label: 'Administration theme'

  260.     default:

  261.       type: string

  262.       label: 'Default theme'

  263. 

  264. system.menu.*:

  265.   type: config_entity

  266.   label: 'Menu'

  267.   mapping:

  268.     id:

  269.       type: machine_name

  270.       label: 'ID'

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

  272.       # underscores.

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

  274.       constraints:

  275.         Regex:

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

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

  278.         Length:

  279.           max: 32

  280.     label:

  281.       type: required_label

  282.       label: 'Label'

  283.     description:

  284.       type: label

  285.       label: 'Menu description'

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

  287.       nullable: true

  288.       constraints:

  289.         Length:

  290.           max: 512

  291.     locked:

  292.       type: boolean

  293.       label: 'Locked'

  294.   constraints:

  295.     FullyValidatable: ~

  296. 

  297. system.action.*:

  298.   type: config_entity

  299.   label: 'System action'

  300.   constraints:

  301.     FullyValidatable: ~

  302.   mapping:

  303.     id:

  304.       type: machine_name

  305.       label: 'ID'

  306.       constraints:

  307.         # Action IDs also allow periods.

  308.         # @see user_user_role_insert()

  309.         Regex:

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

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

  312.     label:

  313.       type: required_label

  314.       label: 'Label'

  315.     type:

  316.       type: string

  317.       label: 'Type'

  318.       # Action can be specified without type.

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

  320.       nullable: true

  321.       constraints:

  322.         NotBlank:

  323.           allowNull: true

  324.     plugin:

  325.       type: string

  326.       label: 'Plugin'

  327.       constraints:

  328.         PluginExists:

  329.           manager: plugin.manager.action

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

  331.     configuration:

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

  333. 

  334. system.file:

  335.   type: config_object

  336.   label: 'File system'

  337.   constraints:

  338.     FullyValidatable: ~

  339.   mapping:

  340.     allow_insecure_uploads:

  341.       type: boolean

  342.       label: 'Allow insecure uploads'

  343.     default_scheme:

  344.       type: string

  345.       label: 'Default download method'

  346.       constraints:

  347.         ClassResolver:

  348.           classOrService: 'stream_wrapper_manager'

  349.           method: 'isValidScheme'

  350.     path:

  351.       type: mapping

  352.       label: 'Path settings'

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

  354.     temporary_maximum_age:

  355.       type: integer

  356.       label: 'Maximum age for temporary files'

  357.       constraints:

  358.         Range:

  359.           min: 0

  360. 

  361. system.image:

  362.   type: config_object

  363.   label: 'Image settings'

  364.   constraints:

  365.     FullyValidatable: ~

  366.   mapping:

  367.     toolkit:

  368.       type: string

  369.       label: 'Toolkit'

  370.       constraints:

  371.         PluginExists:

  372.           manager: 'image.toolkit.manager'

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

  374. 

  375. system.image.gd:

  376.   type: config_object

  377.   label: 'Image settings'

  378.   constraints:

  379.     FullyValidatable: ~

  380.   mapping:

  381.     jpeg_quality:

  382.       type: integer

  383.       label: 'JPEG quality'

  384.       constraints:

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

  386.         Range:

  387.           min: 0

  388.           max: 100

  389. 

  390. system.mail:

  391.   type: config_object

  392.   label: 'Mail system'

  393.   constraints:

  394.     FullyValidatable: ~

  395.   mapping:

  396.     interface:

  397.       type: sequence

  398.       label: 'Interfaces'

  399.       sequence:

  400.         type: string

  401.         label: 'Interface'

  402.         constraints:

  403.           PluginExists:

  404.             manager: plugin.manager.mail

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

  406.     mailer_dsn:

  407.       type: mailer_dsn

  408.       label: 'Symfony mailer transport DSN'

  409. 

  410. system.theme.global:

  411.   type: theme_settings

  412.   label: 'Theme global settings'

  413. 

  414. system.advisories:

  415.   type: config_object

  416.   label: 'Security advisory settings'

  417.   constraints:

  418.     FullyValidatable: ~

  419.   mapping:

  420.     enabled:

  421.       type: boolean

  422.       label: 'Display critical security advisories'

  423.     interval_hours:

  424.       type: integer

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

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

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

  428.       constraints:

  429.         Range:

  430.           min: 0

  431. 

  432. block.settings.system_branding_block:

  433.   type: block_settings

  434.   label: 'Branding block'

  435.   constraints:

  436.     FullyValidatable: ~

  437.   mapping:

  438.     use_site_logo:

  439.       type: boolean

  440.       label: 'Use site logo'

  441.     use_site_name:

  442.       type: boolean

  443.       label: 'Use site name'

  444.     use_site_slogan:

  445.       type: boolean

  446.       label: 'Use site slogan'

  447. 

  448. block.settings.system_menu_block:*:

  449.   type: block_settings

  450.   label: 'Menu block'

  451.   mapping:

  452.     level:

  453.       type: integer

  454.       label: 'Starting level'

  455.     depth:

  456.       type: integer

  457.       label: 'Maximum number of levels'

  458.     expand_all_items:

  459.       type: boolean

  460.       label: 'Expand all items'

  461. 

  462. block.settings.local_tasks_block:

  463.   type: block_settings

  464.   label: 'Tabs block'

  465.   constraints:

  466.     FullyValidatable: ~

  467.   mapping:

  468.     primary:

  469.       type: boolean

  470.       label: 'Whether primary tabs are shown'

  471.     secondary:

  472.       type: boolean

  473.       label: 'Whether secondary tabs are shown'

  474. 

  475. condition.plugin.request_path:

  476.   type: condition.plugin

  477.   mapping:

  478.     pages:

  479.       type: string

  480. 

  481. condition.plugin.response_status:

  482.   type: condition.plugin

  483.   mapping:

  484.     status_codes:

  485.       type: sequence

  486.       sequence:

  487.         type: integer

  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.