user.schema.yml

Same filename in other branches
  1. 9 core/modules/user/config/schema/user.schema.yml
  2. 8.9.x core/modules/user/config/schema/user.schema.yml
  3. 10 core/modules/user/config/schema/user.schema.yml
core/modules/user/config/schema/user.schema.yml

File

core/modules/user/config/schema/user.schema.yml

View source 
  1. # Schema for the configuration files of the User module.

  2. 

  3. user.settings:

  4.   type: config_object

  5.   label: 'User settings'

  6.   constraints:

  7.     FullyValidatable: ~

  8.   mapping:

  9.     anonymous:

  10.       type: required_label

  11.       label: 'Name'

  12.     verify_mail:

  13.       type: boolean

  14.       label: 'Require email verification when a visitor creates an account'

  15.     notify:

  16.       type: mapping

  17.       label: 'Notify user'

  18.       mapping:

  19.         cancel_confirm:

  20.           type: boolean

  21.           label: 'Account cancellation confirmation'

  22.         password_reset:

  23.           type: boolean

  24.           label: 'Notify user when password reset'

  25.         status_activated:

  26.           type: boolean

  27.           label: 'Notify user when account is activated'

  28.         status_blocked:

  29.           type: boolean

  30.           label: 'Account blocked'

  31.         status_canceled:

  32.           type: boolean

  33.           label: 'Account canceled'

  34.         register_admin_created:

  35.           type: boolean

  36.           label: 'Welcome (new user created by administrator)'

  37.         register_no_approval_required:

  38.           type: boolean

  39.           label: 'Welcome (no approval required)'

  40.         register_pending_approval:

  41.           type: boolean

  42.           label: 'Welcome (awaiting approval)'

  43.     register:

  44.       type: string

  45.       label: 'Who can register accounts?'

  46.       # Choices are derived from the constants.

  47.       # @see \Drupal\user\UserInterface::REGISTER_*

  48.       # @todo Convert to use Enum in https://www.drupal.org/project/drupal/issues/3450782

  49.       constraints:

  50.         Choice:

  51.           choices:

  52.             - 'visitors'

  53.             - 'admin_only'

  54.             - 'visitors_admin_approval'

  55.     cancel_method:

  56.       type: string

  57.       label: 'When cancelling a user account'

  58.       constraints:

  59.         UserCancelMethod: []

  60.     password_reset_timeout:

  61.       type: integer

  62.       label: 'Password reset timeout'

  63.       # @todo Increase min in https://www.drupal.org/i/3441772

  64.       constraints:

  65.         Range:

  66.           min: 1

  67.     password_strength:

  68.       type: boolean

  69.       label: 'Enable password strength indicator'

  70. 

  71. user.mail:

  72.   type: config_object

  73.   label: 'Email settings'

  74.   constraints:

  75.     FullyValidatable: ~

  76.   mapping:

  77.     cancel_confirm:

  78.       type: mail

  79.       label: 'Account cancellation confirmation'

  80.     password_reset:

  81.       type: mail

  82.       label: 'Password recovery'

  83.     register_admin_created:

  84.       type: mail

  85.       label: 'Account created by administrator'

  86.     register_no_approval_required:

  87.       type: mail

  88.       label: 'Registration confirmation (No approval required)'

  89.     register_pending_approval:

  90.       type: mail

  91.       label: 'Registration confirmation (Pending approval)'

  92.     register_pending_approval_admin:

  93.       type: mail

  94.       label: 'Admin (user awaiting approval)'

  95.     status_activated:

  96.       type: mail

  97.       label: 'Account activation'

  98.     status_blocked:

  99.       type: mail

  100.       label: 'Account blocked'

  101.     status_canceled:

  102.       type: mail

  103.       label: 'Account cancelled'

  104. 

  105. user.flood:

  106.   type: config_object

  107.   label: 'User flood settings'

  108.   mapping:

  109.     uid_only:

  110.       type: boolean

  111.       label: 'UID only identifier'

  112.     ip_limit:

  113.       type: integer

  114.       label: 'IP limit'

  115.     ip_window:

  116.       type: integer

  117.       label: 'IP window'

  118.     user_limit:

  119.       type: integer

  120.       label: 'User limit'

  121.     user_window:

  122.       type: integer

  123.       label: 'User window'

  124. 

  125. user.role.*:

  126.   type: config_entity

  127.   label: 'User role settings'

  128.   constraints:

  129.     FullyValidatable: ~

  130.   mapping:

  131.     id:

  132.       type: machine_name

  133.       label: 'ID'

  134.     label:

  135.       type: required_label

  136.       label: 'Label'

  137.     weight:

  138.       type: weight

  139.       label: 'User role weight'

  140.     is_admin:

  141.       type: boolean

  142.       label: 'User is admin'

  143.     permissions:

  144.       type: sequence

  145.       label: 'Permissions'

  146.       orderby: value

  147.       sequence:

  148.         type: string

  149.         label: 'Permission'

  150.         constraints:

  151.           Callback:

  152.             callback: [\Drupal\user\Entity\Role, getAllValidPermissions]

  153. 

  154. action.configuration.user_add_role_action:

  155.   type: mapping

  156.   label: 'Configuration for the add role action'

  157.   mapping:

  158.     rid:

  159.       type: string

  160.       label: 'The ID of the role to add'

  161. 

  162. action.configuration.user_block_user_action:

  163.   type: action_configuration_default

  164.   label: 'Block the selected users configuration'

  165. 

  166. action.configuration.user_cancel_user_action:

  167.   type: action_configuration_default

  168.   label: 'Cancel the selected user accounts configuration'

  169. 

  170. action.configuration.user_remove_role_action:

  171.   type: mapping

  172.   label: 'Configuration for the remove role action'

  173.   mapping:

  174.     rid:

  175.       type: string

  176.       label: 'The ID of the role to remove'

  177. 

  178. action.configuration.user_unblock_user_action:

  179.   type: action_configuration_default

  180.   label: 'Unblock the selected users configuration'

  181. 

  182. search.plugin.user_search:

  183.   type: sequence

  184.   label: 'User search'

  185. 

  186. condition.plugin.user_role:

  187.   type: condition.plugin

  188.   mapping:

  189.     roles:

  190.       type: sequence

  191.       sequence:

  192.         type: string

  193. 

  194. # Schema for the entity reference 'default:user' selection handler settings.

  195. entity_reference_selection.default:user:

  196.   type: entity_reference_selection.default

  197.   label: 'User selection handler settings'

  198.   mapping:

  199.     filter:

  200.       type: mapping

  201.       label: 'Filter settings'

  202.       mapping:

  203.         type:

  204.           type: string

  205.           label: 'Filter by'

  206.         role:

  207.           type: sequence

  208.           label: 'Restrict to the selected roles'

  209.           sequence:

  210.             type: string

  211.             label: 'Role'

  212.     include_anonymous:

  213.       type: boolean

  214.       label: 'Include the anonymous user in the matched entities.'

  215. 

  216. field.formatter.settings.user_name:

  217.   type: mapping

  218.   mapping:

  219.     link_to_entity:

  220.       type: boolean

  221.       label: 'Link to the user'

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