system.schema.yml

Same filename and directory 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
2 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.

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

  174.     error_level:

  175.       type: string

  176.       label: 'Error messages to display'

  177. 

  178. system.performance:

  179.   type: config_object

  180.   label: 'Performance settings'

  181.   mapping:

  182.     cache:

  183.       type: mapping

  184.       label: 'Caching'

  185.       mapping:

  186.         page:

  187.           type: mapping

  188.           label: 'Page caching'

  189.           mapping:

  190.             max_age:

  191.               type: integer

  192.               label: 'Max age'

  193.     css:

  194.       type: mapping

  195.       label: 'CSS performance settings'

  196.       mapping:

  197.         preprocess:

  198.           type: boolean

  199.           label: 'Aggregate CSS files'

  200.         gzip:

  201.           type: boolean

  202.           label: 'Compress CSS files'

  203.     fast_404:

  204.       type: mapping

  205.       label: 'Fast 404 settings'

  206.       mapping:

  207.         enabled:

  208.           type: boolean

  209.           label: 'Fast 404 enabled'

  210.         paths:

  211.           type: string

  212.           label: 'Regular expression to match'

  213.         exclude_paths:

  214.           type: string

  215.           label: 'Regular expression to not match'

  216.         html:

  217.           type: string

  218.           label: 'Fast 404 page html'

  219.     js:

  220.       type: mapping

  221.       label: 'JavaScript performance settings'

  222.       mapping:

  223.         preprocess:

  224.           type: boolean

  225.           label: 'JavaScript preprocess'

  226.         gzip:

  227.           type: boolean

  228.           label: 'Compress JavaScript files.'

  229. 

  230. system.rss:

  231.   type: config_object

  232.   label: 'Feed settings'

  233.   mapping:

  234.     items:

  235.       type: mapping

  236.       label: 'Feed items'

  237.       mapping:

  238.         view_mode:

  239.           type: string

  240.           label: 'Feed content'

  241. 

  242. system.theme:

  243.   type: config_object

  244.   label: 'Theme settings'

  245.   mapping:

  246.     admin:

  247.       type: string

  248.       label: 'Administration theme'

  249.     default:

  250.       type: string

  251.       label: 'Default theme'

  252. 

  253. system.menu.*:

  254.   type: config_entity

  255.   label: 'Menu'

  256.   mapping:

  257.     id:

  258.       type: machine_name

  259.       label: 'ID'

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

  261.       # underscores.

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

  263.       constraints:

  264.         Regex:

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

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

  267.         Length:

  268.           max: 32

  269.     label:

  270.       type: required_label

  271.       label: 'Label'

  272.     description:

  273.       type: label

  274.       label: 'Menu description'

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

  276.       nullable: true

  277.       constraints:

  278.         Length:

  279.           max: 512

  280.     locked:

  281.       type: boolean

  282.       label: 'Locked'

  283.   constraints:

  284.     FullyValidatable: ~

  285. 

  286. system.action.*:

  287.   type: config_entity

  288.   label: 'System action'

  289.   mapping:

  290.     id:

  291.       type: machine_name

  292.       label: 'ID'

  293.       constraints:

  294.         # Action IDs also allow periods.

  295.         # @see user_user_role_insert()

  296.         Regex:

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

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

  299.     label:

  300.       type: required_label

  301.       label: 'Label'

  302.     type:

  303.       type: string

  304.       label: 'Type'

  305.     plugin:

  306.       type: string

  307.       label: 'Plugin'

  308.       constraints:

  309.         PluginExists:

  310.           manager: plugin.manager.action

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

  312.     configuration:

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

  314. 

  315. system.file:

  316.   type: config_object

  317.   label: 'File system'

  318.   mapping:

  319.     allow_insecure_uploads:

  320.       type: boolean

  321.       label: 'Allow insecure uploads'

  322.     default_scheme:

  323.       type: string

  324.       label: 'Default download method'

  325.     path:

  326.       type: mapping

  327.       label: 'Path settings'

  328.     temporary_maximum_age:

  329.       type: integer

  330.       label: 'Maximum age for temporary files'

  331. 

  332. system.image:

  333.   type: config_object

  334.   label: 'Image settings'

  335.   constraints:

  336.     FullyValidatable: ~

  337.   mapping:

  338.     toolkit:

  339.       type: string

  340.       label: 'Toolkit'

  341.       constraints:

  342.         PluginExists:

  343.           manager: 'image.toolkit.manager'

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

  345. 

  346. system.image.gd:

  347.   type: config_object

  348.   label: 'Image settings'

  349.   constraints:

  350.     FullyValidatable: ~

  351.   mapping:

  352.     jpeg_quality:

  353.       type: integer

  354.       label: 'JPEG quality'

  355.       constraints:

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

  357.         Range:

  358.           min: 0

  359.           max: 100

  360. 

  361. system.mail:

  362.   type: config_object

  363.   label: 'Mail system'

  364.   mapping:

  365.     interface:

  366.       type: sequence

  367.       label: 'Interfaces'

  368.       sequence:

  369.         type: string

  370.         label: 'Interface'

  371.         constraints:

  372.           PluginExists:

  373.             manager: plugin.manager.mail

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

  375.     mailer_dsn:

  376.       type: mapping

  377.       label: 'Symfony mailer transport DSN'

  378.       mapping:

  379.         scheme:

  380.           type: string

  381.           label: 'Scheme'

  382.           constraints:

  383.             NotBlank:

  384.               message: 'The mailer DSN must contain a scheme.'

  385.         host:

  386.           type: string

  387.           label: 'Host'

  388.           constraints:

  389.             NotBlank:

  390.               message: 'The mailer DSN must contain a host (use "default" by default).'

  391.         user:

  392.           type: string

  393.           nullable: true

  394.           label: 'User'

  395.         password:

  396.           type: string

  397.           nullable: true

  398.           label: 'Password'

  399.         port:

  400.           type: integer

  401.           nullable: true

  402.           label: 'Port'

  403.           constraints:

  404.             Range:

  405.               min: 0

  406.               max: 65535

  407.         options:

  408.           type: sequence

  409.           label: 'Options'

  410.           sequence:

  411.             type: string

  412.             label: Option

  413.             constraints:

  414.               NotNull: []

  415. 

  416. system.theme.global:

  417.   type: theme_settings

  418.   label: 'Theme global settings'

  419. 

  420. system.advisories:

  421.   type: config_object

  422.   label: 'Security advisory settings'

  423.   constraints:

  424.     FullyValidatable: ~

  425.   mapping:

  426.     enabled:

  427.       type: boolean

  428.       label: 'Display critical security advisories'

  429.     interval_hours:

  430.       type: integer

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

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

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

  434.       constraints:

  435.         Range:

  436.           min: 0

  437. 

  438. block.settings.system_branding_block:

  439.   type: block_settings

  440.   label: 'Branding block'

  441.   constraints:

  442.     FullyValidatable: ~

  443.   mapping:

  444.     use_site_logo:

  445.       type: boolean

  446.       label: 'Use site logo'

  447.     use_site_name:

  448.       type: boolean

  449.       label: 'Use site name'

  450.     use_site_slogan:

  451.       type: boolean

  452.       label: 'Use site slogan'

  453. 

  454. block.settings.system_menu_block:*:

  455.   type: block_settings

  456.   label: 'Menu block'

  457.   mapping:

  458.     level:

  459.       type: integer

  460.       label: 'Starting level'

  461.     depth:

  462.       type: integer

  463.       label: 'Maximum number of levels'

  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.