5.4/package/pip/acl-option/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11
  12       <link rel="icon" href="../../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.2">
  14
  15
  16
  17         <title>aclOption - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../../assets/stylesheets/main.6f955dcd.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  39
  40
  41
  42
  43
  44   </head>
  45
  46
  47
  48
  49
  50
  51
  52     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  53
  54
  55     <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  56
  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">
  61
  62
  63         <a href="#acl-option-package-installation-plugin" class="md-skip">
  64           Skip to content
  65         </a>
  66
  67     </div>
  68     <div data-md-component="announce">
  69
  70         <aside class="md-announce">
  71           <div class="md-announce__inner md-grid md-typeset">
  72
  73     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  74
  75           </div>
  76         </aside>
  77
  78     </div>
  79
  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">
  83
  84   <img src="../../../assets/logo.png" alt="logo">
  85
  86     </a>
  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>
  89     </label>
  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
  95           </span>
  96         </div>
  97         <div class="md-header__topic" data-md-component="header-topic">
  98           <span class="md-ellipsis">
  99
 100               aclOption
 101
 102           </span>
 103         </div>
 104       </div>
 105     </div>
 106
 107
 108
 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>
 111       </label>
 112
 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>
 121       </label>
 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>
 124       </button>
 125     </form>
 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">
 130             Initializing search
 131           </div>
 132           <ol class="md-search-result__list"></ol>
 133         </div>
 134       </div>
 135     </div>
 136   </div>
 137 </div>
 138
 139
 140       <div class="md-header__source">
 141
 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">
 144
 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>
 146   </div>
 147   <div class="md-source__repository">
 148     GitHub
 149   </div>
 150 </a>
 151       </div>
 152
 153   </nav>
 154 </header>
 155
 156     <div class="md-container" data-md-component="container">
 157
 158
 159
 160
 161       <main class="md-main" data-md-component="main">
 162         <div class="md-main__inner md-grid">
 163
 164
 165
 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">
 169
 170
 171
 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">
 175
 176   <img src="../../../assets/logo.png" alt="logo">
 177
 178     </a>
 179     WoltLab Suite Documentation
 180   </label>
 181
 182     <div class="md-nav__source">
 183
 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">
 186
 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>
 188   </div>
 189   <div class="md-source__repository">
 190     GitHub
 191   </div>
 192 </a>
 193     </div>
 194
 195   <ul class="md-nav__list" data-md-scrollfix>
 196
 197
 198
 199
 200
 201
 202
 203
 204     <li class="md-nav__item">
 205       <a href="../../../getting-started/" class="md-nav__link">
 206         Getting Started
 207       </a>
 208     </li>
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220     <li class="md-nav__item md-nav__item--nested">
 221
 222
 223         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 224
 225       <label class="md-nav__link" for="__nav_2">
 226         PHP API
 227         <span class="md-nav__icon md-icon"></span>
 228       </label>
 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>
 232           PHP API
 233         </label>
 234         <ul class="md-nav__list" data-md-scrollfix>
 235
 236
 237
 238
 239
 240     <li class="md-nav__item">
 241       <a href="../../../php/pages/" class="md-nav__link">
 242         Pages
 243       </a>
 244     </li>
 245
 246
 247
 248
 249
 250
 251
 252     <li class="md-nav__item">
 253       <a href="../../../php/database-objects/" class="md-nav__link">
 254         Database Objects
 255       </a>
 256     </li>
 257
 258
 259
 260
 261
 262
 263
 264     <li class="md-nav__item">
 265       <a href="../../../php/database-access/" class="md-nav__link">
 266         Database Access
 267       </a>
 268     </li>
 269
 270
 271
 272
 273
 274
 275
 276     <li class="md-nav__item">
 277       <a href="../../../php/exceptions/" class="md-nav__link">
 278         Exceptions
 279       </a>
 280     </li>
 281
 282
 283
 284
 285
 286
 287
 288
 289     <li class="md-nav__item md-nav__item--nested">
 290
 291
 292         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 293
 294       <label class="md-nav__link" for="__nav_2_5">
 295         API
 296         <span class="md-nav__icon md-icon"></span>
 297       </label>
 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>
 301           API
 302         </label>
 303         <ul class="md-nav__list" data-md-scrollfix>
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item md-nav__item--nested">
 311
 312
 313         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 314
 315       <label class="md-nav__link" for="__nav_2_5_1">
 316         Caches
 317         <span class="md-nav__icon md-icon"></span>
 318       </label>
 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>
 322           Caches
 323         </label>
 324         <ul class="md-nav__list" data-md-scrollfix>
 325
 326
 327
 328
 329
 330     <li class="md-nav__item">
 331       <a href="../../../php/api/caches/" class="md-nav__link">
 332         Overview
 333       </a>
 334     </li>
 335
 336
 337
 338
 339
 340
 341
 342     <li class="md-nav__item">
 343       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 344         Persistent Caches
 345       </a>
 346     </li>
 347
 348
 349
 350
 351
 352
 353
 354     <li class="md-nav__item">
 355       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 356         Runtime Caches
 357       </a>
 358     </li>
 359
 360
 361
 362         </ul>
 363       </nav>
 364     </li>
 365
 366
 367
 368
 369
 370
 371
 372     <li class="md-nav__item">
 373       <a href="../../../php/api/comments/" class="md-nav__link">
 374         Comments
 375       </a>
 376     </li>
 377
 378
 379
 380
 381
 382
 383
 384     <li class="md-nav__item">
 385       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 386         Cronjobs
 387       </a>
 388     </li>
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../../../php/api/events/" class="md-nav__link">
 398         Events
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409     <li class="md-nav__item md-nav__item--nested">
 410
 411
 412         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 413
 414       <label class="md-nav__link" for="__nav_2_5_5">
 415         Form Builder
 416         <span class="md-nav__icon md-icon"></span>
 417       </label>
 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>
 421           Form Builder
 422         </label>
 423         <ul class="md-nav__list" data-md-scrollfix>
 424
 425
 426
 427
 428
 429     <li class="md-nav__item">
 430       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 431         Overview
 432       </a>
 433     </li>
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 443         Structure
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item">
 454       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 455         Fields
 456       </a>
 457     </li>
 458
 459
 460
 461
 462
 463
 464
 465     <li class="md-nav__item">
 466       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 467         Validation and Data
 468       </a>
 469     </li>
 470
 471
 472
 473
 474
 475
 476
 477     <li class="md-nav__item">
 478       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 479         Dependencies
 480       </a>
 481     </li>
 482
 483
 484
 485         </ul>
 486       </nav>
 487     </li>
 488
 489
 490
 491
 492
 493
 494
 495     <li class="md-nav__item">
 496       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 497         Package Installation Plugins
 498       </a>
 499     </li>
 500
 501
 502
 503
 504
 505
 506
 507     <li class="md-nav__item">
 508       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 509         User Activity Points
 510       </a>
 511     </li>
 512
 513
 514
 515
 516
 517
 518
 519     <li class="md-nav__item">
 520       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 521         User Notifications
 522       </a>
 523     </li>
 524
 525
 526
 527
 528
 529
 530
 531     <li class="md-nav__item">
 532       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 533         Sitemaps
 534       </a>
 535     </li>
 536
 537
 538
 539         </ul>
 540       </nav>
 541     </li>
 542
 543
 544
 545
 546
 547
 548
 549     <li class="md-nav__item">
 550       <a href="../../../php/code-style/" class="md-nav__link">
 551         Code Style
 552       </a>
 553     </li>
 554
 555
 556
 557
 558
 559
 560
 561     <li class="md-nav__item">
 562       <a href="../../../php/apps/" class="md-nav__link">
 563         Apps
 564       </a>
 565     </li>
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../../php/gdpr/" class="md-nav__link">
 575         GDPR
 576       </a>
 577     </li>
 578
 579
 580
 581         </ul>
 582       </nav>
 583     </li>
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595     <li class="md-nav__item md-nav__item--nested">
 596
 597
 598         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 599
 600       <label class="md-nav__link" for="__nav_3">
 601         Languages, Templates & CSS
 602         <span class="md-nav__icon md-icon"></span>
 603       </label>
 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
 608         </label>
 609         <ul class="md-nav__list" data-md-scrollfix>
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../../view/languages/" class="md-nav__link">
 617         Languages
 618       </a>
 619     </li>
 620
 621
 622
 623
 624
 625
 626
 627     <li class="md-nav__item">
 628       <a href="../../../view/templates/" class="md-nav__link">
 629         Templates
 630       </a>
 631     </li>
 632
 633
 634
 635
 636
 637
 638
 639     <li class="md-nav__item">
 640       <a href="../../../view/template-plugins/" class="md-nav__link">
 641         Template Plugins
 642       </a>
 643     </li>
 644
 645
 646
 647
 648
 649
 650
 651     <li class="md-nav__item">
 652       <a href="../../../view/css/" class="md-nav__link">
 653         CSS
 654       </a>
 655     </li>
 656
 657
 658
 659         </ul>
 660       </nav>
 661     </li>
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673     <li class="md-nav__item md-nav__item--nested">
 674
 675
 676         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 677
 678       <label class="md-nav__link" for="__nav_4">
 679         TypeScript and JavaScript API
 680         <span class="md-nav__icon md-icon"></span>
 681       </label>
 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
 686         </label>
 687         <ul class="md-nav__list" data-md-scrollfix>
 688
 689
 690
 691
 692
 693     <li class="md-nav__item">
 694       <a href="../../../javascript/general-usage/" class="md-nav__link">
 695         General Usage
 696       </a>
 697     </li>
 698
 699
 700
 701
 702
 703
 704
 705     <li class="md-nav__item">
 706       <a href="../../../javascript/typescript/" class="md-nav__link">
 707         TypeScript
 708       </a>
 709     </li>
 710
 711
 712
 713
 714
 715
 716
 717
 718     <li class="md-nav__item md-nav__item--nested">
 719
 720
 721         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 722
 723       <label class="md-nav__link" for="__nav_4_3">
 724         New API
 725         <span class="md-nav__icon md-icon"></span>
 726       </label>
 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>
 730           New API
 731         </label>
 732         <ul class="md-nav__list" data-md-scrollfix>
 733
 734
 735
 736
 737
 738     <li class="md-nav__item">
 739       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 740         Writing a module
 741       </a>
 742     </li>
 743
 744
 745
 746
 747
 748
 749
 750     <li class="md-nav__item">
 751       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 752         Data Structures
 753       </a>
 754     </li>
 755
 756
 757
 758
 759
 760
 761
 762     <li class="md-nav__item">
 763       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 764         Core Functions
 765       </a>
 766     </li>
 767
 768
 769
 770
 771
 772
 773
 774     <li class="md-nav__item">
 775       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 776         DOM
 777       </a>
 778     </li>
 779
 780
 781
 782
 783
 784
 785
 786     <li class="md-nav__item">
 787       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 788         Event Handling
 789       </a>
 790     </li>
 791
 792
 793
 794
 795
 796
 797
 798     <li class="md-nav__item">
 799       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 800         Ajax
 801       </a>
 802     </li>
 803
 804
 805
 806
 807
 808
 809
 810     <li class="md-nav__item">
 811       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 812         Dialogs
 813       </a>
 814     </li>
 815
 816
 817
 818
 819
 820
 821
 822     <li class="md-nav__item">
 823       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 824         Browser and Screen Sizes
 825       </a>
 826     </li>
 827
 828
 829
 830
 831
 832
 833
 834     <li class="md-nav__item">
 835       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 836         User Interface
 837       </a>
 838     </li>
 839
 840
 841
 842         </ul>
 843       </nav>
 844     </li>
 845
 846
 847
 848
 849
 850
 851
 852     <li class="md-nav__item">
 853       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 854         Legacy API
 855       </a>
 856     </li>
 857
 858
 859
 860
 861
 862
 863
 864     <li class="md-nav__item">
 865       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 866         Helper Functions
 867       </a>
 868     </li>
 869
 870
 871
 872
 873
 874
 875
 876     <li class="md-nav__item">
 877       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 878         Code Snippets
 879       </a>
 880     </li>
 881
 882
 883
 884         </ul>
 885       </nav>
 886     </li>
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 901
 902
 903         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 904
 905       <label class="md-nav__link" for="__nav_5">
 906         Package Components
 907         <span class="md-nav__icon md-icon"></span>
 908       </label>
 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>
 912           Package Components
 913         </label>
 914         <ul class="md-nav__list" data-md-scrollfix>
 915
 916
 917
 918
 919
 920     <li class="md-nav__item">
 921       <a href="../../package-xml/" class="md-nav__link">
 922         package.xml
 923       </a>
 924     </li>
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 936
 937
 938         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
 939
 940       <label class="md-nav__link" for="__nav_5_2">
 941         PIPs
 942         <span class="md-nav__icon md-icon"></span>
 943       </label>
 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>
 947           PIPs
 948         </label>
 949         <ul class="md-nav__list" data-md-scrollfix>
 950
 951
 952
 953
 954
 955     <li class="md-nav__item">
 956       <a href="../" class="md-nav__link">
 957         Overview
 958       </a>
 959     </li>
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969     <li class="md-nav__item md-nav__item--active">
 970
 971       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 972
 973
 974
 975
 976
 977         <label class="md-nav__link md-nav__link--active" for="__toc">
 978           aclOption
 979           <span class="md-nav__icon md-icon"></span>
 980         </label>
 981
 982       <a href="./" class="md-nav__link md-nav__link--active">
 983         aclOption
 984       </a>
 985
 986
 987 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 988
 989
 990
 991
 992
 993
 994     <label class="md-nav__title" for="__toc">
 995       <span class="md-nav__icon md-icon"></span>
 996       Table of contents
 997     </label>
 998     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 999
