latest/package/pip/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.0">
  14
  15
  16
  17         <title>option - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../../assets/stylesheets/main.33e2939f.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="#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               option
 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     <li class="md-nav__item">
 310       <a href="../../../php/api/caches/" class="md-nav__link">
 311         Caches
 312       </a>
 313     </li>
 314
 315
 316
 317
 318
 319
 320
 321     <li class="md-nav__item">
 322       <a href="../../../php/api/comments/" class="md-nav__link">
 323         Comments
 324       </a>
 325     </li>
 326
 327
 328
 329
 330
 331
 332
 333     <li class="md-nav__item">
 334       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 335         Cronjobs
 336       </a>
 337     </li>
 338
 339
 340
 341
 342
 343
 344
 345     <li class="md-nav__item">
 346       <a href="../../../php/api/events/" class="md-nav__link">
 347         Events
 348       </a>
 349     </li>
 350
 351
 352
 353
 354
 355
 356
 357
 358     <li class="md-nav__item md-nav__item--nested">
 359
 360
 361         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 362
 363       <label class="md-nav__link" for="__nav_2_5_5">
 364         Form Builder
 365         <span class="md-nav__icon md-icon"></span>
 366       </label>
 367       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 368         <label class="md-nav__title" for="__nav_2_5_5">
 369           <span class="md-nav__icon md-icon"></span>
 370           Form Builder
 371         </label>
 372         <ul class="md-nav__list" data-md-scrollfix>
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390     <li class="md-nav__item">
 391       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 392         Structure
 393       </a>
 394     </li>
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 404         Fields
 405       </a>
 406     </li>
 407
 408
 409
 410
 411
 412
 413
 414     <li class="md-nav__item">
 415       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 416         Validation and Data
 417       </a>
 418     </li>
 419
 420
 421
 422
 423
 424
 425
 426     <li class="md-nav__item">
 427       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 428         Dependencies
 429       </a>
 430     </li>
 431
 432
 433
 434         </ul>
 435       </nav>
 436     </li>
 437
 438
 439
 440
 441
 442
 443
 444     <li class="md-nav__item">
 445       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 446         Package Installation Plugins
 447       </a>
 448     </li>
 449
 450
 451
 452
 453
 454
 455
 456     <li class="md-nav__item">
 457       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 458         User Activity Points
 459       </a>
 460     </li>
 461
 462
 463
 464
 465
 466
 467
 468     <li class="md-nav__item">
 469       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 470         User Notifications
 471       </a>
 472     </li>
 473
 474
 475
 476
 477
 478
 479
 480     <li class="md-nav__item">
 481       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 482         Sitemaps
 483       </a>
 484     </li>
 485
 486
 487
 488         </ul>
 489       </nav>
 490     </li>
 491
 492
 493
 494
 495
 496
 497
 498     <li class="md-nav__item">
 499       <a href="../../../php/code-style/" class="md-nav__link">
 500         Code Style
 501       </a>
 502     </li>
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../../php/apps/" class="md-nav__link">
 512         Apps
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522     <li class="md-nav__item">
 523       <a href="../../../php/gdpr/" class="md-nav__link">
 524         GDPR
 525       </a>
 526     </li>
 527
 528
 529
 530         </ul>
 531       </nav>
 532     </li>
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544     <li class="md-nav__item md-nav__item--nested">
 545
 546
 547         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 548
 549       <label class="md-nav__link" for="__nav_3">
 550         Languages, Templates & CSS
 551         <span class="md-nav__icon md-icon"></span>
 552       </label>
 553       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 554         <label class="md-nav__title" for="__nav_3">
 555           <span class="md-nav__icon md-icon"></span>
 556           Languages, Templates & CSS
 557         </label>
 558         <ul class="md-nav__list" data-md-scrollfix>
 559
 560
 561
 562
 563
 564     <li class="md-nav__item">
 565       <a href="../../../view/languages/" class="md-nav__link">
 566         Languages
 567       </a>
 568     </li>
 569
 570
 571
 572
 573
 574
 575
 576     <li class="md-nav__item">
 577       <a href="../../../view/templates/" class="md-nav__link">
 578         Templates
 579       </a>
 580     </li>
 581
 582
 583
 584
 585
 586
 587
 588     <li class="md-nav__item">
 589       <a href="../../../view/css/" class="md-nav__link">
 590         CSS
 591       </a>
 592     </li>
 593
 594
 595
 596         </ul>
 597       </nav>
 598     </li>
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610     <li class="md-nav__item md-nav__item--nested">
 611
 612
 613         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 614
 615       <label class="md-nav__link" for="__nav_4">
 616         TypeScript and JavaScript API
 617         <span class="md-nav__icon md-icon"></span>
 618       </label>
 619       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 620         <label class="md-nav__title" for="__nav_4">
 621           <span class="md-nav__icon md-icon"></span>
 622           TypeScript and JavaScript API
 623         </label>
 624         <ul class="md-nav__list" data-md-scrollfix>
 625
 626
 627
 628
 629
 630     <li class="md-nav__item">
 631       <a href="../../../javascript/general-usage/" class="md-nav__link">
 632         General Usage
 633       </a>
 634     </li>
 635
 636
 637
 638
 639
 640
 641
 642     <li class="md-nav__item">
 643       <a href="../../../javascript/typescript/" class="md-nav__link">
 644         TypeScript
 645       </a>
 646     </li>
 647
 648
 649
 650
 651
 652
 653
 654
 655     <li class="md-nav__item md-nav__item--nested">
 656
 657
 658         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 659
 660       <label class="md-nav__link" for="__nav_4_3">
 661         New API
 662         <span class="md-nav__icon md-icon"></span>
 663       </label>
 664       <nav class="md-nav" aria-label="New API" data-md-level="2">
 665         <label class="md-nav__title" for="__nav_4_3">
 666           <span class="md-nav__icon md-icon"></span>
 667           New API
 668         </label>
 669         <ul class="md-nav__list" data-md-scrollfix>
 670
 671
 672
 673
 674
 675     <li class="md-nav__item">
 676       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 677         Writing a module
 678       </a>
 679     </li>
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item">
 688       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 689         Data Structures
 690       </a>
 691     </li>
 692
 693
 694
 695
 696
 697
 698
 699     <li class="md-nav__item">
 700       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 701         Core Functions
 702       </a>
 703     </li>
 704
 705
 706
 707
 708
 709
 710
 711     <li class="md-nav__item">
 712       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 713         DOM
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 725         Event Handling
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735     <li class="md-nav__item">
 736       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 737         Ajax
 738       </a>
 739     </li>
 740
 741
 742
 743
 744
 745
 746
 747     <li class="md-nav__item">
 748       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 749         Dialogs
 750       </a>
 751     </li>
 752
 753
 754
 755
 756
 757
 758
 759     <li class="md-nav__item">
 760       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 761         Browser and Screen Sizes
 762       </a>
 763     </li>
 764
 765
 766
 767
 768
 769
 770
 771     <li class="md-nav__item">
 772       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 773         User Interface
 774       </a>
 775     </li>
 776
 777
 778
 779         </ul>
 780       </nav>
 781     </li>
 782
 783
 784
 785
 786
 787
 788
 789     <li class="md-nav__item">
 790       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 791         Legacy API
 792       </a>
 793     </li>
 794
 795
 796
 797
 798
 799
 800
 801     <li class="md-nav__item">
 802       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 803         Helper Functions
 804       </a>
 805     </li>
 806
 807
 808
 809
 810
 811
 812
 813     <li class="md-nav__item">
 814       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 815         Code Snippets
 816       </a>
 817     </li>
 818
 819
 820
 821         </ul>
 822       </nav>
 823     </li>
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 838
 839
 840         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 841
 842       <label class="md-nav__link" for="__nav_5">
 843         Package Components
 844         <span class="md-nav__icon md-icon"></span>
 845       </label>
 846       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 847         <label class="md-nav__title" for="__nav_5">
 848           <span class="md-nav__icon md-icon"></span>
 849           Package Components
 850         </label>
 851         <ul class="md-nav__list" data-md-scrollfix>
 852
 853
 854
 855
 856
 857     <li class="md-nav__item">
 858       <a href="../../package-xml/" class="md-nav__link">
 859         package.xml
 860       </a>
 861     </li>
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 873
 874
 875         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
 876
 877       <label class="md-nav__link" for="__nav_5_2">
 878         PIPs
 879         <span class="md-nav__icon md-icon"></span>
 880       </label>
 881       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 882         <label class="md-nav__title" for="__nav_5_2">
 883           <span class="md-nav__icon md-icon"></span>
 884           PIPs
 885         </label>
 886         <ul class="md-nav__list" data-md-scrollfix>
 887
 888
 889
 890
 891
 892     <li class="md-nav__item">
 893       <a href="../" class="md-nav__link">
 894         Overview
 895       </a>
 896     </li>
 897
 898
 899
 900
 901
 902
 903
 904     <li class="md-nav__item">
 905       <a href="../acl-option/" class="md-nav__link">
 906         aclOption
 907       </a>
 908     </li>
 909
 910
 911
 912
 913
 914
 915
 916     <li class="md-nav__item">
 917       <a href="../acp-menu/" class="md-nav__link">
 918         acpMenu
 919       </a>
 920     </li>
 921
 922
 923
 924
 925
 926
 927
 928     <li class="md-nav__item">
 929       <a href="../acp-search-provider/" class="md-nav__link">
 930         acpSearchProvider
 931       </a>
 932     </li>
 933
 934
 935
 936
 937
 938
 939
 940     <li class="md-nav__item">
 941       <a href="../acp-template/" class="md-nav__link">
 942         acpTemplate
 943       </a>
 944     </li>
 945
 946
 947
 948
 949
 950
 951
 952     <li class="md-nav__item">
 953       <a href="../bbcode/" class="md-nav__link">
 954         bbcode
 955       </a>
 956     </li>
 957
 958
 959
 960
 961
 962
 963
 964     <li class="md-nav__item">
 965       <a href="../box/" class="md-nav__link">
 966         box
 967       </a>
 968     </li>
 969
 970
 971
 972
 973
 974
 975
 976     <li class="md-nav__item">
 977       <a href="../clipboard-action/" class="md-nav__link">
 978         clipboardAction
 979       </a>
 980     </li>
 981
 982
 983
 984
 985
 986
 987
 988     <li class="md-nav__item">
 989       <a href="../core-object/" class="md-nav__link">
 990         coreObject
 991       </a>
 992     </li>
 993
 994
 995
 996
 997
 998
 999
