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

  212.           label: 'Compress CSS files'

  213.     fast_404:

  214.       type: mapping

  215.       label: 'Fast 404 settings'

  216.       mapping:

  217.         enabled:

  218.           type: boolean

  219.           label: 'Fast 404 enabled'

  220.         paths:

  221.           type: string

  222.           label: 'Regular expression to match'

  223.         exclude_paths:

  224.           type: string

  225.           label: 'Regular expression to not match'

  226.         html:

  227.           type: string

  228.           label: 'Fast 404 page html'

  229.     js:

  230.       type: mapping

  231.       label: 'JavaScript performance settings'

  232.       mapping:

  233.         preprocess:

  234.           type: boolean

  235.           label: 'JavaScript preprocess'

  236.         gzip:

  237.           type: boolean

  238.           label: 'Compress JavaScript files.'

  239. 

  240. system.theme:

  241.   type: config_object

  242.   label: 'Theme settings'

  243.   mapping:

  244.     admin:

  245.       type: string

  246.       label: 'Administration theme'

  247.     default:

  248.       type: string

  249.       label: 'Default theme'

  250. 

  251. system.menu.*:

  252.   type: config_entity

  253.   label: 'Menu'

  254.   mapping:

  255.     id:

  256.       type: machine_name

  257.       label: 'ID'

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

  259.       # underscores.

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

  261.       constraints:

  262.         Regex:

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

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

  265.         Length:

  266.           max: 32

  267.     label:

  268.       type: required_label

  269.       label: 'Label'

  270.     description:

  271.       type: label

  272.       label: 'Menu description'

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

  274.       nullable: true

  275.       constraints:

  276.         Length:

  277.           max: 512

  278.     locked:

  279.       type: boolean

  280.       label: 'Locked'

  281.   constraints:

  282.     FullyValidatable: ~

  283. 

  284. system.action.*:

  285.   type: config_entity

  286.   label: 'System action'

  287.   constraints:

  288.     FullyValidatable: ~

  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.       # Action can be specified without type.

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

  307.       nullable: true

  308.       constraints:

  309.         NotBlank:

  310.           allowNull: true

  311.     plugin:

  312.       type: string

  313.       label: 'Plugin'

  314.       constraints:

  315.         PluginExists:

  316.           manager: plugin.manager.action

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

  318.     configuration:

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

  320. 

  321. system.file:

  322.   type: config_object

  323.   label: 'File system'

  324.   constraints:

  325.     FullyValidatable: ~

  326.   mapping:

  327.     allow_insecure_uploads:

  328.       type: boolean

  329.       label: 'Allow insecure uploads'

  330.     default_scheme:

  331.       type: string

  332.       label: 'Default download method'

  333.       constraints:

  334.         ClassResolver:

  335.           classOrService: 'stream_wrapper_manager'

  336.           method: 'isValidScheme'

  337.     path:

  338.       type: mapping

  339.       label: 'Path settings'

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

  341.     temporary_maximum_age:

  342.       type: integer

  343.       label: 'Maximum age for temporary files'

  344.       constraints:

  345.         PositiveOrZero: ~

  346. 

  347. system.image:

  348.   type: config_object

  349.   label: 'Image settings'

  350.   constraints:

  351.     FullyValidatable: ~

  352.   mapping:

  353.     toolkit:

  354.       type: string

  355.       label: 'Toolkit'

  356.       constraints:

  357.         PluginExists:

  358.           manager: 'image.toolkit.manager'

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

  360. 

  361. system.image.gd:

  362.   type: config_object

  363.   label: 'Image settings'

  364.   constraints:

  365.     FullyValidatable: ~

  366.   mapping:

  367.     jpeg_quality:

  368.       type: integer

  369.       label: 'JPEG quality'

  370.       constraints:

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

  372.         Range:

  373.           min: 0

  374.           max: 100

  375. 

  376. system.mail:

  377.   type: config_object

  378.   label: 'Mail system'

  379.   constraints:

  380.     FullyValidatable: ~

  381.   mapping:

  382.     interface:

  383.       type: sequence

  384.       label: 'Interfaces'

  385.       sequence:

  386.         type: string

  387.         label: 'Interface'

  388.         constraints:

  389.           PluginExists:

  390.             manager: plugin.manager.mail

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

  392.     mailer_dsn:

  393.       type: mailer_dsn

  394.       label: 'Symfony mailer transport DSN'

  395. 

  396. system.theme.global:

  397.   type: theme_settings

  398.   label: 'Theme global settings'

  399. 

  400. system.advisories:

  401.   type: config_object

  402.   label: 'Security advisory settings'

  403.   constraints:

  404.     FullyValidatable: ~

  405.   mapping:

  406.     enabled:

  407.       type: boolean

  408.       label: 'Display critical security advisories'

  409.     interval_hours:

  410.       type: integer

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

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

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

  414.       constraints:

  415.         PositiveOrZero: ~

  416. 

  417. block.settings.system_branding_block:

  418.   type: block_settings

  419.   label: 'Branding block'

  420.   constraints:

  421.     FullyValidatable: ~

  422.   mapping:

  423.     use_site_logo:

  424.       type: boolean

  425.       label: 'Use site logo'

  426.     use_site_name:

  427.       type: boolean

  428.       label: 'Use site name'

  429.     use_site_slogan:

  430.       type: boolean

  431.       label: 'Use site slogan'

  432. 

  433. block.settings.system_menu_block:*:

  434.   type: block_settings

  435.   label: 'Menu block'

  436.   constraints:

  437.     FullyValidatable: ~

  438.   mapping:

  439.     level:

  440.       type: integer

  441.       label: 'Starting level'

  442.       constraints:

  443.         MenuLinkDepth:

  444.           min: 0

  445.     depth:

  446.       type: integer

  447.       label: 'Maximum number of levels'

  448.       nullable: true

  449.       constraints:

  450.         MenuLinkDepth:

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

  452.           min: 1

  453.     expand_all_items:

  454.       type: boolean

  455.       label: 'Expand all items'

  456. 

  457. block.settings.local_tasks_block:

  458.   type: block_settings

  459.   label: 'Tabs block'

  460.   constraints:

  461.     FullyValidatable: ~

  462.   mapping:

  463.     primary:

  464.       type: boolean

  465.       label: 'Whether primary tabs are shown'

  466.     secondary:

  467.       type: boolean

  468.       label: 'Whether secondary tabs are shown'

  469. 

  470. condition.plugin.request_path:

  471.   type: condition.plugin

  472.   mapping:

  473.     pages:

  474.       type: string

  475. 

  476. condition.plugin.response_status:

  477.   type: condition.plugin

  478.   mapping:

  479.     status_codes:

  480.       type: sequence

  481.       sequence:

  482.         type: integer

  483. 

  484. system.feature_flags:

  485.   type: config_object

  486.   label: 'System Feature Flags'

  487.   constraints:

  488.     FullyValidatable: ~

  489.   mapping:

  490.     linkset_endpoint:

  491.       type: boolean

  492.       label: 'Enable the menu linkset endpoint'

  493. 

  494. condition.plugin.current_theme:

  495.   type: condition.plugin

  496.   mapping:

  497.     theme:

  498.       type: string

  499.       label: Theme

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