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.2">
17 <title>aclOption - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.6f955dcd.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=
"#acl-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">
969 <li class=
"md-nav__item md-nav__item--active">
971 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
977 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
979 <span class=
"md-nav__icon md-icon"></span>
982 <a href=
"./" class=
"md-nav__link md-nav__link--active">
987 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
994 <label class=
"md-nav__title" for=
"__toc">
995 <span class=
"md-nav__icon md-icon"></span>
998 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1000 <li class=
"md-nav__item">
1001 <a href=
"#option-components" class=
"md-nav__link">
1005 <nav class=
"md-nav" aria-label=
"Option Components">
1006 <ul class=
"md-nav__list">
1008 <li class=
"md-nav__item">
1009 <a href=
"#categoryname" class=
"md-nav__link">
1010 <categoryname
>
1015 <li class=
"md-nav__item">
1016 <a href=
"#objecttype" class=
"md-nav__link">
1027 <li class=
"md-nav__item">
1028 <a href=
"#category-components" class=
"md-nav__link">
1032 <nav class=
"md-nav" aria-label=
"Category Components">
1033 <ul class=
"md-nav__list">
1035 <li class=
"md-nav__item">
1036 <a href=
"#objecttype_1" class=
"md-nav__link">
1047 <li class=
"md-nav__item">
1048 <a href=
"#example" class=
"md-nav__link">
1066 <li class=
"md-nav__item">
1067 <a href=
"../acp-menu/" class=
"md-nav__link">
1078 <li class=
"md-nav__item">
1079 <a href=
"../acp-search-provider/" class=
"md-nav__link">
1090 <li class=
"md-nav__item">
1091 <a href=
"../acp-template/" class=
"md-nav__link">
1102 <li class=
"md-nav__item">
1103 <a href=
"../bbcode/" class=
"md-nav__link">
1114 <li class=
"md-nav__item">
1115 <a href=
"../box/" class=
"md-nav__link">
1126 <li class=
"md-nav__item">
1127 <a href=
"../clipboard-action/" class=
"md-nav__link">
1138 <li class=
"md-nav__item">
1139 <a href=
"../core-object/" class=
"md-nav__link">
1150 <li class=
"md-nav__item">
1151 <a href=
"../cronjob/" class=
"md-nav__link">
1162 <li class=
"md-nav__item">
1163 <a href=
"../database/" class=
"md-nav__link">
1174 <li class=
"md-nav__item">
1175 <a href=
"../event-listener/" class=
"md-nav__link">
1186 <li class=
"md-nav__item">
1187 <a href=
"../file/" class=
"md-nav__link">
1198 <li class=
"md-nav__item">
1199 <a href=
"../language/" class=
"md-nav__link">
1210 <li class=
"md-nav__item">
1211 <a href=
"../media-provider/" class=
"md-nav__link">
1222 <li class=
"md-nav__item">
1223 <a href=
"../menu/" class=
"md-nav__link">
1234 <li class=
"md-nav__item">
1235 <a href=
"../menu-item/" class=
"md-nav__link">
1246 <li class=
"md-nav__item">
1247 <a href=
"../object-type/" class=
"md-nav__link">
1258 <li class=
"md-nav__item">
1259 <a href=
"../object-type-definition/" class=
"md-nav__link">
1260 objectTypeDefinition
1270 <li class=
"md-nav__item">
1271 <a href=
"../option/" class=
"md-nav__link">
1282 <li class=
"md-nav__item">
1283 <a href=
"../page/" class=
"md-nav__link">
1294 <li class=
"md-nav__item">
1295 <a href=
"../pip/" class=
"md-nav__link">
1306 <li class=
"md-nav__item">
1307 <a href=
"../script/" class=
"md-nav__link">
1318 <li class=
"md-nav__item">
1319 <a href=
"../smiley/" class=
"md-nav__link">
1330 <li class=
"md-nav__item">
1331 <a href=
"../sql/" class=
"md-nav__link">
1342 <li class=
"md-nav__item">
1343 <a href=
"../style/" class=
"md-nav__link">
1354 <li class=
"md-nav__item">
1355 <a href=
"../template/" class=
"md-nav__link">
1366 <li class=
"md-nav__item">
1367 <a href=
"../template-listener/" class=
"md-nav__link">
1378 <li class=
"md-nav__item">
1379 <a href=
"../user-group-option/" class=
"md-nav__link">
1390 <li class=
"md-nav__item">
1391 <a href=
"../user-menu/" class=
"md-nav__link">
1402 <li class=
"md-nav__item">
1403 <a href=
"../user-notification-event/" class=
"md-nav__link">
1404 userNotificationEvent
1414 <li class=
"md-nav__item">
1415 <a href=
"../user-option/" class=
"md-nav__link">
1426 <li class=
"md-nav__item">
1427 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1444 <li class=
"md-nav__item">
1445 <a href=
"../../database-php-api/" class=
"md-nav__link">
1466 <li class=
"md-nav__item md-nav__item--nested">
1469 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1471 <label class=
"md-nav__link" for=
"__nav_6">
1473 <span class=
"md-nav__icon md-icon"></span>
1475 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1476 <label class=
"md-nav__title" for=
"__nav_6">
1477 <span class=
"md-nav__icon md-icon"></span>
1480 <ul class=
"md-nav__list" data-md-scrollfix
>
1487 <li class=
"md-nav__item md-nav__item--nested">
1490 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1492 <label class=
"md-nav__link" for=
"__nav_6_1">
1493 Migrating from WSC
5.3
1494 <span class=
"md-nav__icon md-icon"></span>
1496 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1497 <label class=
"md-nav__title" for=
"__nav_6_1">
1498 <span class=
"md-nav__icon md-icon"></span>
1499 Migrating from WSC
5.3
1501 <ul class=
"md-nav__list" data-md-scrollfix
>
1507 <li class=
"md-nav__item">
1508 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1519 <li class=
"md-nav__item">
1520 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1521 Session Handling and Authentication
1531 <li class=
"md-nav__item">
1532 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1533 TypeScript and JavaScript
1543 <li class=
"md-nav__item">
1544 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1555 <li class=
"md-nav__item">
1556 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1557 Third Party Libraries
1574 <li class=
"md-nav__item md-nav__item--nested">
1577 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1579 <label class=
"md-nav__link" for=
"__nav_6_2">
1580 Migrating from WSC
5.2
1581 <span class=
"md-nav__icon md-icon"></span>
1583 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1584 <label class=
"md-nav__title" for=
"__nav_6_2">
1585 <span class=
"md-nav__icon md-icon"></span>
1586 Migrating from WSC
5.2
1588 <ul class=
"md-nav__list" data-md-scrollfix
>
1594 <li class=
"md-nav__item">
1595 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1606 <li class=
"md-nav__item">
1607 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1608 Templates and Languages
1618 <li class=
"md-nav__item">
1619 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1620 Third Party Libraries
1637 <li class=
"md-nav__item md-nav__item--nested">
1640 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1642 <label class=
"md-nav__link" for=
"__nav_6_3">
1643 Migrating from WSC
3.1
1644 <span class=
"md-nav__icon md-icon"></span>
1646 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1647 <label class=
"md-nav__title" for=
"__nav_6_3">
1648 <span class=
"md-nav__icon md-icon"></span>
1649 Migrating from WSC
3.1
1651 <ul class=
"md-nav__list" data-md-scrollfix
>
1657 <li class=
"md-nav__item">
1658 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1676 <li class=
"md-nav__item md-nav__item--nested">
1679 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1681 <label class=
"md-nav__link" for=
"__nav_6_4">
1682 Migrating from WSC
3.0
1683 <span class=
"md-nav__icon md-icon"></span>
1685 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1686 <label class=
"md-nav__title" for=
"__nav_6_4">
1687 <span class=
"md-nav__icon md-icon"></span>
1688 Migrating from WSC
3.0
1690 <ul class=
"md-nav__list" data-md-scrollfix
>
1696 <li class=
"md-nav__item">
1697 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1708 <li class=
"md-nav__item">
1709 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1720 <li class=
"md-nav__item">
1721 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1732 <li class=
"md-nav__item">
1733 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1744 <li class=
"md-nav__item">
1745 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1763 <li class=
"md-nav__item md-nav__item--nested">
1766 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1768 <label class=
"md-nav__link" for=
"__nav_6_5">
1769 Migrating from WCF
2.1
1770 <span class=
"md-nav__icon md-icon"></span>
1772 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1773 <label class=
"md-nav__title" for=
"__nav_6_5">
1774 <span class=
"md-nav__icon md-icon"></span>
1775 Migrating from WCF
2.1
1777 <ul class=
"md-nav__list" data-md-scrollfix
>
1783 <li class=
"md-nav__item">
1784 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1795 <li class=
"md-nav__item">
1796 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1807 <li class=
"md-nav__item">
1808 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1819 <li class=
"md-nav__item">
1820 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1847 <li class=
"md-nav__item md-nav__item--nested">
1850 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1852 <label class=
"md-nav__link" for=
"__nav_7">
1854 <span class=
"md-nav__icon md-icon"></span>
1856 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1857 <label class=
"md-nav__title" for=
"__nav_7">
1858 <span class=
"md-nav__icon md-icon"></span>
1861 <ul class=
"md-nav__list" data-md-scrollfix
>
1868 <li class=
"md-nav__item md-nav__item--nested">
1871 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1873 <label class=
"md-nav__link" for=
"__nav_7_1">
1875 <span class=
"md-nav__icon md-icon"></span>
1877 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1878 <label class=
"md-nav__title" for=
"__nav_7_1">
1879 <span class=
"md-nav__icon md-icon"></span>
1882 <ul class=
"md-nav__list" data-md-scrollfix
>
1888 <li class=
"md-nav__item">
1889 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1900 <li class=
"md-nav__item">
1901 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1912 <li class=
"md-nav__item">
1913 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1924 <li class=
"md-nav__item">
1925 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1936 <li class=
"md-nav__item">
1937 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
1948 <li class=
"md-nav__item">
1949 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
1976 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1977 <div class=
"md-sidebar__scrollwrap">
1978 <div class=
"md-sidebar__inner">
1980 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1987 <label class=
"md-nav__title" for=
"__toc">
1988 <span class=
"md-nav__icon md-icon"></span>
1991 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1993 <li class=
"md-nav__item">
1994 <a href=
"#option-components" class=
"md-nav__link">
1998 <nav class=
"md-nav" aria-label=
"Option Components">
1999 <ul class=
"md-nav__list">
2001 <li class=
"md-nav__item">
2002 <a href=
"#categoryname" class=
"md-nav__link">
2003 <categoryname
>
2008 <li class=
"md-nav__item">
2009 <a href=
"#objecttype" class=
"md-nav__link">
2020 <li class=
"md-nav__item">
2021 <a href=
"#category-components" class=
"md-nav__link">
2025 <nav class=
"md-nav" aria-label=
"Category Components">
2026 <ul class=
"md-nav__list">
2028 <li class=
"md-nav__item">
2029 <a href=
"#objecttype_1" class=
"md-nav__link">
2040 <li class=
"md-nav__item">
2041 <a href=
"#example" class=
"md-nav__link">
2055 <div class=
"md-content" data-md-component=
"content">
2056 <article class=
"md-content__inner md-typeset">
2059 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/acl-option.md" title=
"Edit this page" class=
"md-content__button md-icon">
2060 <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>
2064 <h1 id=
"acl-option-package-installation-plugin">ACL Option Package Installation Plugin
<a class=
"headerlink" href=
"#acl-option-package-installation-plugin" title=
"Permanent link">#
</a></h1>
2065 <p>Add customizable permissions for individual objects.
</p>
2066 <h2 id=
"option-components">Option Components
<a class=
"headerlink" href=
"#option-components" title=
"Permanent link">#
</a></h2>
2067 <p>Each acl option is described as an
<code><option
></code> element with the mandatory attribute
<code>name
</code>.
</p>
2068 <h3 id=
"categoryname"><code><categoryname
></code><a class=
"headerlink" href=
"#categoryname" title=
"Permanent link">#
</a></h3>
2069 <p><span class=
"label label-info">Optional
</span></p>
2070 <p>The name of the acl option category to which the option belongs.
</p>
2071 <h3 id=
"objecttype"><code><objecttype
></code><a class=
"headerlink" href=
"#objecttype" title=
"Permanent link">#
</a></h3>
2072 <p>The name of the acl object type (of the object type definition
<code>com.woltlab.wcf.acl
</code>).
</p>
2073 <h2 id=
"category-components">Category Components
<a class=
"headerlink" href=
"#category-components" title=
"Permanent link">#
</a></h2>
2074 <p>Each acl option category is described as an
<code><category
></code> element with the mandatory attribute
<code>name
</code> that should follow the naming pattern
<code><permissionName
></code> or
<code><permissionType
>.
<permissionName
></code>, with
<code><permissionType
></code> generally having
<code>user
</code> or
<code>mod
</code> as value.
</p>
2075 <h3 id=
"objecttype_1"><code><objecttype
></code><a class=
"headerlink" href=
"#objecttype_1" title=
"Permanent link">#
</a></h3>
2076 <p>The name of the acl object type (of the object type definition
<code>com.woltlab.wcf.acl
</code>).
</p>
2077 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
2078 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
2079 <span class=
"nt"><data
</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/
2019/aclOption.xsd
"</span><span class=
"nt">></span>
2080 <span class=
"nt"><import
></span>
2081 <span class=
"nt"><categories
></span>
2082 <span class=
"nt"><category
</span> <span class=
"na">name=
</span><span class=
"s">"user.example
"</span><span class=
"nt">></span>
2083 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
2084 <span class=
"nt"></category
></span>
2085 <span class=
"nt"><category
</span> <span class=
"na">name=
</span><span class=
"s">"mod.example
"</span><span class=
"nt">></span>
2086 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
2087 <span class=
"nt"></category
></span>
2088 <span class=
"nt"></categories
></span>
2090 <span class=
"nt"><options
></span>
2091 <span class=
"nt"><option
</span> <span class=
"na">name=
</span><span class=
"s">"canAddExample
"</span><span class=
"nt">></span>
2092 <span class=
"nt"><categoryname
></span>user.example
<span class=
"nt"></categoryname
></span>
2093 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
2094 <span class=
"nt"></option
></span>
2095 <span class=
"nt"><option
</span> <span class=
"na">name=
</span><span class=
"s">"canDeleteExample
"</span><span class=
"nt">></span>
2096 <span class=
"nt"><categoryname
></span>mod.example
<span class=
"nt"></categoryname
></span>
2097 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
2098 <span class=
"nt"></option
></span>
2099 <span class=
"nt"></options
></span>
2100 <span class=
"nt"></import
></span>
2102 <span class=
"nt"><delete
></span>
2103 <span class=
"nt"><optioncategory
</span> <span class=
"na">name=
</span><span class=
"s">"old.example
"</span><span class=
"nt">></span>
2104 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
2105 <span class=
"nt"></optioncategory
></span>
2106 <span class=
"nt"><option
</span> <span class=
"na">name=
</span><span class=
"s">"canDoSomethingWithExample
"</span><span class=
"nt">></span>
2107 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
2108 <span class=
"nt"></option
></span>
2109 <span class=
"nt"></delete
></span>
2110 <span class=
"nt"></data
></span>
2117 <div class=
"md-source-date">
2120 Last update:
2021-
01-
08
2139 <footer class=
"md-footer">
2141 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2143 <a href=
"../" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2144 <div class=
"md-footer__button md-icon">
2145 <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>
2147 <div class=
"md-footer__title">
2148 <div class=
"md-ellipsis">
2149 <span class=
"md-footer__direction">
2158 <a href=
"../acp-menu/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2159 <div class=
"md-footer__title">
2160 <div class=
"md-ellipsis">
2161 <span class=
"md-footer__direction">
2167 <div class=
"md-footer__button md-icon">
2168 <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>
2174 <div class=
"md-footer-meta md-typeset">
2175 <div class=
"md-footer-meta__inner md-grid">
2176 <div class=
"md-footer-copyright">
2178 <div class=
"md-footer-copyright__highlight">
2179 Copyright ©
2020 WoltLab GmbH
2183 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2188 <div class=
"md-footer-copyright">
2189 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2190 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2197 <div class=
"md-dialog" data-md-component=
"dialog">
2198 <div class=
"md-dialog__inner md-typeset"></div>
2200 <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>
2203 <script src=
"../../../assets/javascripts/bundle.4ea5477f.min.js"></script>