1000         <li class="md-nav__item">
1001   <a href="#option-components" class="md-nav__link">
1002     Option Components
1003   </a>
1004
1005     <nav class="md-nav" aria-label="Option Components">
1006       <ul class="md-nav__list">
1007
1008           <li class="md-nav__item">
1009   <a href="#categoryname" class="md-nav__link">
1010     &lt;categoryname&gt;
1011   </a>
1012
1013 </li>
1014
1015           <li class="md-nav__item">
1016   <a href="#objecttype" class="md-nav__link">
1017     &lt;objecttype&gt;
1018   </a>
1019
1020 </li>
1021
1022       </ul>
1023     </nav>
1024
1025 </li>
1026
1027         <li class="md-nav__item">
1028   <a href="#category-components" class="md-nav__link">
1029     Category Components
1030   </a>
1031
1032     <nav class="md-nav" aria-label="Category Components">
1033       <ul class="md-nav__list">
1034
1035           <li class="md-nav__item">
1036   <a href="#objecttype_1" class="md-nav__link">
1037     &lt;objecttype&gt;
1038   </a>
1039
1040 </li>
1041
1042       </ul>
1043     </nav>
1044
1045 </li>
1046
1047         <li class="md-nav__item">
1048   <a href="#example" class="md-nav__link">
1049     Example
1050   </a>
1051
1052 </li>
1053
1054     </ul>
1055
1056 </nav>
1057
1058     </li>
1059
1060
1061
1062
1063
1064
1065
1066     <li class="md-nav__item">
1067       <a href="../acp-menu/" class="md-nav__link">
1068         acpMenu
1069       </a>
1070     </li>
1071
1072
1073
1074
1075
1076
1077
1078     <li class="md-nav__item">
1079       <a href="../acp-search-provider/" class="md-nav__link">
1080         acpSearchProvider
1081       </a>
1082     </li>
1083
1084
1085
1086
1087
1088
1089
1090     <li class="md-nav__item">
1091       <a href="../acp-template/" class="md-nav__link">
1092         acpTemplate
1093       </a>
1094     </li>
1095
1096
1097
1098
1099
1100
1101
1102     <li class="md-nav__item">
1103       <a href="../bbcode/" class="md-nav__link">
1104         bbcode
1105       </a>
1106     </li>
1107
1108
1109
1110
1111
1112
1113
1114     <li class="md-nav__item">
1115       <a href="../box/" class="md-nav__link">
1116         box
1117       </a>
1118     </li>
1119
1120
1121
1122
1123
1124
1125
1126     <li class="md-nav__item">
1127       <a href="../clipboard-action/" class="md-nav__link">
1128         clipboardAction
1129       </a>
1130     </li>
1131
1132
1133
1134
1135
1136
1137
1138     <li class="md-nav__item">
1139       <a href="../core-object/" class="md-nav__link">
1140         coreObject
1141       </a>
1142     </li>
1143
1144
1145
1146
1147
1148
1149
1150     <li class="md-nav__item">
1151       <a href="../cronjob/" class="md-nav__link">
1152         cronjob
1153       </a>
1154     </li>
1155
1156
1157
1158
1159
1160
1161
1162     <li class="md-nav__item">
1163       <a href="../database/" class="md-nav__link">
1164         database
1165       </a>
1166     </li>
1167
1168
1169
1170
1171
1172
1173
1174     <li class="md-nav__item">
1175       <a href="../event-listener/" class="md-nav__link">
1176         eventListener
1177       </a>
1178     </li>
1179
1180
1181
1182
1183
1184
1185
1186     <li class="md-nav__item">
1187       <a href="../file/" class="md-nav__link">
1188         file
1189       </a>
1190     </li>
1191
1192
1193
1194
1195
1196
1197
1198     <li class="md-nav__item">
1199       <a href="../language/" class="md-nav__link">
1200         language
1201       </a>
1202     </li>
1203
1204
1205
1206
1207
1208
1209
1210     <li class="md-nav__item">
1211       <a href="../media-provider/" class="md-nav__link">
1212         mediaProvider
1213       </a>
1214     </li>
1215
1216
1217
1218
1219
1220
1221
1222     <li class="md-nav__item">
1223       <a href="../menu/" class="md-nav__link">
1224         menu
1225       </a>
1226     </li>
1227
1228
1229
1230
1231
1232
1233
1234     <li class="md-nav__item">
1235       <a href="../menu-item/" class="md-nav__link">
1236         menuItem
1237       </a>
1238     </li>
1239
1240
1241
1242
1243
1244
1245
1246     <li class="md-nav__item">
1247       <a href="../object-type/" class="md-nav__link">
1248         objectType
1249       </a>
1250     </li>
1251
1252
1253
1254
1255
1256
1257
1258     <li class="md-nav__item">
1259       <a href="../object-type-definition/" class="md-nav__link">
1260         objectTypeDefinition
1261       </a>
1262     </li>
1263
1264
1265
1266
1267
1268
1269
1270     <li class="md-nav__item">
1271       <a href="../option/" class="md-nav__link">
1272         option
1273       </a>
1274     </li>
1275
1276
1277
1278
1279
1280
1281
1282     <li class="md-nav__item">
1283       <a href="../page/" class="md-nav__link">
1284         page
1285       </a>
1286     </li>
1287
1288
1289
1290
1291
1292
1293
1294     <li class="md-nav__item">
1295       <a href="../pip/" class="md-nav__link">
1296         pip
1297       </a>
1298     </li>
1299
1300
1301
1302
1303
1304
1305
1306     <li class="md-nav__item">
1307       <a href="../script/" class="md-nav__link">
1308         script
1309       </a>
1310     </li>
1311
1312
1313
1314
1315
1316
1317
1318     <li class="md-nav__item">
1319       <a href="../smiley/" class="md-nav__link">
1320         smiley
1321       </a>
1322     </li>
1323
1324
1325
1326
1327
1328
1329
1330     <li class="md-nav__item">
1331       <a href="../sql/" class="md-nav__link">
1332         sql
1333       </a>
1334     </li>
1335
1336
1337
1338
1339
1340
1341
1342     <li class="md-nav__item">
1343       <a href="../style/" class="md-nav__link">
1344         style
1345       </a>
1346     </li>
1347
1348
1349
1350
1351
1352
1353
1354     <li class="md-nav__item">
1355       <a href="../template/" class="md-nav__link">
1356         template
1357       </a>
1358     </li>
1359
1360
1361
1362
1363
1364
1365
1366     <li class="md-nav__item">
1367       <a href="../template-listener/" class="md-nav__link">
1368         templateListener
1369       </a>
1370     </li>
1371
1372
1373
1374
1375
1376
1377
1378     <li class="md-nav__item">
1379       <a href="../user-group-option/" class="md-nav__link">
1380         userGroupOption
1381       </a>
1382     </li>
1383
1384
1385
1386
1387
1388
1389
1390     <li class="md-nav__item">
1391       <a href="../user-menu/" class="md-nav__link">
1392         userMenu
1393       </a>
1394     </li>
1395
1396
1397
1398
1399
1400
1401
1402     <li class="md-nav__item">
1403       <a href="../user-notification-event/" class="md-nav__link">
1404         userNotificationEvent
1405       </a>
1406     </li>
1407
1408
1409
1410
1411
1412
1413
1414     <li class="md-nav__item">
1415       <a href="../user-option/" class="md-nav__link">
1416         userOption
1417       </a>
1418     </li>
1419
1420
1421
1422
1423
1424
1425
1426     <li class="md-nav__item">
1427       <a href="../user-profile-menu/" class="md-nav__link">
1428         userProfileMenu
1429       </a>
1430     </li>
1431
1432
1433
1434         </ul>
1435       </nav>
1436     </li>
1437
1438
1439
1440
1441
1442
1443
1444     <li class="md-nav__item">
1445       <a href="../../database-php-api/" class="md-nav__link">
1446         Database PHP API
1447       </a>
1448     </li>
1449
1450
1451
1452         </ul>
1453       </nav>
1454     </li>
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466     <li class="md-nav__item md-nav__item--nested">
1467
1468
1469         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1470
1471       <label class="md-nav__link" for="__nav_6">
1472         Migration
1473         <span class="md-nav__icon md-icon"></span>
1474       </label>
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>
1478           Migration
1479         </label>
1480         <ul class="md-nav__list" data-md-scrollfix>
1481
1482
1483
1484
1485
1486
1487     <li class="md-nav__item md-nav__item--nested">
1488
1489
1490         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1491
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>
1495       </label>
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
1500         </label>
1501         <ul class="md-nav__list" data-md-scrollfix>
1502
1503
1504
1505
1506
1507     <li class="md-nav__item">
1508       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1509         PHP API
1510       </a>
1511     </li>
1512
1513
1514
1515
1516
1517
1518
1519     <li class="md-nav__item">
1520       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1521         Session Handling and Authentication
1522       </a>
1523     </li>
1524
1525
1526
1527
1528
1529
1530
1531     <li class="md-nav__item">
1532       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1533         TypeScript and JavaScript
1534       </a>
1535     </li>
1536
1537
1538
1539
1540
1541
1542
1543     <li class="md-nav__item">
1544       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1545         Templates
1546       </a>
1547     </li>
1548
1549
1550
1551
1552
1553
1554
1555     <li class="md-nav__item">
1556       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1557         Third Party Libraries
1558       </a>
1559     </li>
1560
1561
1562
1563         </ul>
1564       </nav>
1565     </li>
1566
1567
1568
1569
1570
1571
1572
1573
1574     <li class="md-nav__item md-nav__item--nested">
1575
1576
1577         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1578
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>
1582       </label>
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
1587         </label>
1588         <ul class="md-nav__list" data-md-scrollfix>
1589
1590
1591
1592
1593
1594     <li class="md-nav__item">
1595       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1596         PHP API
1597       </a>
1598     </li>
1599
1600
1601
1602
1603
1604
1605
1606     <li class="md-nav__item">
1607       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1608         Templates and Languages
1609       </a>
1610     </li>
1611
1612
1613
1614
1615
1616
1617
1618     <li class="md-nav__item">
1619       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1620         Third Party Libraries
1621       </a>
1622     </li>
1623
1624
1625
1626         </ul>
1627       </nav>
1628     </li>
1629
1630
1631
1632
1633
1634
1635
1636
1637     <li class="md-nav__item md-nav__item--nested">
1638
1639
1640         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1641
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>
1645       </label>
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
1650         </label>
1651         <ul class="md-nav__list" data-md-scrollfix>
1652
1653
1654
1655
1656
1657     <li class="md-nav__item">
1658       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1659         PHP API
1660       </a>
1661     </li>
1662
1663
1664
1665         </ul>
1666       </nav>
1667     </li>
1668
1669
1670
1671
1672
1673
1674
1675
1676     <li class="md-nav__item md-nav__item--nested">
1677
1678
1679         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1680
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>
1684       </label>
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
1689         </label>
1690         <ul class="md-nav__list" data-md-scrollfix>
1691
1692
1693
1694
1695
1696     <li class="md-nav__item">
1697       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1698         PHP API
1699       </a>
1700     </li>
1701
1702
1703
1704
1705
1706
1707
1708     <li class="md-nav__item">
1709       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1710         JavaScript API
1711       </a>
1712     </li>
1713
1714
1715
1716
1717
1718
1719
1720     <li class="md-nav__item">
1721       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1722         Templates
1723       </a>
1724     </li>
1725
1726
1727
1728
1729
1730
1731
1732     <li class="md-nav__item">
1733       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1734         CSS
1735       </a>
1736     </li>
1737
1738
1739
1740
1741
1742
1743
1744     <li class="md-nav__item">
1745       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1746         Package Components
1747       </a>
1748     </li>
1749
1750
1751
1752         </ul>
1753       </nav>
1754     </li>
1755
1756
1757
1758
1759
1760
1761
1762
1763     <li class="md-nav__item md-nav__item--nested">
1764
1765
1766         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1767
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>
1771       </label>
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
1776         </label>
1777         <ul class="md-nav__list" data-md-scrollfix>
1778
1779
1780
1781
1782
1783     <li class="md-nav__item">
1784       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1785         PHP API
1786       </a>
1787     </li>
1788
1789
1790
1791
1792
1793
1794
1795     <li class="md-nav__item">
1796       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1797         Templates
1798       </a>
1799     </li>
1800
1801
1802
1803
1804
1805
1806
1807     <li class="md-nav__item">
1808       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1809         CSS
1810       </a>
1811     </li>
1812
1813
1814
1815
1816
1817
1818
1819     <li class="md-nav__item">
1820       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1821         Package Components
1822       </a>
1823     </li>
1824
1825
1826
1827         </ul>
1828       </nav>
1829     </li>
1830
1831
1832
1833         </ul>
1834       </nav>
1835     </li>
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847     <li class="md-nav__item md-nav__item--nested">
1848
1849
1850         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1851
1852       <label class="md-nav__link" for="__nav_7">
1853         Tutorials
1854         <span class="md-nav__icon md-icon"></span>
1855       </label>
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>
1859           Tutorials
1860         </label>
1861         <ul class="md-nav__list" data-md-scrollfix>
1862
1863
1864
1865
1866
1867
1868     <li class="md-nav__item md-nav__item--nested">
1869
1870
1871         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1872
1873       <label class="md-nav__link" for="__nav_7_1">
1874         Tutorial Series
1875         <span class="md-nav__icon md-icon"></span>
1876       </label>
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>
1880           Tutorial Series
1881         </label>
1882         <ul class="md-nav__list" data-md-scrollfix>
1883
1884
1885
1886
1887
1888     <li class="md-nav__item">
1889       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1890         Overview
1891       </a>
1892     </li>
1893
1894
1895
1896
1897
1898
1899
1900     <li class="md-nav__item">
1901       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1902         Part 1
1903       </a>
1904     </li>
1905
1906
1907
1908
1909
1910
1911
1912     <li class="md-nav__item">
1913       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1914         Part 2
1915       </a>
1916     </li>
1917
1918
1919
1920
1921
1922
1923
1924     <li class="md-nav__item">
1925       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1926         Part 3
1927       </a>
1928     </li>
1929
1930
1931
1932
1933
1934
1935
1936     <li class="md-nav__item">
1937       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
1938         Part 4
1939       </a>
1940     </li>
1941
1942
1943
1944
1945
1946
1947
1948     <li class="md-nav__item">
1949       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
1950         Part 5
1951       </a>
1952     </li>
1953
1954
1955
1956         </ul>
1957       </nav>
1958     </li>
1959
1960
1961
1962         </ul>
1963       </nav>
1964     </li>
1965
1966
1967
1968   </ul>
1969 </nav>
1970                   </div>
1971                 </div>
1972               </div>
1973
1974
1975
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">
1979
1980 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1981
1982
1983
1984
1985
1986
1987     <label class="md-nav__title" for="__toc">
1988       <span class="md-nav__icon md-icon"></span>
1989       Table of contents
1990     </label>
1991     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1992
1993         <li class="md-nav__item">
1994   <a href="#option-components" class="md-nav__link">
1995     Option Components
1996   </a>
1997
1998     <nav class="md-nav" aria-label="Option Components">
1999       <ul class="md-nav__list">
2000
2001           <li class="md-nav__item">
2002   <a href="#categoryname" class="md-nav__link">
2003     &lt;categoryname&gt;
2004   </a>
2005
2006 </li>
2007
2008           <li class="md-nav__item">
2009   <a href="#objecttype" class="md-nav__link">
2010     &lt;objecttype&gt;
2011   </a>
2012
2013 </li>
2014
2015       </ul>
2016     </nav>
2017
2018 </li>
2019
2020         <li class="md-nav__item">
2021   <a href="#category-components" class="md-nav__link">
2022     Category Components
2023   </a>
2024
2025     <nav class="md-nav" aria-label="Category Components">
2026       <ul class="md-nav__list">
2027
2028           <li class="md-nav__item">
2029   <a href="#objecttype_1" class="md-nav__link">
2030     &lt;objecttype&gt;
2031   </a>
2032
2033 </li>
2034
2035       </ul>
2036     </nav>
2037
2038 </li>
2039
2040         <li class="md-nav__item">
2041   <a href="#example" class="md-nav__link">
2042     Example
2043   </a>
2044
2045 </li>
2046
2047     </ul>
2048
2049 </nav>
2050                   </div>
2051                 </div>
2052               </div>
2053
2054
2055           <div class="md-content" data-md-component="content">
2056             <article class="md-content__inner md-typeset">
2057
2058
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>
2061                   </a>
2062
2063
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>&lt;option&gt;</code> element with the mandatory attribute <code>name</code>.</p>
2068 <h3 id="categoryname"><code>&lt;categoryname&gt;</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>&lt;objecttype&gt;</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>&lt;category&gt;</code> element with the mandatory attribute <code>name</code>  that should follow the naming pattern <code>&lt;permissionName&gt;</code> or <code>&lt;permissionType&gt;.&lt;permissionName&gt;</code>, with <code>&lt;permissionType&gt;</code> generally having <code>user</code> or <code>mod</code> as value.</p>
2075 <h3 id="objecttype_1"><code>&lt;objecttype&gt;</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">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2079 <span class="nt">&lt;data</span> <span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span> <span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span> <span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/aclOption.xsd&quot;</span><span class="nt">&gt;</span>
2080     <span class="nt">&lt;import&gt;</span>
2081         <span class="nt">&lt;categories&gt;</span>
2082             <span class="nt">&lt;category</span> <span class="na">name=</span><span class="s">&quot;user.example&quot;</span><span class="nt">&gt;</span>
2083                 <span class="nt">&lt;objecttype&gt;</span>com.example.wcf.example<span class="nt">&lt;/objecttype&gt;</span>
2084             <span class="nt">&lt;/category&gt;</span>
2085             <span class="nt">&lt;category</span> <span class="na">name=</span><span class="s">&quot;mod.example&quot;</span><span class="nt">&gt;</span>
2086                 <span class="nt">&lt;objecttype&gt;</span>com.example.wcf.example<span class="nt">&lt;/objecttype&gt;</span>
2087             <span class="nt">&lt;/category&gt;</span>
2088         <span class="nt">&lt;/categories&gt;</span>
2089
2090         <span class="nt">&lt;options&gt;</span>
2091             <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;canAddExample&quot;</span><span class="nt">&gt;</span>
2092                 <span class="nt">&lt;categoryname&gt;</span>user.example<span class="nt">&lt;/categoryname&gt;</span>
2093                 <span class="nt">&lt;objecttype&gt;</span>com.example.wcf.example<span class="nt">&lt;/objecttype&gt;</span>
2094             <span class="nt">&lt;/option&gt;</span>
2095             <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;canDeleteExample&quot;</span><span class="nt">&gt;</span>
2096                 <span class="nt">&lt;categoryname&gt;</span>mod.example<span class="nt">&lt;/categoryname&gt;</span>
2097                 <span class="nt">&lt;objecttype&gt;</span>com.example.wcf.example<span class="nt">&lt;/objecttype&gt;</span>
2098             <span class="nt">&lt;/option&gt;</span>
2099         <span class="nt">&lt;/options&gt;</span>
2100     <span class="nt">&lt;/import&gt;</span>
2101
2102     <span class="nt">&lt;delete&gt;</span>
2103         <span class="nt">&lt;optioncategory</span> <span class="na">name=</span><span class="s">&quot;old.example&quot;</span><span class="nt">&gt;</span>
2104            <span class="nt">&lt;objecttype&gt;</span>com.example.wcf.example<span class="nt">&lt;/objecttype&gt;</span>
2105         <span class="nt">&lt;/optioncategory&gt;</span>
2106         <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;canDoSomethingWithExample&quot;</span><span class="nt">&gt;</span>
2107            <span class="nt">&lt;objecttype&gt;</span>com.example.wcf.example<span class="nt">&lt;/objecttype&gt;</span>
2108         <span class="nt">&lt;/option&gt;</span>
2109     <span class="nt">&lt;/delete&gt;</span>
2110 <span class="nt">&lt;/data&gt;</span>
2111 </code></pre></div>
2112
2113
2114
2115
2116 <hr>
2117 <div class="md-source-date">
2118   <small>
2119
2120       Last update: 2021-01-08
2121
2122   </small>
2123 </div>
2124
2125
2126
2127
2128
2129
2130
2131
2132             </article>
2133           </div>
2134         </div>
2135
2136       </main>
2137
2138
2139 <footer class="md-footer">
2140
2141     <nav class="md-footer__inner md-grid" aria-label="Footer">
2142
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>
2146           </div>
2147           <div class="md-footer__title">
2148             <div class="md-ellipsis">
2149               <span class="md-footer__direction">
2150                 Previous
2151               </span>
2152               Overview
2153             </div>
2154           </div>
2155         </a>
2156
2157
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">
2162                 Next
2163               </span>
2164               acpMenu
2165             </div>
2166           </div>
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>
2169           </div>
2170         </a>
2171
2172     </nav>
2173
2174   <div class="md-footer-meta md-typeset">
2175     <div class="md-footer-meta__inner md-grid">
2176       <div class="md-footer-copyright">
2177
2178           <div class="md-footer-copyright__highlight">
2179             Copyright © 2020 WoltLab GmbH
2180           </div>
2181
2182         Made with
2183         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2184           Material for MkDocs
2185         </a>
2186
2187       </div>
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>
2191 </div>
2192     </div>
2193   </div>
2194 </footer>
2195
2196     </div>
2197     <div class="md-dialog" data-md-component="dialog">
2198       <div class="md-dialog__inner md-typeset"></div>
2199     </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>
2201
2202
2203       <script src="../../../assets/javascripts/bundle.4ea5477f.min.js"></script>
2204
2205
2206   </body>
2207 </html>