1000     <li class="md-nav__item">
1001       <a href="../cronjob/" class="md-nav__link">
1002         cronjob
1003       </a>
1004     </li>
1005
1006
1007
1008
1009
1010
1011
1012     <li class="md-nav__item">
1013       <a href="../event-listener/" class="md-nav__link">
1014         eventListener
1015       </a>
1016     </li>
1017
1018
1019
1020
1021
1022
1023
1024     <li class="md-nav__item">
1025       <a href="../file/" class="md-nav__link">
1026         file
1027       </a>
1028     </li>
1029
1030
1031
1032
1033
1034
1035
1036     <li class="md-nav__item">
1037       <a href="../language/" class="md-nav__link">
1038         language
1039       </a>
1040     </li>
1041
1042
1043
1044
1045
1046
1047
1048     <li class="md-nav__item">
1049       <a href="../media-provider/" class="md-nav__link">
1050         mediaProvider
1051       </a>
1052     </li>
1053
1054
1055
1056
1057
1058
1059
1060     <li class="md-nav__item">
1061       <a href="../menu/" class="md-nav__link">
1062         menu
1063       </a>
1064     </li>
1065
1066
1067
1068
1069
1070
1071
1072     <li class="md-nav__item">
1073       <a href="../menu-item/" class="md-nav__link">
1074         menuItem
1075       </a>
1076     </li>
1077
1078
1079
1080
1081
1082
1083
1084     <li class="md-nav__item">
1085       <a href="../object-type/" class="md-nav__link">
1086         objectType
1087       </a>
1088     </li>
1089
1090
1091
1092
1093
1094
1095
1096     <li class="md-nav__item">
1097       <a href="../object-type-definition/" class="md-nav__link">
1098         objectTypeDefinition
1099       </a>
1100     </li>
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110     <li class="md-nav__item md-nav__item--active">
1111
1112       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1113
1114
1115
1116
1117         <label class="md-nav__link md-nav__link--active" for="__toc">
1118           option
1119           <span class="md-nav__icon md-icon"></span>
1120         </label>
1121
1122       <a href="./" class="md-nav__link md-nav__link--active">
1123         option
1124       </a>
1125
1126
1127 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1128
1129
1130
1131
1132
1133     <label class="md-nav__title" for="__toc">
1134       <span class="md-nav__icon md-icon"></span>
1135       Table of contents
1136     </label>
1137     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1138
1139         <li class="md-nav__item">
1140   <a href="#category-components" class="md-nav__link">
1141     Category Components
1142   </a>
1143
1144     <nav class="md-nav" aria-label="Category Components">
1145       <ul class="md-nav__list">
1146
1147           <li class="md-nav__item">
1148   <a href="#parent" class="md-nav__link">
1149     &lt;parent&gt;
1150   </a>
1151
1152 </li>
1153
1154           <li class="md-nav__item">
1155   <a href="#showorder" class="md-nav__link">
1156     &lt;showorder&gt;
1157   </a>
1158
1159 </li>
1160
1161           <li class="md-nav__item">
1162   <a href="#options" class="md-nav__link">
1163     &lt;options&gt;
1164   </a>
1165
1166 </li>
1167
1168       </ul>
1169     </nav>
1170
1171 </li>
1172
1173         <li class="md-nav__item">
1174   <a href="#option-components" class="md-nav__link">
1175     Option Components
1176   </a>
1177
1178     <nav class="md-nav" aria-label="Option Components">
1179       <ul class="md-nav__list">
1180
1181           <li class="md-nav__item">
1182   <a href="#categoryname" class="md-nav__link">
1183     &lt;categoryname&gt;
1184   </a>
1185
1186 </li>
1187
1188           <li class="md-nav__item">
1189   <a href="#optiontype" class="md-nav__link">
1190     &lt;optiontype&gt;
1191   </a>
1192
1193 </li>
1194
1195           <li class="md-nav__item">
1196   <a href="#defaultvalue" class="md-nav__link">
1197     &lt;defaultvalue&gt;
1198   </a>
1199
1200 </li>
1201
1202           <li class="md-nav__item">
1203   <a href="#validationpattern" class="md-nav__link">
1204     &lt;validationpattern&gt;
1205   </a>
1206
1207 </li>
1208
1209           <li class="md-nav__item">
1210   <a href="#showorder_1" class="md-nav__link">
1211     &lt;showorder&gt;
1212   </a>
1213
1214 </li>
1215
1216           <li class="md-nav__item">
1217   <a href="#selectoptions" class="md-nav__link">
1218     &lt;selectoptions&gt;
1219   </a>
1220
1221 </li>
1222
1223           <li class="md-nav__item">
1224   <a href="#enableoptions" class="md-nav__link">
1225     &lt;enableoptions&gt;
1226   </a>
1227
1228 </li>
1229
1230           <li class="md-nav__item">
1231   <a href="#hidden" class="md-nav__link">
1232     &lt;hidden&gt;
1233   </a>
1234
1235 </li>
1236
1237           <li class="md-nav__item">
1238   <a href="#options_1" class="md-nav__link">
1239     &lt;options&gt;
1240   </a>
1241
1242 </li>
1243
1244           <li class="md-nav__item">
1245   <a href="#supporti18n" class="md-nav__link">
1246     &lt;supporti18n&gt;
1247   </a>
1248
1249 </li>
1250
1251           <li class="md-nav__item">
1252   <a href="#requirei18n" class="md-nav__link">
1253     &lt;requirei18n&gt;
1254   </a>
1255
1256 </li>
1257
1258           <li class="md-nav__item">
1259   <a href="#_1" class="md-nav__link">
1260     &lt;*&gt;
1261   </a>
1262
1263 </li>
1264
1265       </ul>
1266     </nav>
1267
1268 </li>
1269
1270         <li class="md-nav__item">
1271   <a href="#language-items" class="md-nav__link">
1272     Language Items
1273   </a>
1274
1275     <nav class="md-nav" aria-label="Language Items">
1276       <ul class="md-nav__list">
1277
1278           <li class="md-nav__item">
1279   <a href="#categories" class="md-nav__link">
1280     Categories
1281   </a>
1282
1283 </li>
1284
1285           <li class="md-nav__item">
1286   <a href="#options_2" class="md-nav__link">
1287     Options
1288   </a>
1289
1290 </li>
1291
1292       </ul>
1293     </nav>
1294
1295 </li>
1296
1297         <li class="md-nav__item">
1298   <a href="#example" class="md-nav__link">
1299     Example
1300   </a>
1301
1302 </li>
1303
1304     </ul>
1305
1306 </nav>
1307
1308     </li>
1309
1310
1311
1312
1313
1314
1315
1316     <li class="md-nav__item">
1317       <a href="../page/" class="md-nav__link">
1318         page
1319       </a>
1320     </li>
1321
1322
1323
1324
1325
1326
1327
1328     <li class="md-nav__item">
1329       <a href="../pip/" class="md-nav__link">
1330         pip
1331       </a>
1332     </li>
1333
1334
1335
1336
1337
1338
1339
1340     <li class="md-nav__item">
1341       <a href="../script/" class="md-nav__link">
1342         script
1343       </a>
1344     </li>
1345
1346
1347
1348
1349
1350
1351
1352     <li class="md-nav__item">
1353       <a href="../smiley/" class="md-nav__link">
1354         smiley
1355       </a>
1356     </li>
1357
1358
1359
1360
1361
1362
1363
1364     <li class="md-nav__item">
1365       <a href="../sql/" class="md-nav__link">
1366         sql
1367       </a>
1368     </li>
1369
1370
1371
1372
1373
1374
1375
1376     <li class="md-nav__item">
1377       <a href="../style/" class="md-nav__link">
1378         style
1379       </a>
1380     </li>
1381
1382
1383
1384
1385
1386
1387
1388     <li class="md-nav__item">
1389       <a href="../template/" class="md-nav__link">
1390         template
1391       </a>
1392     </li>
1393
1394
1395
1396
1397
1398
1399
1400     <li class="md-nav__item">
1401       <a href="../template-listener/" class="md-nav__link">
1402         templateListener
1403       </a>
1404     </li>
1405
1406
1407
1408
1409
1410
1411
1412     <li class="md-nav__item">
1413       <a href="../user-group-option/" class="md-nav__link">
1414         userGroupOption
1415       </a>
1416     </li>
1417
1418
1419
1420
1421
1422
1423
1424     <li class="md-nav__item">
1425       <a href="../user-menu/" class="md-nav__link">
1426         userMenu
1427       </a>
1428     </li>
1429
1430
1431
1432
1433
1434
1435
1436     <li class="md-nav__item">
1437       <a href="../user-notification-event/" class="md-nav__link">
1438         userNotificationEvent
1439       </a>
1440     </li>
1441
1442
1443
1444
1445
1446
1447
1448     <li class="md-nav__item">
1449       <a href="../user-option/" class="md-nav__link">
1450         userOption
1451       </a>
1452     </li>
1453
1454
1455
1456
1457
1458
1459
1460     <li class="md-nav__item">
1461       <a href="../user-profile-menu/" class="md-nav__link">
1462         userProfileMenu
1463       </a>
1464     </li>
1465
1466
1467
1468         </ul>
1469       </nav>
1470     </li>
1471
1472
1473
1474
1475
1476
1477
1478     <li class="md-nav__item">
1479       <a href="../../database-php-api/" class="md-nav__link">
1480         Database PHP API
1481       </a>
1482     </li>
1483
1484
1485
1486         </ul>
1487       </nav>
1488     </li>
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500     <li class="md-nav__item md-nav__item--nested">
1501
1502
1503         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1504
1505       <label class="md-nav__link" for="__nav_6">
1506         Migration
1507         <span class="md-nav__icon md-icon"></span>
1508       </label>
1509       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1510         <label class="md-nav__title" for="__nav_6">
1511           <span class="md-nav__icon md-icon"></span>
1512           Migration
1513         </label>
1514         <ul class="md-nav__list" data-md-scrollfix>
1515
1516
1517
1518
1519
1520
1521     <li class="md-nav__item md-nav__item--nested">
1522
1523
1524         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1525
1526       <label class="md-nav__link" for="__nav_6_1">
1527         Migrating from WSC 5.3
1528         <span class="md-nav__icon md-icon"></span>
1529       </label>
1530       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1531         <label class="md-nav__title" for="__nav_6_1">
1532           <span class="md-nav__icon md-icon"></span>
1533           Migrating from WSC 5.3
1534         </label>
1535         <ul class="md-nav__list" data-md-scrollfix>
1536
1537
1538
1539
1540
1541     <li class="md-nav__item">
1542       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1543         PHP API
1544       </a>
1545     </li>
1546
1547
1548
1549
1550
1551
1552
1553     <li class="md-nav__item">
1554       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1555         Session Handling and Authentication
1556       </a>
1557     </li>
1558
1559
1560
1561
1562
1563
1564
1565     <li class="md-nav__item">
1566       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1567         TypeScript and JavaScript
1568       </a>
1569     </li>
1570
1571
1572
1573
1574
1575
1576
1577     <li class="md-nav__item">
1578       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1579         Templates
1580       </a>
1581     </li>
1582
1583
1584
1585
1586
1587
1588
1589     <li class="md-nav__item">
1590       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1591         Third Party Libraries
1592       </a>
1593     </li>
1594
1595
1596
1597         </ul>
1598       </nav>
1599     </li>
1600
1601
1602
1603
1604
1605
1606
1607
1608     <li class="md-nav__item md-nav__item--nested">
1609
1610
1611         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1612
1613       <label class="md-nav__link" for="__nav_6_2">
1614         Migrating from WSC 5.2
1615         <span class="md-nav__icon md-icon"></span>
1616       </label>
1617       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1618         <label class="md-nav__title" for="__nav_6_2">
1619           <span class="md-nav__icon md-icon"></span>
1620           Migrating from WSC 5.2
1621         </label>
1622         <ul class="md-nav__list" data-md-scrollfix>
1623
1624
1625
1626
1627
1628     <li class="md-nav__item">
1629       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1630         PHP API
1631       </a>
1632     </li>
1633
1634
1635
1636
1637
1638
1639
1640     <li class="md-nav__item">
1641       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1642         Templates and Languages
1643       </a>
1644     </li>
1645
1646
1647
1648
1649
1650
1651
1652     <li class="md-nav__item">
1653       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1654         Third Party Libraries
1655       </a>
1656     </li>
1657
1658
1659
1660         </ul>
1661       </nav>
1662     </li>
1663
1664
1665
1666
1667
1668
1669
1670
1671     <li class="md-nav__item md-nav__item--nested">
1672
1673
1674         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1675
1676       <label class="md-nav__link" for="__nav_6_3">
1677         Migrating from WSC 3.1
1678         <span class="md-nav__icon md-icon"></span>
1679       </label>
1680       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1681         <label class="md-nav__title" for="__nav_6_3">
1682           <span class="md-nav__icon md-icon"></span>
1683           Migrating from WSC 3.1
1684         </label>
1685         <ul class="md-nav__list" data-md-scrollfix>
1686
1687
1688
1689
1690
1691     <li class="md-nav__item">
1692       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1693         PHP API
1694       </a>
1695     </li>
1696
1697
1698
1699         </ul>
1700       </nav>
1701     </li>
1702
1703
1704
1705
1706
1707
1708
1709
1710     <li class="md-nav__item md-nav__item--nested">
1711
1712
1713         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1714
1715       <label class="md-nav__link" for="__nav_6_4">
1716         Migrating from WSC 3.0
1717         <span class="md-nav__icon md-icon"></span>
1718       </label>
1719       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1720         <label class="md-nav__title" for="__nav_6_4">
1721           <span class="md-nav__icon md-icon"></span>
1722           Migrating from WSC 3.0
1723         </label>
1724         <ul class="md-nav__list" data-md-scrollfix>
1725
1726
1727
1728
1729
1730     <li class="md-nav__item">
1731       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1732         PHP API
1733       </a>
1734     </li>
1735
1736
1737
1738
1739
1740
1741
1742     <li class="md-nav__item">
1743       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1744         JavaScript API
1745       </a>
1746     </li>
1747
1748
1749
1750
1751
1752
1753
1754     <li class="md-nav__item">
1755       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1756         Templates
1757       </a>
1758     </li>
1759
1760
1761
1762
1763
1764
1765
1766     <li class="md-nav__item">
1767       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1768         CSS
1769       </a>
1770     </li>
1771
1772
1773
1774
1775
1776
1777
1778     <li class="md-nav__item">
1779       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1780         Package Components
1781       </a>
1782     </li>
1783
1784
1785
1786         </ul>
1787       </nav>
1788     </li>
1789
1790
1791
1792
1793
1794
1795
1796
1797     <li class="md-nav__item md-nav__item--nested">
1798
1799
1800         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1801
1802       <label class="md-nav__link" for="__nav_6_5">
1803         Migrating from WCF 2.1
1804         <span class="md-nav__icon md-icon"></span>
1805       </label>
1806       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1807         <label class="md-nav__title" for="__nav_6_5">
1808           <span class="md-nav__icon md-icon"></span>
1809           Migrating from WCF 2.1
1810         </label>
1811         <ul class="md-nav__list" data-md-scrollfix>
1812
1813
1814
1815
1816
1817     <li class="md-nav__item">
1818       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1819         PHP API
1820       </a>
1821     </li>
1822
1823
1824
1825
1826
1827
1828
1829     <li class="md-nav__item">
1830       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1831         Templates
1832       </a>
1833     </li>
1834
1835
1836
1837
1838
1839
1840
1841     <li class="md-nav__item">
1842       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1843         CSS
1844       </a>
1845     </li>
1846
1847
1848
1849
1850
1851
1852
1853     <li class="md-nav__item">
1854       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1855         Package Components
1856       </a>
1857     </li>
1858
1859
1860
1861         </ul>
1862       </nav>
1863     </li>
1864
1865
1866
1867         </ul>
1868       </nav>
1869     </li>
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881     <li class="md-nav__item md-nav__item--nested">
1882
1883
1884         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1885
1886       <label class="md-nav__link" for="__nav_7">
1887         Tutorials
1888         <span class="md-nav__icon md-icon"></span>
1889       </label>
1890       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1891         <label class="md-nav__title" for="__nav_7">
1892           <span class="md-nav__icon md-icon"></span>
1893           Tutorials
1894         </label>
1895         <ul class="md-nav__list" data-md-scrollfix>
1896
1897
1898
1899
1900
1901
1902     <li class="md-nav__item md-nav__item--nested">
1903
1904
1905         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1906
1907       <label class="md-nav__link" for="__nav_7_1">
1908         Tutorial Series
1909         <span class="md-nav__icon md-icon"></span>
1910       </label>
1911       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1912         <label class="md-nav__title" for="__nav_7_1">
1913           <span class="md-nav__icon md-icon"></span>
1914           Tutorial Series
1915         </label>
1916         <ul class="md-nav__list" data-md-scrollfix>
1917
1918
1919
1920
1921
1922     <li class="md-nav__item">
1923       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1924         Overview
1925       </a>
1926     </li>
1927
1928
1929
1930
1931
1932
1933
1934     <li class="md-nav__item">
1935       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1936         Part 1
1937       </a>
1938     </li>
1939
1940
1941
1942
1943
1944
1945
1946     <li class="md-nav__item">
1947       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1948         Part 2
1949       </a>
1950     </li>
1951
1952
1953
1954
1955
1956
1957
1958     <li class="md-nav__item">
1959       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1960         Part 3
1961       </a>
1962     </li>
1963
1964
1965
1966         </ul>
1967       </nav>
1968     </li>
1969
1970
1971
1972         </ul>
1973       </nav>
1974     </li>
1975
1976
1977
1978   </ul>
1979 </nav>
1980                   </div>
1981                 </div>
1982               </div>
1983
1984
1985
1986               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1987                 <div class="md-sidebar__scrollwrap">
1988                   <div class="md-sidebar__inner">
1989
1990 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1991
1992
1993
1994
1995
1996     <label class="md-nav__title" for="__toc">
1997       <span class="md-nav__icon md-icon"></span>
1998       Table of contents
1999     </label>
2000     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2001
2002         <li class="md-nav__item">
2003   <a href="#category-components" class="md-nav__link">
2004     Category Components
2005   </a>
2006
2007     <nav class="md-nav" aria-label="Category Components">
2008       <ul class="md-nav__list">
2009
2010           <li class="md-nav__item">
2011   <a href="#parent" class="md-nav__link">
2012     &lt;parent&gt;
2013   </a>
2014
2015 </li>
2016
2017           <li class="md-nav__item">
2018   <a href="#showorder" class="md-nav__link">
2019     &lt;showorder&gt;
2020   </a>
2021
2022 </li>
2023
2024           <li class="md-nav__item">
2025   <a href="#options" class="md-nav__link">
2026     &lt;options&gt;
2027   </a>
2028
2029 </li>
2030
2031       </ul>
2032     </nav>
2033
2034 </li>
2035
2036         <li class="md-nav__item">
2037   <a href="#option-components" class="md-nav__link">
2038     Option Components
2039   </a>
2040
2041     <nav class="md-nav" aria-label="Option Components">
2042       <ul class="md-nav__list">
2043
2044           <li class="md-nav__item">
2045   <a href="#categoryname" class="md-nav__link">
2046     &lt;categoryname&gt;
2047   </a>
2048
2049 </li>
2050
2051           <li class="md-nav__item">
2052   <a href="#optiontype" class="md-nav__link">
2053     &lt;optiontype&gt;
2054   </a>
2055
2056 </li>
2057
2058           <li class="md-nav__item">
2059   <a href="#defaultvalue" class="md-nav__link">
2060     &lt;defaultvalue&gt;
2061   </a>
2062
2063 </li>
2064
2065           <li class="md-nav__item">
2066   <a href="#validationpattern" class="md-nav__link">
2067     &lt;validationpattern&gt;
2068   </a>
2069
2070 </li>
2071
2072           <li class="md-nav__item">
2073   <a href="#showorder_1" class="md-nav__link">
2074     &lt;showorder&gt;
2075   </a>
2076
2077 </li>
2078
2079           <li class="md-nav__item">
2080   <a href="#selectoptions" class="md-nav__link">
2081     &lt;selectoptions&gt;
2082   </a>
2083
2084 </li>
2085
2086           <li class="md-nav__item">
2087   <a href="#enableoptions" class="md-nav__link">
2088     &lt;enableoptions&gt;
2089   </a>
2090
2091 </li>
2092
2093           <li class="md-nav__item">
2094   <a href="#hidden" class="md-nav__link">
2095     &lt;hidden&gt;
2096   </a>
2097
2098 </li>
2099
2100           <li class="md-nav__item">
2101   <a href="#options_1" class="md-nav__link">
2102     &lt;options&gt;
2103   </a>
2104
2105 </li>
2106
2107           <li class="md-nav__item">
2108   <a href="#supporti18n" class="md-nav__link">
2109     &lt;supporti18n&gt;
2110   </a>
2111
2112 </li>
2113
2114           <li class="md-nav__item">
2115   <a href="#requirei18n" class="md-nav__link">
2116     &lt;requirei18n&gt;
2117   </a>
2118
2119 </li>
2120
2121           <li class="md-nav__item">
2122   <a href="#_1" class="md-nav__link">
2123     &lt;*&gt;
2124   </a>
2125
2126 </li>
2127
2128       </ul>
2129     </nav>
2130
2131 </li>
2132
2133         <li class="md-nav__item">
2134   <a href="#language-items" class="md-nav__link">
2135     Language Items
2136   </a>
2137
2138     <nav class="md-nav" aria-label="Language Items">
2139       <ul class="md-nav__list">
2140
2141           <li class="md-nav__item">
2142   <a href="#categories" class="md-nav__link">
2143     Categories
2144   </a>
2145
2146 </li>
2147
2148           <li class="md-nav__item">
2149   <a href="#options_2" class="md-nav__link">
2150     Options
2151   </a>
2152
2153 </li>
2154
2155       </ul>
2156     </nav>
2157
2158 </li>
2159
2160         <li class="md-nav__item">
2161   <a href="#example" class="md-nav__link">
2162     Example
2163   </a>
2164
2165 </li>
2166
2167     </ul>
2168
2169 </nav>
2170                   </div>
2171                 </div>
2172               </div>
2173
2174
2175           <div class="md-content" data-md-component="content">
2176             <article class="md-content__inner md-typeset">
2177
2178
2179                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/option.md" title="Edit this page" class="md-content__button md-icon">
2180                     <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>
2181                   </a>
2182
2183
2184                 <h1 id="option-package-installation-plugin">Option Package Installation Plugin<a class="headerlink" href="#option-package-installation-plugin" title="Permanent link">#</a></h1>
2185 <p>Registers new options.
2186 Options allow the administrator to configure the behaviour of installed packages.
2187 The specified values are exposed as PHP constants.</p>
2188 <h2 id="category-components">Category Components<a class="headerlink" href="#category-components" title="Permanent link">#</a></h2>
2189 <p>Each category is described as an <code>&lt;category&gt;</code> element with the mandatory attribute <code>name</code>.</p>
2190 <h3 id="parent"><code>&lt;parent&gt;</code><a class="headerlink" href="#parent" title="Permanent link">#</a></h3>
2191 <p><span class="label label-info">Optional</span></p>
2192 <p>The category’s parent category.</p>
2193 <h3 id="showorder"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder" title="Permanent link">#</a></h3>
2194 <p><span class="label label-info">Optional</span></p>
2195 <p>Specifies the order of this option within the parent category.</p>
2196 <h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2197 <p><span class="label label-info">Optional</span></p>
2198 <p>The options element can contain a comma-separated list of options of which at least one needs to be enabled for the category to be shown to the administrator.</p>
2199 <h2 id="option-components">Option Components<a class="headerlink" href="#option-components" title="Permanent link">#</a></h2>
2200 <p>Each option is described as an <code>&lt;option&gt;</code> element with the mandatory attribute <code>name</code>.
2201 The <code>name</code> is transformed into a PHP constant name by uppercasing it.</p>
2202 <h3 id="categoryname"><code>&lt;categoryname&gt;</code><a class="headerlink" href="#categoryname" title="Permanent link">#</a></h3>
2203 <p>The option’s category.</p>
2204 <h3 id="optiontype"><code>&lt;optiontype&gt;</code><a class="headerlink" href="#optiontype" title="Permanent link">#</a></h3>
2205 <p>The type of input to be used for this option.
2206 Valid types are defined by the <code>wcf\system\option\*OptionType</code> classes.</p>
2207 <h3 id="defaultvalue"><code>&lt;defaultvalue&gt;</code><a class="headerlink" href="#defaultvalue" title="Permanent link">#</a></h3>
2208 <p>The value that is set after installation of a package.
2209 Valid values are defined by the <code>optiontype</code>.</p>
2210 <h3 id="validationpattern"><code>&lt;validationpattern&gt;</code><a class="headerlink" href="#validationpattern" title="Permanent link">#</a></h3>
2211 <p><span class="label label-info">Optional</span></p>
2212 <p>Defines a regular expression that is used to validate the value of a free form option (such as <code>text</code>).</p>
2213 <h3 id="showorder_1"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder_1" title="Permanent link">#</a></h3>
2214 <p><span class="label label-info">Optional</span></p>
2215 <p>Specifies the order of this option within the category.</p>
2216 <h3 id="selectoptions"><code>&lt;selectoptions&gt;</code><a class="headerlink" href="#selectoptions" title="Permanent link">#</a></h3>
2217 <p><span class="label label-info">Optional</span></p>
2218 <div class="admonition warning">
2219 <p class="admonition-title">Defined only for <code>select</code>, <code>multiSelect</code> and <code>radioButton</code> types.</p>
2220 </div>
2221 <p>Specifies a newline-separated list of selectable values.
2222 Each line consists of an internal handle, followed by a colon (<code>:</code>, U+003A), followed by a language item.
2223 The language item is shown to the administrator, the internal handle is what is saved and exposed to the code.</p>
2224 <h3 id="enableoptions"><code>&lt;enableoptions&gt;</code><a class="headerlink" href="#enableoptions" title="Permanent link">#</a></h3>
2225 <p><span class="label label-info">Optional</span></p>
2226 <div class="admonition warning">
2227 <p class="admonition-title">Defined only for <code>boolean</code>, <code>select</code> and <code>radioButton</code> types.</p>
2228 </div>
2229 <p>Specifies a comma-separated list of options which should be visually enabled when this option is enabled.
2230 A leading exclamation mark (<code>!</code>, U+0021) will disable the specified option when this option is enabled.
2231 For <code>select</code> and <code>radioButton</code> types the list should be prefixed by the internal <a href="#selectoptions"><code>selectoptions</code></a> handle followed by a colon (<code>:</code>, U+003A).</p>
2232 <p>This setting is a visual helper for the administrator only.
2233 It does not have an effect on the server side processing of the option.</p>
2234 <h3 id="hidden"><code>&lt;hidden&gt;</code><a class="headerlink" href="#hidden" title="Permanent link">#</a></h3>
2235 <p><span class="label label-info">Optional</span></p>
2236 <p>If <code>hidden</code> is set to <code>1</code> the option will not be shown to the administrator.
2237 It still can be modified programmatically.</p>
2238 <h3 id="options_1"><code>&lt;options&gt;</code><a class="headerlink" href="#options_1" title="Permanent link">#</a></h3>
2239 <p><span class="label label-info">Optional</span></p>
2240 <p>The options element can contain a comma-separated list of options of which at least one needs to be enabled for the option to be shown to the administrator.</p>
2241 <h3 id="supporti18n"><code>&lt;supporti18n&gt;</code><a class="headerlink" href="#supporti18n" title="Permanent link">#</a></h3>
2242 <p><span class="label label-info">Optional</span></p>
2243 <p>Specifies whether this option supports localized input.</p>
2244 <h3 id="requirei18n"><code>&lt;requirei18n&gt;</code><a class="headerlink" href="#requirei18n" title="Permanent link">#</a></h3>
2245 <p><span class="label label-info">Optional</span></p>
2246 <p>Specifies whether this option requires localized input (i.e. the administrator must specify a value for every installed language).</p>
2247 <h3 id="_1"><code>&lt;*&gt;</code><a class="headerlink" href="#_1" title="Permanent link">#</a></h3>
2248 <p><span class="label label-info">Optional</span></p>
2249 <p>Additional fields may be defined by specific types of options.
2250 Refer to the documentation of these for further explanation.</p>
2251 <h2 id="language-items">Language Items<a class="headerlink" href="#language-items" title="Permanent link">#</a></h2>
2252 <p>All relevant language items have to be put into the <code>wcf.acp.option</code> language item category.</p>
2253 <h3 id="categories">Categories<a class="headerlink" href="#categories" title="Permanent link">#</a></h3>
2254 <p>If you install a category named <code>example.sub</code>, you have to provide the language item <code>wcf.acp.option.category.example.sub</code>, which is used when displaying the options.
2255 If you want to provide an optional description of the category, you have to provide the language item <code>wcf.acp.option.category.example.sub.description</code>.
2256 Descriptions are only relevant for categories whose parent has a parent itself, i.e. categories on the third level.</p>
2257 <h3 id="options_2">Options<a class="headerlink" href="#options_2" title="Permanent link">#</a></h3>
2258 <p>If you install an option named <code>module_example</code>, you have to provide the language item <code>wcf.acp.option.module_example</code>, which is used as a label for setting the option value.
2259 If you want to provide an optional description of the option, you have to provide the language item <code>wcf.acp.option.module_example.description</code>.</p>
2260 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2261 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2262 <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/option.xsd&quot;</span><span class="nt">&gt;</span>
2263     <span class="nt">&lt;import&gt;</span>
2264         <span class="nt">&lt;categories&gt;</span>
2265             <span class="nt">&lt;category</span> <span class="na">name=</span><span class="s">&quot;example&quot;</span> <span class="nt">/&gt;</span>
2266             <span class="nt">&lt;category</span> <span class="na">name=</span><span class="s">&quot;example.sub&quot;</span><span class="nt">&gt;</span>
2267                 <span class="nt">&lt;parent&gt;</span>example<span class="nt">&lt;/parent&gt;</span>
2268                 <span class="nt">&lt;options&gt;</span>module_example<span class="nt">&lt;/options&gt;</span>
2269             <span class="nt">&lt;/category&gt;</span>
2270         <span class="nt">&lt;/categories&gt;</span>
2271
2272         <span class="nt">&lt;options&gt;</span>
2273             <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;module_example&quot;</span><span class="nt">&gt;</span>
2274                 <span class="nt">&lt;categoryname&gt;</span>module.community<span class="nt">&lt;/categoryname&gt;</span>
2275                 <span class="nt">&lt;optiontype&gt;</span>boolean<span class="nt">&lt;/optiontype&gt;</span>
2276                 <span class="nt">&lt;defaultvalue&gt;</span>1<span class="nt">&lt;/defaultvalue&gt;</span>
2277             <span class="nt">&lt;/option&gt;</span>
2278
2279             <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;example_integer&quot;</span><span class="nt">&gt;</span>
2280                 <span class="nt">&lt;categoryname&gt;</span>example.sub<span class="nt">&lt;/categoryname&gt;</span>
2281                 <span class="nt">&lt;optiontype&gt;</span>integer<span class="nt">&lt;/optiontype&gt;</span>
2282                 <span class="nt">&lt;defaultvalue&gt;</span>10<span class="nt">&lt;/defaultvalue&gt;</span>
2283                 <span class="nt">&lt;minvalue&gt;</span>5<span class="nt">&lt;/minvalue&gt;</span>
2284                 <span class="nt">&lt;maxvalue&gt;</span>40<span class="nt">&lt;/maxvalue&gt;</span>
2285             <span class="nt">&lt;/option&gt;</span>
2286
2287             <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;example_select&quot;</span><span class="nt">&gt;</span>
2288                 <span class="nt">&lt;categoryname&gt;</span>example.sub<span class="nt">&lt;/categoryname&gt;</span>
2289                 <span class="nt">&lt;optiontype&gt;</span>select<span class="nt">&lt;/optiontype&gt;</span>
2290                 <span class="nt">&lt;defaultvalue&gt;</span>DESC<span class="nt">&lt;/defaultvalue&gt;</span>
2291                 <span class="nt">&lt;selectoptions&gt;</span>ASC:wcf.global.sortOrder.ascending
2292 DESC:wcf.global.sortOrder.descending<span class="nt">&lt;/selectoptions&gt;</span>
2293             <span class="nt">&lt;/option&gt;</span>
2294         <span class="nt">&lt;/options&gt;</span>
2295     <span class="nt">&lt;/import&gt;</span>
2296
2297     <span class="nt">&lt;delete&gt;</span>
2298         <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;outdated_example&quot;</span> <span class="nt">/&gt;</span>
2299     <span class="nt">&lt;/delete&gt;</span>
2300 <span class="nt">&lt;/data&gt;</span>
2301 </code></pre></div>
2302
2303
2304
2305
2306 <hr>
2307 <div class="md-source-date">
2308   <small>
2309
2310       Last update: 2021-01-08
2311
2312   </small>
2313 </div>
2314
2315
2316
2317
2318
2319
2320
2321
2322             </article>
2323           </div>
2324         </div>
2325
2326       </main>
2327
2328
2329 <footer class="md-footer">
2330
2331     <nav class="md-footer__inner md-grid" aria-label="Footer">
2332
2333         <a href="../object-type-definition/" class="md-footer__link md-footer__link--prev" rel="prev">
2334           <div class="md-footer__button md-icon">
2335             <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>
2336           </div>
2337           <div class="md-footer__title">
2338             <div class="md-ellipsis">
2339               <span class="md-footer__direction">
2340                 Previous
2341               </span>
2342               objectTypeDefinition
2343             </div>
2344           </div>
2345         </a>
2346
2347
2348         <a href="../page/" class="md-footer__link md-footer__link--next" rel="next">
2349           <div class="md-footer__title">
2350             <div class="md-ellipsis">
2351               <span class="md-footer__direction">
2352                 Next
2353               </span>
2354               page
2355             </div>
2356           </div>
2357           <div class="md-footer__button md-icon">
2358             <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>
2359           </div>
2360         </a>
2361
2362     </nav>
2363
2364   <div class="md-footer-meta md-typeset">
2365     <div class="md-footer-meta__inner md-grid">
2366       <div class="md-footer-copyright">
2367
2368           <div class="md-footer-copyright__highlight">
2369             Copyright © 2020 WoltLab GmbH
2370           </div>
2371
2372         Made with
2373         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2374           Material for MkDocs
2375         </a>
2376
2377       </div>
2378       <div class="md-footer-copyright">
2379         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2380         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2381 </div>
2382     </div>
2383   </div>
2384 </footer>
2385
2386     </div>
2387     <div class="md-dialog" data-md-component="dialog">
2388       <div class="md-dialog__inner md-typeset"></div>
2389     </div>
2390     <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>
2391
2392
2393       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2394
2395
2396   </body>
2397 </html>