3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"canonical" href=
"https://docs.woltlab.com/5.4/package/pip/acl-option/">
14 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
15 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.2">
19 <title>aclOption - WoltLab Suite Documentation
</title>
23 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.6f955dcd.min.css">
26 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ef6f36e2.min.css">
30 <meta name=
"theme-color" content=
"#009485">
40 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
54 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
57 <script>function __prefix(e){return new URL(
"../../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
59 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
60 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
61 <label class=
"md-overlay" for=
"__drawer"></label>
62 <div data-md-component=
"skip">
65 <a href=
"#acl-option-package-installation-plugin" class=
"md-skip">
70 <div data-md-component=
"announce">
72 <aside class=
"md-announce">
73 <div class=
"md-announce__inner md-grid md-typeset">
75 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
82 <header class=
"md-header" data-md-component=
"header">
83 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
84 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
86 <img src=
"../../../assets/logo.png" alt=
"logo">
89 <label class=
"md-header__button md-icon" for=
"__drawer">
90 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
92 <div class=
"md-header__title" data-md-component=
"header-title">
93 <div class=
"md-header__ellipsis">
94 <div class=
"md-header__topic">
95 <span class=
"md-ellipsis">
96 WoltLab Suite Documentation
99 <div class=
"md-header__topic" data-md-component=
"header-topic">
100 <span class=
"md-ellipsis">
111 <label class=
"md-header__button md-icon" for=
"__search">
112 <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>
115 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
116 <label class=
"md-search__overlay" for=
"__search"></label>
117 <div class=
"md-search__inner" role=
"search">
118 <form class=
"md-search__form" name=
"search">
119 <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
>
120 <label class=
"md-search__icon md-icon" for=
"__search">
121 <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>
122 <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>
124 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
125 <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>
128 <div class=
"md-search__output">
129 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
130 <div class=
"md-search-result" data-md-component=
"search-result">
131 <div class=
"md-search-result__meta">
134 <ol class=
"md-search-result__list"></ol>
142 <div class=
"md-header__source">
144 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
145 <div class=
"md-source__icon md-icon">
147 <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>
149 <div class=
"md-source__repository">
158 <div class=
"md-container" data-md-component=
"container">
163 <main class=
"md-main" data-md-component=
"main">
164 <div class=
"md-main__inner md-grid">
168 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
169 <div class=
"md-sidebar__scrollwrap">
170 <div class=
"md-sidebar__inner">
174 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
175 <label class=
"md-nav__title" for=
"__drawer">
176 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
178 <img src=
"../../../assets/logo.png" alt=
"logo">
181 WoltLab Suite Documentation
184 <div class=
"md-nav__source">
186 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
187 <div class=
"md-source__icon md-icon">
189 <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>
191 <div class=
"md-source__repository">
197 <ul class=
"md-nav__list" data-md-scrollfix
>
206 <li class=
"md-nav__item">
207 <a href=
"../../../getting-started/" class=
"md-nav__link">
222 <li class=
"md-nav__item md-nav__item--nested">
225 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
227 <label class=
"md-nav__link" for=
"__nav_2">
229 <span class=
"md-nav__icon md-icon"></span>
231 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
232 <label class=
"md-nav__title" for=
"__nav_2">
233 <span class=
"md-nav__icon md-icon"></span>
236 <ul class=
"md-nav__list" data-md-scrollfix
>
242 <li class=
"md-nav__item">
243 <a href=
"../../../php/pages/" class=
"md-nav__link">
254 <li class=
"md-nav__item">
255 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
266 <li class=
"md-nav__item">
267 <a href=
"../../../php/database-access/" class=
"md-nav__link">
278 <li class=
"md-nav__item">
279 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
291 <li class=
"md-nav__item md-nav__item--nested">
294 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
296 <label class=
"md-nav__link" for=
"__nav_2_5">
298 <span class=
"md-nav__icon md-icon"></span>
300 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
301 <label class=
"md-nav__title" for=
"__nav_2_5">
302 <span class=
"md-nav__icon md-icon"></span>
305 <ul class=
"md-nav__list" data-md-scrollfix
>
312 <li class=
"md-nav__item md-nav__item--nested">
315 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
317 <label class=
"md-nav__link" for=
"__nav_2_5_1">
319 <span class=
"md-nav__icon md-icon"></span>
321 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
322 <label class=
"md-nav__title" for=
"__nav_2_5_1">
323 <span class=
"md-nav__icon md-icon"></span>
326 <ul class=
"md-nav__list" data-md-scrollfix
>
332 <li class=
"md-nav__item">
333 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
344 <li class=
"md-nav__item">
345 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
356 <li class=
"md-nav__item">
357 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
374 <li class=
"md-nav__item">
375 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
386 <li class=
"md-nav__item">
387 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
398 <li class=
"md-nav__item">
399 <a href=
"../../../php/api/events/" class=
"md-nav__link">
411 <li class=
"md-nav__item md-nav__item--nested">
414 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
416 <label class=
"md-nav__link" for=
"__nav_2_5_5">
418 <span class=
"md-nav__icon md-icon"></span>
420 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
421 <label class=
"md-nav__title" for=
"__nav_2_5_5">
422 <span class=
"md-nav__icon md-icon"></span>
425 <ul class=
"md-nav__list" data-md-scrollfix
>
431 <li class=
"md-nav__item">
432 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
443 <li class=
"md-nav__item">
444 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
455 <li class=
"md-nav__item">
456 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
467 <li class=
"md-nav__item">
468 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
479 <li class=
"md-nav__item">
480 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
497 <li class=
"md-nav__item">
498 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
499 Package Installation Plugins
509 <li class=
"md-nav__item">
510 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
521 <li class=
"md-nav__item">
522 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
533 <li class=
"md-nav__item">
534 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
551 <li class=
"md-nav__item">
552 <a href=
"../../../php/code-style/" class=
"md-nav__link">
563 <li class=
"md-nav__item">
564 <a href=
"../../../php/apps/" class=
"md-nav__link">
575 <li class=
"md-nav__item">
576 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
597 <li class=
"md-nav__item md-nav__item--nested">
600 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
602 <label class=
"md-nav__link" for=
"__nav_3">
603 Languages, Templates & CSS
604 <span class=
"md-nav__icon md-icon"></span>
606 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
607 <label class=
"md-nav__title" for=
"__nav_3">
608 <span class=
"md-nav__icon md-icon"></span>
609 Languages, Templates & CSS
611 <ul class=
"md-nav__list" data-md-scrollfix
>
617 <li class=
"md-nav__item">
618 <a href=
"../../../view/languages/" class=
"md-nav__link">
629 <li class=
"md-nav__item">
630 <a href=
"../../../view/templates/" class=
"md-nav__link">
641 <li class=
"md-nav__item">
642 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
653 <li class=
"md-nav__item">
654 <a href=
"../../../view/css/" class=
"md-nav__link">
675 <li class=
"md-nav__item md-nav__item--nested">
678 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
680 <label class=
"md-nav__link" for=
"__nav_4">
681 TypeScript and JavaScript API
682 <span class=
"md-nav__icon md-icon"></span>
684 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
685 <label class=
"md-nav__title" for=
"__nav_4">
686 <span class=
"md-nav__icon md-icon"></span>
687 TypeScript and JavaScript API
689 <ul class=
"md-nav__list" data-md-scrollfix
>
695 <li class=
"md-nav__item">
696 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
707 <li class=
"md-nav__item">
708 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
720 <li class=
"md-nav__item md-nav__item--nested">
723 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
725 <label class=
"md-nav__link" for=
"__nav_4_3">
727 <span class=
"md-nav__icon md-icon"></span>
729 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
730 <label class=
"md-nav__title" for=
"__nav_4_3">
731 <span class=
"md-nav__icon md-icon"></span>
734 <ul class=
"md-nav__list" data-md-scrollfix
>
740 <li class=
"md-nav__item">
741 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
752 <li class=
"md-nav__item">
753 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
764 <li class=
"md-nav__item">
765 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
776 <li class=
"md-nav__item">
777 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
788 <li class=
"md-nav__item">
789 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
800 <li class=
"md-nav__item">
801 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
812 <li class=
"md-nav__item">
813 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
824 <li class=
"md-nav__item">
825 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
826 Browser and Screen Sizes
836 <li class=
"md-nav__item">
837 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
854 <li class=
"md-nav__item">
855 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
866 <li class=
"md-nav__item">
867 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
878 <li class=
"md-nav__item">
879 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
902 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
905 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
907 <label class=
"md-nav__link" for=
"__nav_5">
909 <span class=
"md-nav__icon md-icon"></span>
911 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
912 <label class=
"md-nav__title" for=
"__nav_5">
913 <span class=
"md-nav__icon md-icon"></span>
916 <ul class=
"md-nav__list" data-md-scrollfix
>
922 <li class=
"md-nav__item">
923 <a href=
"../../package-xml/" class=
"md-nav__link">
937 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
940 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
942 <label class=
"md-nav__link" for=
"__nav_5_2">
944 <span class=
"md-nav__icon md-icon"></span>
946 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
947 <label class=
"md-nav__title" for=
"__nav_5_2">
948 <span class=
"md-nav__icon md-icon"></span>
951 <ul class=
"md-nav__list" data-md-scrollfix
>
957 <li class=
"md-nav__item">
958 <a href=
"../" class=
"md-nav__link">
971 <li class=
"md-nav__item md-nav__item--active">
973 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
979 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
981 <span class=
"md-nav__icon md-icon"></span>
984 <a href=
"./" class=
"md-nav__link md-nav__link--active">
989 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
996 <label class=
"md-nav__title" for=
"__toc">
997 <span class=
"md-nav__icon md-icon"></span>
1000 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1002 <li class=
"md-nav__item">
1003 <a href=
"#option-components" class=
"md-nav__link">
1007 <nav class=
"md-nav" aria-label=
"Option Components">
1008 <ul class=
"md-nav__list">
1010 <li class=
"md-nav__item">
1011 <a href=
"#categoryname" class=
"md-nav__link">
1012 <categoryname
>
1017 <li class=
"md-nav__item">
1018 <a href=
"#objecttype" class=
"md-nav__link">
1029 <li class=
"md-nav__item">
1030 <a href=
"#category-components" class=
"md-nav__link">
1034 <nav class=
"md-nav" aria-label=
"Category Components">
1035 <ul class=
"md-nav__list">
1037 <li class=
"md-nav__item">
1038 <a href=
"#objecttype_1" class=
"md-nav__link">
1049 <li class=
"md-nav__item">
1050 <a href=
"#example" class=
"md-nav__link">
1068 <li class=
"md-nav__item">
1069 <a href=
"../acp-menu/" class=
"md-nav__link">
1080 <li class=
"md-nav__item">
1081 <a href=
"../acp-search-provider/" class=
"md-nav__link">
1092 <li class=
"md-nav__item">
1093 <a href=
"../acp-template/" class=
"md-nav__link">
1104 <li class=
"md-nav__item">
1105 <a href=
"../bbcode/" class=
"md-nav__link">
1116 <li class=
"md-nav__item">
1117 <a href=
"../box/" class=
"md-nav__link">
1128 <li class=
"md-nav__item">
1129 <a href=
"../clipboard-action/" class=
"md-nav__link">
1140 <li class=
"md-nav__item">
1141 <a href=
"../core-object/" class=
"md-nav__link">
1152 <li class=
"md-nav__item">
1153 <a href=
"../cronjob/" class=
"md-nav__link">
1164 <li class=
"md-nav__item">
1165 <a href=
"../database/" class=
"md-nav__link">
1176 <li class=
"md-nav__item">
1177 <a href=
"../event-listener/" class=
"md-nav__link">
1188 <li class=
"md-nav__item">
1189 <a href=
"../file/" class=
"md-nav__link">
1200 <li class=
"md-nav__item">
1201 <a href=
"../language/" class=
"md-nav__link">
1212 <li class=
"md-nav__item">
1213 <a href=
"../media-provider/" class=
"md-nav__link">
1224 <li class=
"md-nav__item">
1225 <a href=
"../menu/" class=
"md-nav__link">
1236 <li class=
"md-nav__item">
1237 <a href=
"../menu-item/" class=
"md-nav__link">
1248 <li class=
"md-nav__item">
1249 <a href=
"../object-type/" class=
"md-nav__link">
1260 <li class=
"md-nav__item">
1261 <a href=
"../object-type-definition/" class=
"md-nav__link">
1262 objectTypeDefinition
1272 <li class=
"md-nav__item">
1273 <a href=
"../option/" class=
"md-nav__link">
1284 <li class=
"md-nav__item">
1285 <a href=
"../page/" class=
"md-nav__link">
1296 <li class=
"md-nav__item">
1297 <a href=
"../pip/" class=
"md-nav__link">
1308 <li class=
"md-nav__item">
1309 <a href=
"../script/" class=
"md-nav__link">
1320 <li class=
"md-nav__item">
1321 <a href=
"../smiley/" class=
"md-nav__link">
1332 <li class=
"md-nav__item">
1333 <a href=
"../sql/" class=
"md-nav__link">
1344 <li class=
"md-nav__item">
1345 <a href=
"../style/" class=
"md-nav__link">
1356 <li class=
"md-nav__item">
1357 <a href=
"../template/" class=
"md-nav__link">
1368 <li class=
"md-nav__item">
1369 <a href=
"../template-listener/" class=
"md-nav__link">
1380 <li class=
"md-nav__item">
1381 <a href=
"../user-group-option/" class=
"md-nav__link">
1392 <li class=
"md-nav__item">
1393 <a href=
"../user-menu/" class=
"md-nav__link">
1404 <li class=
"md-nav__item">
1405 <a href=
"../user-notification-event/" class=
"md-nav__link">
1406 userNotificationEvent
1416 <li class=
"md-nav__item">
1417 <a href=
"../user-option/" class=
"md-nav__link">
1428 <li class=
"md-nav__item">
1429 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1446 <li class=
"md-nav__item">
1447 <a href=
"../../database-php-api/" class=
"md-nav__link">
1468 <li class=
"md-nav__item md-nav__item--nested">
1471 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1473 <label class=
"md-nav__link" for=
"__nav_6">
1475 <span class=
"md-nav__icon md-icon"></span>
1477 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1478 <label class=
"md-nav__title" for=
"__nav_6">
1479 <span class=
"md-nav__icon md-icon"></span>
1482 <ul class=
"md-nav__list" data-md-scrollfix
>
1489 <li class=
"md-nav__item md-nav__item--nested">
1492 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1494 <label class=
"md-nav__link" for=
"__nav_6_1">
1495 Migrating from WSC
5.3
1496 <span class=
"md-nav__icon md-icon"></span>
1498 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1499 <label class=
"md-nav__title" for=
"__nav_6_1">
1500 <span class=
"md-nav__icon md-icon"></span>
1501 Migrating from WSC
5.3
1503 <ul class=
"md-nav__list" data-md-scrollfix
>
1509 <li class=
"md-nav__item">
1510 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1521 <li class=
"md-nav__item">
1522 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1523 Session Handling and Authentication
1533 <li class=
"md-nav__item">
1534 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1535 TypeScript and JavaScript
1545 <li class=
"md-nav__item">
1546 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1557 <li class=
"md-nav__item">
1558 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1559 Third Party Libraries
1576 <li class=
"md-nav__item md-nav__item--nested">
1579 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1581 <label class=
"md-nav__link" for=
"__nav_6_2">
1582 Migrating from WSC
5.2
1583 <span class=
"md-nav__icon md-icon"></span>
1585 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1586 <label class=
"md-nav__title" for=
"__nav_6_2">
1587 <span class=
"md-nav__icon md-icon"></span>
1588 Migrating from WSC
5.2
1590 <ul class=
"md-nav__list" data-md-scrollfix
>
1596 <li class=
"md-nav__item">
1597 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1608 <li class=
"md-nav__item">
1609 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1610 Templates and Languages
1620 <li class=
"md-nav__item">
1621 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1622 Third Party Libraries
1639 <li class=
"md-nav__item md-nav__item--nested">
1642 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1644 <label class=
"md-nav__link" for=
"__nav_6_3">
1645 Migrating from WSC
3.1
1646 <span class=
"md-nav__icon md-icon"></span>
1648 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1649 <label class=
"md-nav__title" for=
"__nav_6_3">
1650 <span class=
"md-nav__icon md-icon"></span>
1651 Migrating from WSC
3.1
1653 <ul class=
"md-nav__list" data-md-scrollfix
>
1659 <li class=
"md-nav__item">
1660 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1678 <li class=
"md-nav__item md-nav__item--nested">
1681 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1683 <label class=
"md-nav__link" for=
"__nav_6_4">
1684 Migrating from WSC
3.0
1685 <span class=
"md-nav__icon md-icon"></span>
1687 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1688 <label class=
"md-nav__title" for=
"__nav_6_4">
1689 <span class=
"md-nav__icon md-icon"></span>
1690 Migrating from WSC
3.0
1692 <ul class=
"md-nav__list" data-md-scrollfix
>
1698 <li class=
"md-nav__item">
1699 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1710 <li class=
"md-nav__item">
1711 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1722 <li class=
"md-nav__item">
1723 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1734 <li class=
"md-nav__item">
1735 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1746 <li class=
"md-nav__item">
1747 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1765 <li class=
"md-nav__item md-nav__item--nested">
1768 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1770 <label class=
"md-nav__link" for=
"__nav_6_5">
1771 Migrating from WCF
2.1
1772 <span class=
"md-nav__icon md-icon"></span>
1774 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1775 <label class=
"md-nav__title" for=
"__nav_6_5">
1776 <span class=
"md-nav__icon md-icon"></span>
1777 Migrating from WCF
2.1
1779 <ul class=
"md-nav__list" data-md-scrollfix
>
1785 <li class=
"md-nav__item">
1786 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1797 <li class=
"md-nav__item">
1798 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1809 <li class=
"md-nav__item">
1810 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1821 <li class=
"md-nav__item">
1822 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1849 <li class=
"md-nav__item md-nav__item--nested">
1852 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1854 <label class=
"md-nav__link" for=
"__nav_7">
1856 <span class=
"md-nav__icon md-icon"></span>
1858 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1859 <label class=
"md-nav__title" for=
"__nav_7">
1860 <span class=
"md-nav__icon md-icon"></span>
1863 <ul class=
"md-nav__list" data-md-scrollfix
>
1870 <li class=
"md-nav__item md-nav__item--nested">
1873 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1875 <label class=
"md-nav__link" for=
"__nav_7_1">
1877 <span class=
"md-nav__icon md-icon"></span>
1879 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1880 <label class=
"md-nav__title" for=
"__nav_7_1">
1881 <span class=
"md-nav__icon md-icon"></span>
1884 <ul class=
"md-nav__list" data-md-scrollfix
>
1890 <li class=
"md-nav__item">
1891 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1902 <li class=
"md-nav__item">
1903 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1914 <li class=
"md-nav__item">
1915 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1926 <li class=
"md-nav__item">
1927 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1938 <li class=
"md-nav__item">
1939 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
1950 <li class=
"md-nav__item">
1951 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
1978 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1979 <div class=
"md-sidebar__scrollwrap">
1980 <div class=
"md-sidebar__inner">
1982 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1989 <label class=
"md-nav__title" for=
"__toc">
1990 <span class=
"md-nav__icon md-icon"></span>
1993 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1995 <li class=
"md-nav__item">
1996 <a href=
"#option-components" class=
"md-nav__link">
2000 <nav class=
"md-nav" aria-label=
"Option Components">
2001 <ul class=
"md-nav__list">
2003 <li class=
"md-nav__item">
2004 <a href=
"#categoryname" class=
"md-nav__link">
2005 <categoryname
>
2010 <li class=
"md-nav__item">
2011 <a href=
"#objecttype" class=
"md-nav__link">
2022 <li class=
"md-nav__item">
2023 <a href=
"#category-components" class=
"md-nav__link">
2027 <nav class=
"md-nav" aria-label=
"Category Components">
2028 <ul class=
"md-nav__list">
2030 <li class=
"md-nav__item">
2031 <a href=
"#objecttype_1" class=
"md-nav__link">
2042 <li class=
"md-nav__item">
2043 <a href=
"#example" class=
"md-nav__link">
2057 <div class=
"md-content" data-md-component=
"content">
2058 <article class=
"md-content__inner md-typeset">
2061 <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">
2062 <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>
2066 <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>
2067 <p>Add customizable permissions for individual objects.
</p>
2068 <h2 id=
"option-components">Option Components
<a class=
"headerlink" href=
"#option-components" title=
"Permanent link">#
</a></h2>
2069 <p>Each acl option is described as an
<code><option
></code> element with the mandatory attribute
<code>name
</code>.
</p>
2070 <h3 id=
"categoryname"><code><categoryname
></code><a class=
"headerlink" href=
"#categoryname" title=
"Permanent link">#
</a></h3>
2071 <p><span class=
"label label-info">Optional
</span></p>
2072 <p>The name of the acl option category to which the option belongs.
</p>
2073 <h3 id=
"objecttype"><code><objecttype
></code><a class=
"headerlink" href=
"#objecttype" title=
"Permanent link">#
</a></h3>
2074 <p>The name of the acl object type (of the object type definition
<code>com.woltlab.wcf.acl
</code>).
</p>
2075 <h2 id=
"category-components">Category Components
<a class=
"headerlink" href=
"#category-components" title=
"Permanent link">#
</a></h2>
2076 <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>
2077 <h3 id=
"objecttype_1"><code><objecttype
></code><a class=
"headerlink" href=
"#objecttype_1" title=
"Permanent link">#
</a></h3>
2078 <p>The name of the acl object type (of the object type definition
<code>com.woltlab.wcf.acl
</code>).
</p>
2079 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
2080 <div class=
"titledCodeBox">
2081 <div class=
"codeBoxTitle">
2082 <code>aclOption.xml
</code>
2083 <a class=
"codeBoxTitleGitHubLink" href=
"https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/package/pip/aclOption.xml" title=
"View on GitHub"><span class=
"twemoji"><svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5z"/></svg></span></a>
2085 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal"> 1</span>
2086 <span class=
"normal"> 2</span>
2087 <span class=
"normal"> 3</span>
2088 <span class=
"normal"> 4</span>
2089 <span class=
"normal"> 5</span>
2090 <span class=
"normal"> 6</span>
2091 <span class=
"normal"> 7</span>
2092 <span class=
"normal"> 8</span>
2093 <span class=
"normal"> 9</span>
2094 <span class=
"normal">10</span>
2095 <span class=
"normal">11</span>
2096 <span class=
"normal">12</span>
2097 <span class=
"normal">13</span>
2098 <span class=
"normal">14</span>
2099 <span class=
"normal">15</span>
2100 <span class=
"normal">16</span>
2101 <span class=
"normal">17</span>
2102 <span class=
"normal">18</span>
2103 <span class=
"normal">19</span>
2104 <span class=
"normal">20</span>
2105 <span class=
"normal">21</span>
2106 <span class=
"normal">22</span>
2107 <span class=
"normal">23</span>
2108 <span class=
"normal">24</span>
2109 <span class=
"normal">25</span>
2110 <span class=
"normal">26</span>
2111 <span class=
"normal">27</span>
2112 <span class=
"normal">28</span>
2113 <span class=
"normal">29</span>
2114 <span class=
"normal">30</span>
2115 <span class=
"normal">31</span>
2116 <span class=
"normal">32</span>
2117 <span class=
"normal">33</span></pre></div></td><td class=
"code"><div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
2118 <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>
2119 <span class=
"nt"><import
></span>
2120 <span class=
"nt"><categories
></span>
2121 <span class=
"nt"><category
</span> <span class=
"na">name=
</span><span class=
"s">"user.example
"</span><span class=
"nt">></span>
2122 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
2123 <span class=
"nt"></category
></span>
2124 <span class=
"nt"><category
</span> <span class=
"na">name=
</span><span class=
"s">"mod.example
"</span><span class=
"nt">></span>
2125 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
2126 <span class=
"nt"></category
></span>
2127 <span class=
"nt"></categories
></span>
2129 <span class=
"nt"><options
></span>
2130 <span class=
"nt"><option
</span> <span class=
"na">name=
</span><span class=
"s">"canAddExample
"</span><span class=
"nt">></span>
2131 <span class=
"nt"><categoryname
></span>user.example
<span class=
"nt"></categoryname
></span>
2132 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
2133 <span class=
"nt"></option
></span>
2134 <span class=
"nt"><option
</span> <span class=
"na">name=
</span><span class=
"s">"canDeleteExample
"</span><span class=
"nt">></span>
2135 <span class=
"nt"><categoryname
></span>mod.example
<span class=
"nt"></categoryname
></span>
2136 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
2137 <span class=
"nt"></option
></span>
2138 <span class=
"nt"></options
></span>
2139 <span class=
"nt"></import
></span>
2141 <span class=
"nt"><delete
></span>
2142 <span class=
"nt"><optioncategory
</span> <span class=
"na">name=
</span><span class=
"s">"old.example
"</span><span class=
"nt">></span>
2143 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
2144 <span class=
"nt"></optioncategory
></span>
2145 <span class=
"nt"><option
</span> <span class=
"na">name=
</span><span class=
"s">"canDoSomethingWithExample
"</span><span class=
"nt">></span>
2146 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
2147 <span class=
"nt"></option
></span>
2148 <span class=
"nt"></delete
></span>
2149 <span class=
"nt"></data
></span>
2158 <div class=
"md-source-date">
2161 Last update:
2021-
04-
23
2180 <footer class=
"md-footer">
2182 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2184 <a href=
"../" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2185 <div class=
"md-footer__button md-icon">
2186 <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>
2188 <div class=
"md-footer__title">
2189 <div class=
"md-ellipsis">
2190 <span class=
"md-footer__direction">
2199 <a href=
"../acp-menu/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2200 <div class=
"md-footer__title">
2201 <div class=
"md-ellipsis">
2202 <span class=
"md-footer__direction">
2208 <div class=
"md-footer__button md-icon">
2209 <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>
2215 <div class=
"md-footer-meta md-typeset">
2216 <div class=
"md-footer-meta__inner md-grid">
2217 <div class=
"md-footer-copyright">
2219 <div class=
"md-footer-copyright__highlight">
2220 Copyright ©
2020 WoltLab GmbH
2224 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2229 <div class=
"md-footer-copyright">
2230 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2231 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2238 <div class=
"md-dialog" data-md-component=
"dialog">
2239 <div class=
"md-dialog__inner md-typeset"></div>
2241 <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>
2244 <script src=
"../../../assets/javascripts/bundle.4ea5477f.min.js"></script>