3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"shortcut icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.0.5">
17 <title>aclOption - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.77f3fd56.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.7fa14f5b.min.css">
28 <meta name=
"theme-color" content=
"#009485">
37 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
51 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
56 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
57 <label class=
"md-overlay" for=
"__drawer"></label>
58 <div data-md-component=
"skip">
61 <a href=
"#acl-option-package-installation-plugin" class=
"md-skip">
66 <div data-md-component=
"announce">
68 <aside class=
"md-announce">
69 <div class=
"md-announce__inner md-grid md-typeset">
71 <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">
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">
106 <div class=
"md-header__options">
110 <label class=
"md-header__button md-icon" for=
"__search">
111 <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>
114 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
115 <label class=
"md-search__overlay" for=
"__search"></label>
116 <div class=
"md-search__inner" role=
"search">
117 <form class=
"md-search__form" name=
"search">
118 <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
>
119 <label class=
"md-search__icon md-icon" for=
"__search">
120 <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>
121 <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>
123 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
124 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41L17.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>
127 <div class=
"md-search__output">
128 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
129 <div class=
"md-search-result" data-md-component=
"search-result">
130 <div class=
"md-search-result__meta">
133 <ol class=
"md-search-result__list"></ol>
144 <div class=
"md-container" data-md-component=
"container">
149 <main class=
"md-main" data-md-component=
"main">
150 <div class=
"md-main__inner md-grid">
154 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
155 <div class=
"md-sidebar__scrollwrap">
156 <div class=
"md-sidebar__inner">
162 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
163 <label class=
"md-nav__title" for=
"__drawer">
164 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
166 <img src=
"../../../assets/logo.png" alt=
"logo">
169 WoltLab Suite Documentation
172 <ul class=
"md-nav__list" data-md-scrollfix
>
181 <li class=
"md-nav__item">
182 <a href=
"../../../getting-started/" class=
"md-nav__link">
197 <li class=
"md-nav__item md-nav__item--nested">
200 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
202 <label class=
"md-nav__link" for=
"__nav_2">
204 <span class=
"md-nav__icon md-icon"></span>
206 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
207 <label class=
"md-nav__title" for=
"__nav_2">
208 <span class=
"md-nav__icon md-icon"></span>
211 <ul class=
"md-nav__list" data-md-scrollfix
>
217 <li class=
"md-nav__item">
218 <a href=
"../../../php/pages/" class=
"md-nav__link">
229 <li class=
"md-nav__item">
230 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
241 <li class=
"md-nav__item">
242 <a href=
"../../../php/database-access/" class=
"md-nav__link">
253 <li class=
"md-nav__item">
254 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
266 <li class=
"md-nav__item md-nav__item--nested">
269 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
271 <label class=
"md-nav__link" for=
"__nav_2_5">
273 <span class=
"md-nav__icon md-icon"></span>
275 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
276 <label class=
"md-nav__title" for=
"__nav_2_5">
277 <span class=
"md-nav__icon md-icon"></span>
280 <ul class=
"md-nav__list" data-md-scrollfix
>
286 <li class=
"md-nav__item">
287 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
298 <li class=
"md-nav__item">
299 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
322 <li class=
"md-nav__item">
323 <a href=
"../../../php/api/events/" class=
"md-nav__link">
335 <li class=
"md-nav__item md-nav__item--nested">
338 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
340 <label class=
"md-nav__link" for=
"__nav_2_5_5">
342 <span class=
"md-nav__icon md-icon"></span>
344 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
345 <label class=
"md-nav__title" for=
"__nav_2_5_5">
346 <span class=
"md-nav__icon md-icon"></span>
349 <ul class=
"md-nav__list" data-md-scrollfix
>
355 <li class=
"md-nav__item">
356 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
367 <li class=
"md-nav__item">
368 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
379 <li class=
"md-nav__item">
380 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
391 <li class=
"md-nav__item">
392 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
403 <li class=
"md-nav__item">
404 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
421 <li class=
"md-nav__item">
422 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
423 Package Installation Plugins
433 <li class=
"md-nav__item">
434 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
445 <li class=
"md-nav__item">
446 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
457 <li class=
"md-nav__item">
458 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
475 <li class=
"md-nav__item">
476 <a href=
"../../../php/code-style/" class=
"md-nav__link">
487 <li class=
"md-nav__item">
488 <a href=
"../../../php/apps/" class=
"md-nav__link">
499 <li class=
"md-nav__item">
500 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
521 <li class=
"md-nav__item md-nav__item--nested">
524 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
526 <label class=
"md-nav__link" for=
"__nav_3">
527 Languages, Templates & CSS
528 <span class=
"md-nav__icon md-icon"></span>
530 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
531 <label class=
"md-nav__title" for=
"__nav_3">
532 <span class=
"md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
535 <ul class=
"md-nav__list" data-md-scrollfix
>
541 <li class=
"md-nav__item">
542 <a href=
"../../../view/languages/" class=
"md-nav__link">
553 <li class=
"md-nav__item">
554 <a href=
"../../../view/templates/" class=
"md-nav__link">
565 <li class=
"md-nav__item">
566 <a href=
"../../../view/css/" class=
"md-nav__link">
587 <li class=
"md-nav__item md-nav__item--nested">
590 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
592 <label class=
"md-nav__link" for=
"__nav_4">
594 <span class=
"md-nav__icon md-icon"></span>
596 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
597 <label class=
"md-nav__title" for=
"__nav_4">
598 <span class=
"md-nav__icon md-icon"></span>
601 <ul class=
"md-nav__list" data-md-scrollfix
>
607 <li class=
"md-nav__item">
608 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
620 <li class=
"md-nav__item md-nav__item--nested">
623 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
625 <label class=
"md-nav__link" for=
"__nav_4_2">
627 <span class=
"md-nav__icon md-icon"></span>
629 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
630 <label class=
"md-nav__title" for=
"__nav_4_2">
631 <span class=
"md-nav__icon md-icon"></span>
634 <ul class=
"md-nav__list" data-md-scrollfix
>
640 <li class=
"md-nav__item">
641 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
652 <li class=
"md-nav__item">
653 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
664 <li class=
"md-nav__item">
665 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
676 <li class=
"md-nav__item">
677 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
688 <li class=
"md-nav__item">
689 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
700 <li class=
"md-nav__item">
701 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
712 <li class=
"md-nav__item">
713 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
724 <li class=
"md-nav__item">
725 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
726 Browser and Screen Sizes
736 <li class=
"md-nav__item">
737 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
754 <li class=
"md-nav__item">
755 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
766 <li class=
"md-nav__item">
767 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
778 <li class=
"md-nav__item">
779 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
802 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
805 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
807 <label class=
"md-nav__link" for=
"__nav_5">
809 <span class=
"md-nav__icon md-icon"></span>
811 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
812 <label class=
"md-nav__title" for=
"__nav_5">
813 <span class=
"md-nav__icon md-icon"></span>
816 <ul class=
"md-nav__list" data-md-scrollfix
>
822 <li class=
"md-nav__item">
823 <a href=
"../../package-xml/" class=
"md-nav__link">
837 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
840 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
842 <label class=
"md-nav__link" for=
"__nav_5_2">
844 <span class=
"md-nav__icon md-icon"></span>
846 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
847 <label class=
"md-nav__title" for=
"__nav_5_2">
848 <span class=
"md-nav__icon md-icon"></span>
851 <ul class=
"md-nav__list" data-md-scrollfix
>
857 <li class=
"md-nav__item">
858 <a href=
"../" class=
"md-nav__link">
871 <li class=
"md-nav__item md-nav__item--active">
873 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
878 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
880 <span class=
"md-nav__icon md-icon"></span>
883 <a href=
"./" class=
"md-nav__link md-nav__link--active">
888 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
894 <label class=
"md-nav__title" for=
"__toc">
895 <span class=
"md-nav__icon md-icon"></span>
898 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
900 <li class=
"md-nav__item">
901 <a href=
"#option-components" class=
"md-nav__link">
905 <nav class=
"md-nav" aria-label=
"Option Components">
906 <ul class=
"md-nav__list">
908 <li class=
"md-nav__item">
909 <a href=
"#categoryname" class=
"md-nav__link">
915 <li class=
"md-nav__item">
916 <a href=
"#objecttype" class=
"md-nav__link">
927 <li class=
"md-nav__item">
928 <a href=
"#category-components" class=
"md-nav__link">
932 <nav class=
"md-nav" aria-label=
"Category Components">
933 <ul class=
"md-nav__list">
935 <li class=
"md-nav__item">
936 <a href=
"#objecttype_1" class=
"md-nav__link">
947 <li class=
"md-nav__item">
948 <a href=
"#example" class=
"md-nav__link">
966 <li class=
"md-nav__item">
967 <a href=
"../acp-menu/" class=
"md-nav__link">
978 <li class=
"md-nav__item">
979 <a href=
"../acp-search-provider/" class=
"md-nav__link">
990 <li class=
"md-nav__item">
991 <a href=
"../acp-template/" class=
"md-nav__link">
1002 <li class=
"md-nav__item">
1003 <a href=
"../bbcode/" class=
"md-nav__link">
1014 <li class=
"md-nav__item">
1015 <a href=
"../box/" class=
"md-nav__link">
1026 <li class=
"md-nav__item">
1027 <a href=
"../clipboard-action/" class=
"md-nav__link">
1038 <li class=
"md-nav__item">
1039 <a href=
"../core-object/" class=
"md-nav__link">
1050 <li class=
"md-nav__item">
1051 <a href=
"../cronjob/" class=
"md-nav__link">
1062 <li class=
"md-nav__item">
1063 <a href=
"../event-listener/" class=
"md-nav__link">
1074 <li class=
"md-nav__item">
1075 <a href=
"../file/" class=
"md-nav__link">
1086 <li class=
"md-nav__item">
1087 <a href=
"../language/" class=
"md-nav__link">
1098 <li class=
"md-nav__item">
1099 <a href=
"../media-provider/" class=
"md-nav__link">
1110 <li class=
"md-nav__item">
1111 <a href=
"../menu/" class=
"md-nav__link">
1122 <li class=
"md-nav__item">
1123 <a href=
"../menu-item/" class=
"md-nav__link">
1134 <li class=
"md-nav__item">
1135 <a href=
"../object-type/" class=
"md-nav__link">
1146 <li class=
"md-nav__item">
1147 <a href=
"../object-type-definition/" class=
"md-nav__link">
1148 objectTypeDefinition
1158 <li class=
"md-nav__item">
1159 <a href=
"../option/" class=
"md-nav__link">
1170 <li class=
"md-nav__item">
1171 <a href=
"../page/" class=
"md-nav__link">
1182 <li class=
"md-nav__item">
1183 <a href=
"../pip/" class=
"md-nav__link">
1194 <li class=
"md-nav__item">
1195 <a href=
"../script/" class=
"md-nav__link">
1206 <li class=
"md-nav__item">
1207 <a href=
"../smiley/" class=
"md-nav__link">
1218 <li class=
"md-nav__item">
1219 <a href=
"../sql/" class=
"md-nav__link">
1230 <li class=
"md-nav__item">
1231 <a href=
"../style/" class=
"md-nav__link">
1242 <li class=
"md-nav__item">
1243 <a href=
"../template/" class=
"md-nav__link">
1254 <li class=
"md-nav__item">
1255 <a href=
"../template-listener/" class=
"md-nav__link">
1266 <li class=
"md-nav__item">
1267 <a href=
"../user-group-option/" class=
"md-nav__link">
1278 <li class=
"md-nav__item">
1279 <a href=
"../user-menu/" class=
"md-nav__link">
1290 <li class=
"md-nav__item">
1291 <a href=
"../user-notification-event/" class=
"md-nav__link">
1292 userNotificationEvent
1302 <li class=
"md-nav__item">
1303 <a href=
"../user-option/" class=
"md-nav__link">
1314 <li class=
"md-nav__item">
1315 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1332 <li class=
"md-nav__item">
1333 <a href=
"../../database-php-api/" class=
"md-nav__link">
1354 <li class=
"md-nav__item md-nav__item--nested">
1357 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1359 <label class=
"md-nav__link" for=
"__nav_6">
1361 <span class=
"md-nav__icon md-icon"></span>
1363 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1364 <label class=
"md-nav__title" for=
"__nav_6">
1365 <span class=
"md-nav__icon md-icon"></span>
1368 <ul class=
"md-nav__list" data-md-scrollfix
>
1375 <li class=
"md-nav__item md-nav__item--nested">
1378 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1380 <label class=
"md-nav__link" for=
"__nav_6_1">
1381 Migrating from WSC
5.3
1382 <span class=
"md-nav__icon md-icon"></span>
1384 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1385 <label class=
"md-nav__title" for=
"__nav_6_1">
1386 <span class=
"md-nav__icon md-icon"></span>
1387 Migrating from WSC
5.3
1389 <ul class=
"md-nav__list" data-md-scrollfix
>
1395 <li class=
"md-nav__item">
1396 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1407 <li class=
"md-nav__item">
1408 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1409 Session Handling and Authentication
1419 <li class=
"md-nav__item">
1420 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1431 <li class=
"md-nav__item">
1432 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1443 <li class=
"md-nav__item">
1444 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1445 Third Party Libraries
1462 <li class=
"md-nav__item md-nav__item--nested">
1465 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1467 <label class=
"md-nav__link" for=
"__nav_6_2">
1468 Migrating from WSC
5.2
1469 <span class=
"md-nav__icon md-icon"></span>
1471 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1472 <label class=
"md-nav__title" for=
"__nav_6_2">
1473 <span class=
"md-nav__icon md-icon"></span>
1474 Migrating from WSC
5.2
1476 <ul class=
"md-nav__list" data-md-scrollfix
>
1482 <li class=
"md-nav__item">
1483 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1494 <li class=
"md-nav__item">
1495 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1496 Templates and Languages
1506 <li class=
"md-nav__item">
1507 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1508 Third Party Libraries
1525 <li class=
"md-nav__item md-nav__item--nested">
1528 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1530 <label class=
"md-nav__link" for=
"__nav_6_3">
1531 Migrating from WSC
3.1
1532 <span class=
"md-nav__icon md-icon"></span>
1534 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1535 <label class=
"md-nav__title" for=
"__nav_6_3">
1536 <span class=
"md-nav__icon md-icon"></span>
1537 Migrating from WSC
3.1
1539 <ul class=
"md-nav__list" data-md-scrollfix
>
1545 <li class=
"md-nav__item">
1546 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1564 <li class=
"md-nav__item md-nav__item--nested">
1567 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1569 <label class=
"md-nav__link" for=
"__nav_6_4">
1570 Migrating from WSC
3.0
1571 <span class=
"md-nav__icon md-icon"></span>
1573 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1574 <label class=
"md-nav__title" for=
"__nav_6_4">
1575 <span class=
"md-nav__icon md-icon"></span>
1576 Migrating from WSC
3.0
1578 <ul class=
"md-nav__list" data-md-scrollfix
>
1584 <li class=
"md-nav__item">
1585 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1596 <li class=
"md-nav__item">
1597 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1608 <li class=
"md-nav__item">
1609 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1620 <li class=
"md-nav__item">
1621 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1632 <li class=
"md-nav__item">
1633 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1651 <li class=
"md-nav__item md-nav__item--nested">
1654 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1656 <label class=
"md-nav__link" for=
"__nav_6_5">
1657 Migrating from WCF
2.1
1658 <span class=
"md-nav__icon md-icon"></span>
1660 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1661 <label class=
"md-nav__title" for=
"__nav_6_5">
1662 <span class=
"md-nav__icon md-icon"></span>
1663 Migrating from WCF
2.1
1665 <ul class=
"md-nav__list" data-md-scrollfix
>
1671 <li class=
"md-nav__item">
1672 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1683 <li class=
"md-nav__item">
1684 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1695 <li class=
"md-nav__item">
1696 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1707 <li class=
"md-nav__item">
1708 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1735 <li class=
"md-nav__item md-nav__item--nested">
1738 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1740 <label class=
"md-nav__link" for=
"__nav_7">
1742 <span class=
"md-nav__icon md-icon"></span>
1744 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1745 <label class=
"md-nav__title" for=
"__nav_7">
1746 <span class=
"md-nav__icon md-icon"></span>
1749 <ul class=
"md-nav__list" data-md-scrollfix
>
1756 <li class=
"md-nav__item md-nav__item--nested">
1759 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1761 <label class=
"md-nav__link" for=
"__nav_7_1">
1763 <span class=
"md-nav__icon md-icon"></span>
1765 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1766 <label class=
"md-nav__title" for=
"__nav_7_1">
1767 <span class=
"md-nav__icon md-icon"></span>
1770 <ul class=
"md-nav__list" data-md-scrollfix
>
1776 <li class=
"md-nav__item">
1777 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1788 <li class=
"md-nav__item">
1789 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1800 <li class=
"md-nav__item">
1801 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1812 <li class=
"md-nav__item">
1813 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1840 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1841 <div class=
"md-sidebar__scrollwrap">
1842 <div class=
"md-sidebar__inner">
1844 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1850 <label class=
"md-nav__title" for=
"__toc">
1851 <span class=
"md-nav__icon md-icon"></span>
1854 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1856 <li class=
"md-nav__item">
1857 <a href=
"#option-components" class=
"md-nav__link">
1861 <nav class=
"md-nav" aria-label=
"Option Components">
1862 <ul class=
"md-nav__list">
1864 <li class=
"md-nav__item">
1865 <a href=
"#categoryname" class=
"md-nav__link">
1866 <categoryname
>
1871 <li class=
"md-nav__item">
1872 <a href=
"#objecttype" class=
"md-nav__link">
1883 <li class=
"md-nav__item">
1884 <a href=
"#category-components" class=
"md-nav__link">
1888 <nav class=
"md-nav" aria-label=
"Category Components">
1889 <ul class=
"md-nav__list">
1891 <li class=
"md-nav__item">
1892 <a href=
"#objecttype_1" class=
"md-nav__link">
1903 <li class=
"md-nav__item">
1904 <a href=
"#example" class=
"md-nav__link">
1918 <div class=
"md-content" data-md-component=
"content">
1919 <article class=
"md-content__inner md-typeset">
1923 <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>
1924 <p>Add customizable permissions for individual objects.
</p>
1925 <h2 id=
"option-components">Option Components
<a class=
"headerlink" href=
"#option-components" title=
"Permanent link">#
</a></h2>
1926 <p>Each acl option is described as an
<code><option
></code> element with the mandatory attribute
<code>name
</code>.
</p>
1927 <h3 id=
"categoryname"><code><categoryname
></code><a class=
"headerlink" href=
"#categoryname" title=
"Permanent link">#
</a></h3>
1928 <p><span class=
"label label-info">Optional
</span></p>
1929 <p>The name of the acl option category to which the option belongs.
</p>
1930 <h3 id=
"objecttype"><code><objecttype
></code><a class=
"headerlink" href=
"#objecttype" title=
"Permanent link">#
</a></h3>
1931 <p>The name of the acl object type (of the object type definition
<code>com.woltlab.wcf.acl
</code>).
</p>
1932 <h2 id=
"category-components">Category Components
<a class=
"headerlink" href=
"#category-components" title=
"Permanent link">#
</a></h2>
1933 <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>
1934 <h3 id=
"objecttype_1"><code><objecttype
></code><a class=
"headerlink" href=
"#objecttype_1" title=
"Permanent link">#
</a></h3>
1935 <p>The name of the acl object type (of the object type definition
<code>com.woltlab.wcf.acl
</code>).
</p>
1936 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
1937 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
1938 <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>
1939 <span class=
"nt"><import
></span>
1940 <span class=
"nt"><categories
></span>
1941 <span class=
"nt"><category
</span> <span class=
"na">name=
</span><span class=
"s">"user.example
"</span><span class=
"nt">></span>
1942 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
1943 <span class=
"nt"></category
></span>
1944 <span class=
"nt"><category
</span> <span class=
"na">name=
</span><span class=
"s">"mod.example
"</span><span class=
"nt">></span>
1945 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
1946 <span class=
"nt"></category
></span>
1947 <span class=
"nt"></categories
></span>
1949 <span class=
"nt"><options
></span>
1950 <span class=
"nt"><option
</span> <span class=
"na">name=
</span><span class=
"s">"canAddExample
"</span><span class=
"nt">></span>
1951 <span class=
"nt"><categoryname
></span>user.example
<span class=
"nt"></categoryname
></span>
1952 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
1953 <span class=
"nt"></option
></span>
1954 <span class=
"nt"><option
</span> <span class=
"na">name=
</span><span class=
"s">"canDeleteExample
"</span><span class=
"nt">></span>
1955 <span class=
"nt"><categoryname
></span>mod.example
<span class=
"nt"></categoryname
></span>
1956 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
1957 <span class=
"nt"></option
></span>
1958 <span class=
"nt"></options
></span>
1959 <span class=
"nt"></import
></span>
1961 <span class=
"nt"><delete
></span>
1962 <span class=
"nt"><optioncategory
</span> <span class=
"na">name=
</span><span class=
"s">"old.example
"</span><span class=
"nt">></span>
1963 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
1964 <span class=
"nt"></optioncategory
></span>
1965 <span class=
"nt"><option
</span> <span class=
"na">name=
</span><span class=
"s">"canDoSomethingWithExample
"</span><span class=
"nt">></span>
1966 <span class=
"nt"><objecttype
></span>com.example.wcf.example
<span class=
"nt"></objecttype
></span>
1967 <span class=
"nt"></option
></span>
1968 <span class=
"nt"></delete
></span>
1969 <span class=
"nt"></data
></span>
1984 <footer class=
"md-footer">
1986 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
1988 <a href=
"../" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
1989 <div class=
"md-footer__button md-icon">
1990 <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>
1992 <div class=
"md-footer__title">
1993 <div class=
"md-ellipsis">
1994 <span class=
"md-footer__direction">
2003 <a href=
"../acp-menu/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2004 <div class=
"md-footer__title">
2005 <div class=
"md-ellipsis">
2006 <span class=
"md-footer__direction">
2012 <div class=
"md-footer__button md-icon">
2013 <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>
2019 <div class=
"md-footer-meta md-typeset">
2020 <div class=
"md-footer-meta__inner md-grid">
2021 <div class=
"md-footer-copyright">
2023 <div class=
"md-footer-copyright__highlight">
2024 Copyright ©
2020 WoltLab GmbH
2028 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2033 <div class=
"md-footer-copyright">
2034 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2035 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2042 <div class=
"md-dialog" data-md-component=
"dialog">
2043 <div class=
"md-dialog__inner md-typeset"></div>
2045 <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.fb4a9340.min.js",
"version": {
"provider":
"mike"}}
</script>
2048 <script src=
"../../../assets/javascripts/bundle.5cf3e710.min.js"></script>