3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>userGroupOption - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ef6f36e2.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <script>function __prefix(e){return new URL(
"../../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
57 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
58 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
59 <label class=
"md-overlay" for=
"__drawer"></label>
60 <div data-md-component=
"skip">
63 <a href=
"#user-group-option-package-installation-plugin" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
84 <img src=
"../../../assets/logo.png" alt=
"logo">
87 <label class=
"md-header__button md-icon" for=
"__drawer">
88 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 <div class=
"md-header__title" data-md-component=
"header-title">
91 <div class=
"md-header__ellipsis">
92 <div class=
"md-header__topic">
93 <span class=
"md-ellipsis">
94 WoltLab Suite Documentation
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
109 <label class=
"md-header__button md-icon" for=
"__search">
110 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
113 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
114 <label class=
"md-search__overlay" for=
"__search"></label>
115 <div class=
"md-search__inner" role=
"search">
116 <form class=
"md-search__form" name=
"search">
117 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
118 <label class=
"md-search__icon md-icon" for=
"__search">
119 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
120 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
122 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
123 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
126 <div class=
"md-search__output">
127 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
128 <div class=
"md-search-result" data-md-component=
"search-result">
129 <div class=
"md-search-result__meta">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
142 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
143 <div class=
"md-source__icon md-icon">
145 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
166 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
167 <div class=
"md-sidebar__scrollwrap">
168 <div class=
"md-sidebar__inner">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
184 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
185 <div class=
"md-source__icon md-icon">
187 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
229 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
230 <label class=
"md-nav__title" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
298 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
299 <label class=
"md-nav__title" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
310 <li class=
"md-nav__item md-nav__item--nested">
313 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
315 <label class=
"md-nav__link" for=
"__nav_2_5_1">
317 <span class=
"md-nav__icon md-icon"></span>
319 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
320 <label class=
"md-nav__title" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
324 <ul class=
"md-nav__list" data-md-scrollfix
>
330 <li class=
"md-nav__item">
331 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
342 <li class=
"md-nav__item">
343 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
354 <li class=
"md-nav__item">
355 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
372 <li class=
"md-nav__item">
373 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../../php/api/events/" class=
"md-nav__link">
409 <li class=
"md-nav__item md-nav__item--nested">
412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
414 <label class=
"md-nav__link" for=
"__nav_2_5_5">
416 <span class=
"md-nav__icon md-icon"></span>
418 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
419 <label class=
"md-nav__title" for=
"__nav_2_5_5">
420 <span class=
"md-nav__icon md-icon"></span>
423 <ul class=
"md-nav__list" data-md-scrollfix
>
429 <li class=
"md-nav__item">
430 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
453 <li class=
"md-nav__item">
454 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
465 <li class=
"md-nav__item">
466 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
495 <li class=
"md-nav__item">
496 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
497 Package Installation Plugins
507 <li class=
"md-nav__item">
508 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
549 <li class=
"md-nav__item">
550 <a href=
"../../../php/code-style/" class=
"md-nav__link">
561 <li class=
"md-nav__item">
562 <a href=
"../../../php/apps/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
595 <li class=
"md-nav__item md-nav__item--nested">
598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
600 <label class=
"md-nav__link" for=
"__nav_3">
601 Languages, Templates & CSS
602 <span class=
"md-nav__icon md-icon"></span>
604 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
605 <label class=
"md-nav__title" for=
"__nav_3">
606 <span class=
"md-nav__icon md-icon"></span>
607 Languages, Templates & CSS
609 <ul class=
"md-nav__list" data-md-scrollfix
>
615 <li class=
"md-nav__item">
616 <a href=
"../../../view/languages/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../../../view/templates/" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"../../../view/css/" class=
"md-nav__link">
673 <li class=
"md-nav__item md-nav__item--nested">
676 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
678 <label class=
"md-nav__link" for=
"__nav_4">
679 TypeScript and JavaScript API
680 <span class=
"md-nav__icon md-icon"></span>
682 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
683 <label class=
"md-nav__title" for=
"__nav_4">
684 <span class=
"md-nav__icon md-icon"></span>
685 TypeScript and JavaScript API
687 <ul class=
"md-nav__list" data-md-scrollfix
>
693 <li class=
"md-nav__item">
694 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
705 <li class=
"md-nav__item">
706 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
718 <li class=
"md-nav__item md-nav__item--nested">
721 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
723 <label class=
"md-nav__link" for=
"__nav_4_3">
725 <span class=
"md-nav__icon md-icon"></span>
727 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
728 <label class=
"md-nav__title" for=
"__nav_4_3">
729 <span class=
"md-nav__icon md-icon"></span>
732 <ul class=
"md-nav__list" data-md-scrollfix
>
738 <li class=
"md-nav__item">
739 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
750 <li class=
"md-nav__item">
751 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
762 <li class=
"md-nav__item">
763 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
774 <li class=
"md-nav__item">
775 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
786 <li class=
"md-nav__item">
787 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
798 <li class=
"md-nav__item">
799 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
810 <li class=
"md-nav__item">
811 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
822 <li class=
"md-nav__item">
823 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
824 Browser and Screen Sizes
834 <li class=
"md-nav__item">
835 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
852 <li class=
"md-nav__item">
853 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
864 <li class=
"md-nav__item">
865 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
876 <li class=
"md-nav__item">
877 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
900 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
903 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
905 <label class=
"md-nav__link" for=
"__nav_5">
907 <span class=
"md-nav__icon md-icon"></span>
909 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
910 <label class=
"md-nav__title" for=
"__nav_5">
911 <span class=
"md-nav__icon md-icon"></span>
914 <ul class=
"md-nav__list" data-md-scrollfix
>
920 <li class=
"md-nav__item">
921 <a href=
"../../package-xml/" class=
"md-nav__link">
935 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
938 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
940 <label class=
"md-nav__link" for=
"__nav_5_2">
942 <span class=
"md-nav__icon md-icon"></span>
944 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
945 <label class=
"md-nav__title" for=
"__nav_5_2">
946 <span class=
"md-nav__icon md-icon"></span>
949 <ul class=
"md-nav__list" data-md-scrollfix
>
955 <li class=
"md-nav__item">
956 <a href=
"../" class=
"md-nav__link">
967 <li class=
"md-nav__item">
968 <a href=
"../acl-option/" class=
"md-nav__link">
979 <li class=
"md-nav__item">
980 <a href=
"../acp-menu/" class=
"md-nav__link">
991 <li class=
"md-nav__item">
992 <a href=
"../acp-search-provider/" class=
"md-nav__link">
1003 <li class=
"md-nav__item">
1004 <a href=
"../acp-template/" class=
"md-nav__link">
1015 <li class=
"md-nav__item">
1016 <a href=
"../bbcode/" class=
"md-nav__link">
1027 <li class=
"md-nav__item">
1028 <a href=
"../box/" class=
"md-nav__link">
1039 <li class=
"md-nav__item">
1040 <a href=
"../clipboard-action/" class=
"md-nav__link">
1051 <li class=
"md-nav__item">
1052 <a href=
"../core-object/" class=
"md-nav__link">
1063 <li class=
"md-nav__item">
1064 <a href=
"../cronjob/" class=
"md-nav__link">
1075 <li class=
"md-nav__item">
1076 <a href=
"../database/" class=
"md-nav__link">
1087 <li class=
"md-nav__item">
1088 <a href=
"../event-listener/" class=
"md-nav__link">
1099 <li class=
"md-nav__item">
1100 <a href=
"../file/" class=
"md-nav__link">
1111 <li class=
"md-nav__item">
1112 <a href=
"../language/" class=
"md-nav__link">
1123 <li class=
"md-nav__item">
1124 <a href=
"../media-provider/" class=
"md-nav__link">
1135 <li class=
"md-nav__item">
1136 <a href=
"../menu/" class=
"md-nav__link">
1147 <li class=
"md-nav__item">
1148 <a href=
"../menu-item/" class=
"md-nav__link">
1159 <li class=
"md-nav__item">
1160 <a href=
"../object-type/" class=
"md-nav__link">
1171 <li class=
"md-nav__item">
1172 <a href=
"../object-type-definition/" class=
"md-nav__link">
1173 objectTypeDefinition
1183 <li class=
"md-nav__item">
1184 <a href=
"../option/" class=
"md-nav__link">
1195 <li class=
"md-nav__item">
1196 <a href=
"../page/" class=
"md-nav__link">
1207 <li class=
"md-nav__item">
1208 <a href=
"../pip/" class=
"md-nav__link">
1219 <li class=
"md-nav__item">
1220 <a href=
"../script/" class=
"md-nav__link">
1231 <li class=
"md-nav__item">
1232 <a href=
"../smiley/" class=
"md-nav__link">
1243 <li class=
"md-nav__item">
1244 <a href=
"../sql/" class=
"md-nav__link">
1255 <li class=
"md-nav__item">
1256 <a href=
"../style/" class=
"md-nav__link">
1267 <li class=
"md-nav__item">
1268 <a href=
"../template/" class=
"md-nav__link">
1279 <li class=
"md-nav__item">
1280 <a href=
"../template-listener/" class=
"md-nav__link">
1293 <li class=
"md-nav__item md-nav__item--active">
1295 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1300 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1302 <span class=
"md-nav__icon md-icon"></span>
1305 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1310 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1316 <label class=
"md-nav__title" for=
"__toc">
1317 <span class=
"md-nav__icon md-icon"></span>
1320 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1322 <li class=
"md-nav__item">
1323 <a href=
"#category-components" class=
"md-nav__link">
1329 <li class=
"md-nav__item">
1330 <a href=
"#option-components" class=
"md-nav__link">
1334 <nav class=
"md-nav" aria-label=
"Option Components">
1335 <ul class=
"md-nav__list">
1337 <li class=
"md-nav__item">
1338 <a href=
"#adminmoduserdefaultvalue" class=
"md-nav__link">
1339 <(admin|mod|user)defaultvalue
>
1344 <li class=
"md-nav__item">
1345 <a href=
"#usersonly" class=
"md-nav__link">
1356 <li class=
"md-nav__item">
1357 <a href=
"#language-items" class=
"md-nav__link">
1361 <nav class=
"md-nav" aria-label=
"Language Items">
1362 <ul class=
"md-nav__list">
1364 <li class=
"md-nav__item">
1365 <a href=
"#categories" class=
"md-nav__link">
1371 <li class=
"md-nav__item">
1372 <a href=
"#options" class=
"md-nav__link">
1395 <li class=
"md-nav__item">
1396 <a href=
"../user-menu/" class=
"md-nav__link">
1407 <li class=
"md-nav__item">
1408 <a href=
"../user-notification-event/" class=
"md-nav__link">
1409 userNotificationEvent
1419 <li class=
"md-nav__item">
1420 <a href=
"../user-option/" class=
"md-nav__link">
1431 <li class=
"md-nav__item">
1432 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1449 <li class=
"md-nav__item">
1450 <a href=
"../../database-php-api/" class=
"md-nav__link">
1471 <li class=
"md-nav__item md-nav__item--nested">
1474 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1476 <label class=
"md-nav__link" for=
"__nav_6">
1478 <span class=
"md-nav__icon md-icon"></span>
1480 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1481 <label class=
"md-nav__title" for=
"__nav_6">
1482 <span class=
"md-nav__icon md-icon"></span>
1485 <ul class=
"md-nav__list" data-md-scrollfix
>
1492 <li class=
"md-nav__item md-nav__item--nested">
1495 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1497 <label class=
"md-nav__link" for=
"__nav_6_1">
1498 Migrating from WSC
5.3
1499 <span class=
"md-nav__icon md-icon"></span>
1501 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1502 <label class=
"md-nav__title" for=
"__nav_6_1">
1503 <span class=
"md-nav__icon md-icon"></span>
1504 Migrating from WSC
5.3
1506 <ul class=
"md-nav__list" data-md-scrollfix
>
1512 <li class=
"md-nav__item">
1513 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1524 <li class=
"md-nav__item">
1525 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1526 Session Handling and Authentication
1536 <li class=
"md-nav__item">
1537 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1538 TypeScript and JavaScript
1548 <li class=
"md-nav__item">
1549 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1560 <li class=
"md-nav__item">
1561 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1562 Third Party Libraries
1579 <li class=
"md-nav__item md-nav__item--nested">
1582 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1584 <label class=
"md-nav__link" for=
"__nav_6_2">
1585 Migrating from WSC
5.2
1586 <span class=
"md-nav__icon md-icon"></span>
1588 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1589 <label class=
"md-nav__title" for=
"__nav_6_2">
1590 <span class=
"md-nav__icon md-icon"></span>
1591 Migrating from WSC
5.2
1593 <ul class=
"md-nav__list" data-md-scrollfix
>
1599 <li class=
"md-nav__item">
1600 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1611 <li class=
"md-nav__item">
1612 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1613 Templates and Languages
1623 <li class=
"md-nav__item">
1624 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1625 Third Party Libraries
1642 <li class=
"md-nav__item md-nav__item--nested">
1645 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1647 <label class=
"md-nav__link" for=
"__nav_6_3">
1648 Migrating from WSC
3.1
1649 <span class=
"md-nav__icon md-icon"></span>
1651 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1652 <label class=
"md-nav__title" for=
"__nav_6_3">
1653 <span class=
"md-nav__icon md-icon"></span>
1654 Migrating from WSC
3.1
1656 <ul class=
"md-nav__list" data-md-scrollfix
>
1662 <li class=
"md-nav__item">
1663 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1681 <li class=
"md-nav__item md-nav__item--nested">
1684 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1686 <label class=
"md-nav__link" for=
"__nav_6_4">
1687 Migrating from WSC
3.0
1688 <span class=
"md-nav__icon md-icon"></span>
1690 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1691 <label class=
"md-nav__title" for=
"__nav_6_4">
1692 <span class=
"md-nav__icon md-icon"></span>
1693 Migrating from WSC
3.0
1695 <ul class=
"md-nav__list" data-md-scrollfix
>
1701 <li class=
"md-nav__item">
1702 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1713 <li class=
"md-nav__item">
1714 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1725 <li class=
"md-nav__item">
1726 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1737 <li class=
"md-nav__item">
1738 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1749 <li class=
"md-nav__item">
1750 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1768 <li class=
"md-nav__item md-nav__item--nested">
1771 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1773 <label class=
"md-nav__link" for=
"__nav_6_5">
1774 Migrating from WCF
2.1
1775 <span class=
"md-nav__icon md-icon"></span>
1777 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1778 <label class=
"md-nav__title" for=
"__nav_6_5">
1779 <span class=
"md-nav__icon md-icon"></span>
1780 Migrating from WCF
2.1
1782 <ul class=
"md-nav__list" data-md-scrollfix
>
1788 <li class=
"md-nav__item">
1789 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1800 <li class=
"md-nav__item">
1801 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1812 <li class=
"md-nav__item">
1813 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1824 <li class=
"md-nav__item">
1825 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1852 <li class=
"md-nav__item md-nav__item--nested">
1855 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1857 <label class=
"md-nav__link" for=
"__nav_7">
1859 <span class=
"md-nav__icon md-icon"></span>
1861 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1862 <label class=
"md-nav__title" for=
"__nav_7">
1863 <span class=
"md-nav__icon md-icon"></span>
1866 <ul class=
"md-nav__list" data-md-scrollfix
>
1873 <li class=
"md-nav__item md-nav__item--nested">
1876 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1878 <label class=
"md-nav__link" for=
"__nav_7_1">
1880 <span class=
"md-nav__icon md-icon"></span>
1882 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1883 <label class=
"md-nav__title" for=
"__nav_7_1">
1884 <span class=
"md-nav__icon md-icon"></span>
1887 <ul class=
"md-nav__list" data-md-scrollfix
>
1893 <li class=
"md-nav__item">
1894 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1905 <li class=
"md-nav__item">
1906 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1917 <li class=
"md-nav__item">
1918 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1929 <li class=
"md-nav__item">
1930 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1941 <li class=
"md-nav__item">
1942 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
1969 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1970 <div class=
"md-sidebar__scrollwrap">
1971 <div class=
"md-sidebar__inner">
1973 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1979 <label class=
"md-nav__title" for=
"__toc">
1980 <span class=
"md-nav__icon md-icon"></span>
1983 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1985 <li class=
"md-nav__item">
1986 <a href=
"#category-components" class=
"md-nav__link">
1992 <li class=
"md-nav__item">
1993 <a href=
"#option-components" class=
"md-nav__link">
1997 <nav class=
"md-nav" aria-label=
"Option Components">
1998 <ul class=
"md-nav__list">
2000 <li class=
"md-nav__item">
2001 <a href=
"#adminmoduserdefaultvalue" class=
"md-nav__link">
2002 <(admin|mod|user)defaultvalue
>
2007 <li class=
"md-nav__item">
2008 <a href=
"#usersonly" class=
"md-nav__link">
2019 <li class=
"md-nav__item">
2020 <a href=
"#language-items" class=
"md-nav__link">
2024 <nav class=
"md-nav" aria-label=
"Language Items">
2025 <ul class=
"md-nav__list">
2027 <li class=
"md-nav__item">
2028 <a href=
"#categories" class=
"md-nav__link">
2034 <li class=
"md-nav__item">
2035 <a href=
"#options" class=
"md-nav__link">
2054 <div class=
"md-content" data-md-component=
"content">
2055 <article class=
"md-content__inner md-typeset">
2058 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/user-group-option.md" title=
"Edit this page" class=
"md-content__button md-icon">
2059 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
2063 <h1 id=
"user-group-option-package-installation-plugin">User Group Option Package Installation Plugin
<a class=
"headerlink" href=
"#user-group-option-package-installation-plugin" title=
"Permanent link">#
</a></h1>
2064 <p>Registers new user group options (“permissions”).
2065 The behaviour of this package installation plugin closely follows the
<a href=
"../option/">option
</a> PIP.
</p>
2066 <h2 id=
"category-components">Category Components
<a class=
"headerlink" href=
"#category-components" title=
"Permanent link">#
</a></h2>
2067 <p>The category definition works exactly like the option PIP.
</p>
2068 <h2 id=
"option-components">Option Components
<a class=
"headerlink" href=
"#option-components" title=
"Permanent link">#
</a></h2>
2069 <p>The fields
<code>hidden
</code>,
<code>supporti18n
</code> and
<code>requirei18n
</code> do not apply.
2070 The following extra fields are defined:
</p>
2071 <h3 id=
"adminmoduserdefaultvalue"><code><(admin|mod|user)defaultvalue
></code><a class=
"headerlink" href=
"#adminmoduserdefaultvalue" title=
"Permanent link">#
</a></h3>
2072 <p>Defines the
<code>defaultvalue
</code>s for subsets of the groups:
</p>
2077 <th>Description
</th>
2083 <td>Groups where the
<code>admin.user.accessibleGroups
</code> user group option includes every group.
</td>
2087 <td>Groups where the
<code>mod.general.canUseModeration
</code> is set to
<code>true
</code>.
</td>
2091 <td>Groups where the internal group type is neither
<code>UserGroup::EVERYONE
</code> nor
<code>UserGroup::GUESTS
</code>.
</td>
2095 <h3 id=
"usersonly"><code><usersonly
></code><a class=
"headerlink" href=
"#usersonly" title=
"Permanent link">#
</a></h3>
2096 <p>Makes the option unavailable for groups with the group type
<code>UserGroup::GUESTS
</code>.
</p>
2097 <h2 id=
"language-items">Language Items
<a class=
"headerlink" href=
"#language-items" title=
"Permanent link">#
</a></h2>
2098 <p>All relevant language items have to be put into the
<code>wcf.acp.group
</code> language item category.
</p>
2099 <h3 id=
"categories">Categories
<a class=
"headerlink" href=
"#categories" title=
"Permanent link">#
</a></h3>
2100 <p>If you install a category named
<code>user.foo
</code>, you have to provide the language item
<code>wcf.acp.group.option.category.user.foo
</code>, which is used when displaying the options.
2101 If you want to provide an optional description of the category, you have to provide the language item
<code>wcf.acp.group.option.category.user.foo.description
</code>.
2102 Descriptions are only relevant for categories whose parent has a parent itself, i.e. categories on the third level.
</p>
2103 <h3 id=
"options">Options
<a class=
"headerlink" href=
"#options" title=
"Permanent link">#
</a></h3>
2104 <p>If you install an option named
<code>user.foo.canBar
</code>, you have to provide the language item
<code>wcf.acp.group.option.user.foo.canBar
</code>, which is used as a label for setting the option value.
2105 If you want to provide an optional description of the option, you have to provide the language item
<code>wcf.acp.group.option.user.foo.canBar.description
</code>.
</p>
2111 <div class=
"md-source-date">
2114 Last update:
2021-
01-
08
2133 <footer class=
"md-footer">
2135 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2137 <a href=
"../template-listener/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2138 <div class=
"md-footer__button md-icon">
2139 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
2141 <div class=
"md-footer__title">
2142 <div class=
"md-ellipsis">
2143 <span class=
"md-footer__direction">
2152 <a href=
"../user-menu/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2153 <div class=
"md-footer__title">
2154 <div class=
"md-ellipsis">
2155 <span class=
"md-footer__direction">
2161 <div class=
"md-footer__button md-icon">
2162 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2168 <div class=
"md-footer-meta md-typeset">
2169 <div class=
"md-footer-meta__inner md-grid">
2170 <div class=
"md-footer-copyright">
2172 <div class=
"md-footer-copyright__highlight">
2173 Copyright ©
2020 WoltLab GmbH
2177 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2182 <div class=
"md-footer-copyright">
2183 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2184 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2191 <div class=
"md-dialog" data-md-component=
"dialog">
2192 <div class=
"md-dialog__inner md-typeset"></div>
2194 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../../assets/javascripts/workers/search.fe42c31b.min.js",
"version": {
"provider":
"mike"}}
</script>
2197 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>