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
 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     <li class="md-nav__item">
 968       <a href="../acl-option/" class="md-nav__link">
 969         aclOption
 970       </a>
 971     </li>
 972
 973
 974
 975
 976
 977
 978
 979     <li class="md-nav__item">
 980       <a href="../acp-menu/" class="md-nav__link">
 981         acpMenu
 982       </a>
 983     </li>
 984
 985
 986
 987
 988
 989
 990
 991     <li class="md-nav__item">
 992       <a href="../acp-search-provider/" class="md-nav__link">
 993         acpSearchProvider
 994       </a>
 995     </li>
 996
 997
 998
 999
1000
1001
1002
1003     <li class="md-nav__item">
1004       <a href="../acp-template/" class="md-nav__link">
1005         acpTemplate
1006       </a>
1007     </li>
1008
1009
1010
1011
1012
1013
1014
1015     <li class="md-nav__item">
1016       <a href="../bbcode/" class="md-nav__link">
1017         bbcode
1018       </a>
1019     </li>
1020
1021
1022
1023
1024
1025
1026
1027     <li class="md-nav__item">
1028       <a href="../box/" class="md-nav__link">
1029         box
1030       </a>
1031     </li>
1032
1033
1034
1035
1036
1037
1038
1039     <li class="md-nav__item">
1040       <a href="../clipboard-action/" class="md-nav__link">
1041         clipboardAction
1042       </a>
1043     </li>
1044
1045
1046
1047
1048
1049
1050
1051     <li class="md-nav__item">
1052       <a href="../core-object/" class="md-nav__link">
1053         coreObject
1054       </a>
1055     </li>
1056
1057
1058
1059
1060
1061
1062
1063     <li class="md-nav__item">
1064       <a href="../cronjob/" class="md-nav__link">
1065         cronjob
1066       </a>
1067     </li>
1068
1069
1070
1071
1072
1073
1074
1075     <li class="md-nav__item">
1076       <a href="../database/" class="md-nav__link">
1077         database
1078       </a>
1079     </li>
1080
1081
1082
1083
1084
1085
1086
1087     <li class="md-nav__item">
1088       <a href="../event-listener/" class="md-nav__link">
1089         eventListener
1090       </a>
1091     </li>
1092
1093
1094
1095
1096
1097
1098
1099     <li class="md-nav__item">
1100       <a href="../file/" class="md-nav__link">
1101         file
1102       </a>
1103     </li>
1104
1105
1106
1107
1108
1109
1110
1111     <li class="md-nav__item">
1112       <a href="../language/" class="md-nav__link">
1113         language
1114       </a>
1115     </li>
1116
1117
1118
1119
1120
1121
1122
1123     <li class="md-nav__item">
1124       <a href="../media-provider/" class="md-nav__link">
1125         mediaProvider
1126       </a>
1127     </li>
1128
1129
1130
1131
1132
1133
1134
1135     <li class="md-nav__item">
1136       <a href="../menu/" class="md-nav__link">
1137         menu
1138       </a>
1139     </li>
1140
1141
1142
1143
1144
1145
1146
1147     <li class="md-nav__item">
1148       <a href="../menu-item/" class="md-nav__link">
1149         menuItem
1150       </a>
1151     </li>
1152
1153
1154
1155
1156
1157
1158
1159     <li class="md-nav__item">
1160       <a href="../object-type/" class="md-nav__link">
1161         objectType
1162       </a>
1163     </li>
1164
1165
1166
1167
1168
1169
1170
1171     <li class="md-nav__item">
1172       <a href="../object-type-definition/" class="md-nav__link">
1173         objectTypeDefinition
1174       </a>
1175     </li>
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185     <li class="md-nav__item md-nav__item--active">
1186
1187       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1188
1189
1190
1191
1192         <label class="md-nav__link md-nav__link--active" for="__toc">
1193           option
1194           <span class="md-nav__icon md-icon"></span>
1195         </label>
1196
1197       <a href="./" class="md-nav__link md-nav__link--active">
1198         option
1199       </a>
1200
1201
1202 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1203
1204
1205
1206
1207
1208     <label class="md-nav__title" for="__toc">
1209       <span class="md-nav__icon md-icon"></span>
1210       Table of contents
1211     </label>
1212     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1213
1214         <li class="md-nav__item">
1215   <a href="#category-components" class="md-nav__link">
1216     Category Components
1217   </a>
1218
1219     <nav class="md-nav" aria-label="Category Components">
1220       <ul class="md-nav__list">
1221
1222           <li class="md-nav__item">
1223   <a href="#parent" class="md-nav__link">
1224     &lt;parent&gt;
1225   </a>
1226
1227 </li>
1228
1229           <li class="md-nav__item">
1230   <a href="#showorder" class="md-nav__link">
1231     &lt;showorder&gt;
1232   </a>
1233
1234 </li>
1235
1236           <li class="md-nav__item">
1237   <a href="#options" class="md-nav__link">
1238     &lt;options&gt;
1239   </a>
1240
1241 </li>
1242
1243       </ul>
1244     </nav>
1245
1246 </li>
1247
1248         <li class="md-nav__item">
1249   <a href="#option-components" class="md-nav__link">
1250     Option Components
1251   </a>
1252
1253     <nav class="md-nav" aria-label="Option Components">
1254       <ul class="md-nav__list">
1255
1256           <li class="md-nav__item">
1257   <a href="#categoryname" class="md-nav__link">
1258     &lt;categoryname&gt;
1259   </a>
1260
1261 </li>
1262
1263           <li class="md-nav__item">
1264   <a href="#optiontype" class="md-nav__link">
1265     &lt;optiontype&gt;
1266   </a>
1267
1268 </li>
1269
1270           <li class="md-nav__item">
1271   <a href="#defaultvalue" class="md-nav__link">
1272     &lt;defaultvalue&gt;
1273   </a>
1274
1275 </li>
1276
1277           <li class="md-nav__item">
1278   <a href="#validationpattern" class="md-nav__link">
1279     &lt;validationpattern&gt;
1280   </a>
1281
1282 </li>
1283
1284           <li class="md-nav__item">
1285   <a href="#showorder_1" class="md-nav__link">
1286     &lt;showorder&gt;
1287   </a>
1288
1289 </li>
1290
1291           <li class="md-nav__item">
1292   <a href="#selectoptions" class="md-nav__link">
1293     &lt;selectoptions&gt;
1294   </a>
1295
1296 </li>
1297
1298           <li class="md-nav__item">
1299   <a href="#enableoptions" class="md-nav__link">
1300     &lt;enableoptions&gt;
1301   </a>
1302
1303 </li>
1304
1305           <li class="md-nav__item">
1306   <a href="#hidden" class="md-nav__link">
1307     &lt;hidden&gt;
1308   </a>
1309
1310 </li>
1311
1312           <li class="md-nav__item">
1313   <a href="#options_1" class="md-nav__link">
1314     &lt;options&gt;
1315   </a>
1316
1317 </li>
1318
1319           <li class="md-nav__item">
1320   <a href="#supporti18n" class="md-nav__link">
1321     &lt;supporti18n&gt;
1322   </a>
1323
1324 </li>
1325
1326           <li class="md-nav__item">
1327   <a href="#requirei18n" class="md-nav__link">
1328     &lt;requirei18n&gt;
1329   </a>
1330
1331 </li>
1332
1333           <li class="md-nav__item">
1334   <a href="#_1" class="md-nav__link">
1335     &lt;*&gt;
1336   </a>
1337
1338 </li>
1339
1340       </ul>
1341     </nav>
1342
1343 </li>
1344
1345         <li class="md-nav__item">
1346   <a href="#language-items" class="md-nav__link">
1347     Language Items
1348   </a>
1349
1350     <nav class="md-nav" aria-label="Language Items">
1351       <ul class="md-nav__list">
1352
1353           <li class="md-nav__item">
1354   <a href="#categories" class="md-nav__link">
1355     Categories
1356   </a>
1357
1358 </li>
1359
1360           <li class="md-nav__item">
1361   <a href="#options_2" class="md-nav__link">
1362     Options
1363   </a>
1364
1365 </li>
1366
1367       </ul>
1368     </nav>
1369
1370 </li>
1371
1372         <li class="md-nav__item">
1373   <a href="#example" class="md-nav__link">
1374     Example
1375   </a>
1376
1377 </li>
1378
1379     </ul>
1380
1381 </nav>
1382
1383     </li>
1384
1385
1386
1387
1388
1389
1390
1391     <li class="md-nav__item">
1392       <a href="../page/" class="md-nav__link">
1393         page
1394       </a>
1395     </li>
1396
1397
1398
1399
1400
1401
1402
1403     <li class="md-nav__item">
1404       <a href="../pip/" class="md-nav__link">
1405         pip
1406       </a>
1407     </li>
1408
1409
1410
1411
1412
1413
1414
1415     <li class="md-nav__item">
1416       <a href="../script/" class="md-nav__link">
1417         script
1418       </a>
1419     </li>
1420
1421
1422
1423
1424
1425
1426
1427     <li class="md-nav__item">
1428       <a href="../smiley/" class="md-nav__link">
1429         smiley
1430       </a>
1431     </li>
1432
1433
1434
1435
1436
1437
1438
1439     <li class="md-nav__item">
1440       <a href="../sql/" class="md-nav__link">
1441         sql
1442       </a>
1443     </li>
1444
1445
1446
1447
1448
1449
1450
1451     <li class="md-nav__item">
1452       <a href="../style/" class="md-nav__link">
1453         style
1454       </a>
1455     </li>
1456
1457
1458
1459
1460
1461
1462
1463     <li class="md-nav__item">
1464       <a href="../template/" class="md-nav__link">
1465         template
1466       </a>
1467     </li>
1468
1469
1470
1471
1472
1473
1474
1475     <li class="md-nav__item">
1476       <a href="../template-listener/" class="md-nav__link">
1477         templateListener
1478       </a>
1479     </li>
1480
1481
1482
1483
1484
1485
1486
1487     <li class="md-nav__item">
1488       <a href="../user-group-option/" class="md-nav__link">
1489         userGroupOption
1490       </a>
1491     </li>
1492
1493
1494
1495
1496
1497
1498
1499     <li class="md-nav__item">
1500       <a href="../user-menu/" class="md-nav__link">
1501         userMenu
1502       </a>
1503     </li>
1504
1505
1506
1507
1508
1509
1510
1511     <li class="md-nav__item">
1512       <a href="../user-notification-event/" class="md-nav__link">
1513         userNotificationEvent
1514       </a>
1515     </li>
1516
1517
1518
1519
1520
1521
1522
1523     <li class="md-nav__item">
1524       <a href="../user-option/" class="md-nav__link">
1525         userOption
1526       </a>
1527     </li>
1528
1529
1530
1531
1532
1533
1534
1535     <li class="md-nav__item">
1536       <a href="../user-profile-menu/" class="md-nav__link">
1537         userProfileMenu
1538       </a>
1539     </li>
1540
1541
1542
1543         </ul>
1544       </nav>
1545     </li>
1546
1547
1548
1549
1550
1551
1552
1553     <li class="md-nav__item">
1554       <a href="../../database-php-api/" class="md-nav__link">
1555         Database PHP API
1556       </a>
1557     </li>
1558
1559
1560
1561         </ul>
1562       </nav>
1563     </li>
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575     <li class="md-nav__item md-nav__item--nested">
1576
1577
1578         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1579
1580       <label class="md-nav__link" for="__nav_6">
1581         Migration
1582         <span class="md-nav__icon md-icon"></span>
1583       </label>
1584       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1585         <label class="md-nav__title" for="__nav_6">
1586           <span class="md-nav__icon md-icon"></span>
1587           Migration
1588         </label>
1589         <ul class="md-nav__list" data-md-scrollfix>
1590
1591
1592
1593
1594
1595
1596     <li class="md-nav__item md-nav__item--nested">
1597
1598
1599         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1600
1601       <label class="md-nav__link" for="__nav_6_1">
1602         Migrating from WSC 5.3
1603         <span class="md-nav__icon md-icon"></span>
1604       </label>
1605       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1606         <label class="md-nav__title" for="__nav_6_1">
1607           <span class="md-nav__icon md-icon"></span>
1608           Migrating from WSC 5.3
1609         </label>
1610         <ul class="md-nav__list" data-md-scrollfix>
1611
1612
1613
1614
1615
1616     <li class="md-nav__item">
1617       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1618         PHP API
1619       </a>
1620     </li>
1621
1622
1623
1624
1625
1626
1627
1628     <li class="md-nav__item">
1629       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1630         Session Handling and Authentication
1631       </a>
1632     </li>
1633
1634
1635
1636
1637
1638
1639
1640     <li class="md-nav__item">
1641       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1642         TypeScript and JavaScript
1643       </a>
1644     </li>
1645
1646
1647
1648
1649
1650
1651
1652     <li class="md-nav__item">
1653       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1654         Templates
1655       </a>
1656     </li>
1657
1658
1659
1660
1661
1662
1663
1664     <li class="md-nav__item">
1665       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1666         Third Party Libraries
1667       </a>
1668     </li>
1669
1670
1671
1672         </ul>
1673       </nav>
1674     </li>
1675
1676
1677
1678
1679
1680
1681
1682
1683     <li class="md-nav__item md-nav__item--nested">
1684
1685
1686         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1687
1688       <label class="md-nav__link" for="__nav_6_2">
1689         Migrating from WSC 5.2
1690         <span class="md-nav__icon md-icon"></span>
1691       </label>
1692       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1693         <label class="md-nav__title" for="__nav_6_2">
1694           <span class="md-nav__icon md-icon"></span>
1695           Migrating from WSC 5.2
1696         </label>
1697         <ul class="md-nav__list" data-md-scrollfix>
1698
1699
1700
1701
1702
1703     <li class="md-nav__item">
1704       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1705         PHP API
1706       </a>
1707     </li>
1708
1709
1710
1711
1712
1713
1714
1715     <li class="md-nav__item">
1716       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1717         Templates and Languages
1718       </a>
1719     </li>
1720
1721
1722
1723
1724
1725
1726
1727     <li class="md-nav__item">
1728       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1729         Third Party Libraries
1730       </a>
1731     </li>
1732
1733
1734
1735         </ul>
1736       </nav>
1737     </li>
1738
1739
1740
1741
1742
1743
1744
1745
1746     <li class="md-nav__item md-nav__item--nested">
1747
1748
1749         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1750
1751       <label class="md-nav__link" for="__nav_6_3">
1752         Migrating from WSC 3.1
1753         <span class="md-nav__icon md-icon"></span>
1754       </label>
1755       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1756         <label class="md-nav__title" for="__nav_6_3">
1757           <span class="md-nav__icon md-icon"></span>
1758           Migrating from WSC 3.1
1759         </label>
1760         <ul class="md-nav__list" data-md-scrollfix>
1761
1762
1763
1764
1765
1766     <li class="md-nav__item">
1767       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1768         PHP API
1769       </a>
1770     </li>
1771
1772
1773
1774         </ul>
1775       </nav>
1776     </li>
1777
1778
1779
1780
1781
1782
1783
1784
1785     <li class="md-nav__item md-nav__item--nested">
1786
1787
1788         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1789
1790       <label class="md-nav__link" for="__nav_6_4">
1791         Migrating from WSC 3.0
1792         <span class="md-nav__icon md-icon"></span>
1793       </label>
1794       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1795         <label class="md-nav__title" for="__nav_6_4">
1796           <span class="md-nav__icon md-icon"></span>
1797           Migrating from WSC 3.0
1798         </label>
1799         <ul class="md-nav__list" data-md-scrollfix>
1800
1801
1802
1803
1804
1805     <li class="md-nav__item">
1806       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1807         PHP API
1808       </a>
1809     </li>
1810
1811
1812
1813
1814
1815
1816
1817     <li class="md-nav__item">
1818       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1819         JavaScript API
1820       </a>
1821     </li>
1822
1823
1824
1825
1826
1827
1828
1829     <li class="md-nav__item">
1830       <a href="../../../migration/wsc30/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/wsc30/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/wsc30/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
1868
1869
1870
1871
1872     <li class="md-nav__item md-nav__item--nested">
1873
1874
1875         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1876
1877       <label class="md-nav__link" for="__nav_6_5">
1878         Migrating from WCF 2.1
1879         <span class="md-nav__icon md-icon"></span>
1880       </label>
1881       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1882         <label class="md-nav__title" for="__nav_6_5">
1883           <span class="md-nav__icon md-icon"></span>
1884           Migrating from WCF 2.1
1885         </label>
1886         <ul class="md-nav__list" data-md-scrollfix>
1887
1888
1889
1890
1891
1892     <li class="md-nav__item">
1893       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1894         PHP API
1895       </a>
1896     </li>
1897
1898
1899
1900
1901
1902
1903
1904     <li class="md-nav__item">
1905       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1906         Templates
1907       </a>
1908     </li>
1909
1910
1911
1912
1913
1914
1915
1916     <li class="md-nav__item">
1917       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1918         CSS
1919       </a>
1920     </li>
1921
1922
1923
1924
1925
1926
1927
1928     <li class="md-nav__item">
1929       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1930         Package Components
1931       </a>
1932     </li>
1933
1934
1935
1936         </ul>
1937       </nav>
1938     </li>
1939
1940
1941
1942         </ul>
1943       </nav>
1944     </li>
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956     <li class="md-nav__item md-nav__item--nested">
1957
1958
1959         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1960
1961       <label class="md-nav__link" for="__nav_7">
1962         Tutorials
1963         <span class="md-nav__icon md-icon"></span>
1964       </label>
1965       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1966         <label class="md-nav__title" for="__nav_7">
1967           <span class="md-nav__icon md-icon"></span>
1968           Tutorials
1969         </label>
1970         <ul class="md-nav__list" data-md-scrollfix>
1971
1972
1973
1974
1975
1976
1977     <li class="md-nav__item md-nav__item--nested">
1978
1979
1980         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1981
1982       <label class="md-nav__link" for="__nav_7_1">
1983         Tutorial Series
1984         <span class="md-nav__icon md-icon"></span>
1985       </label>
1986       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1987         <label class="md-nav__title" for="__nav_7_1">
1988           <span class="md-nav__icon md-icon"></span>
1989           Tutorial Series
1990         </label>
1991         <ul class="md-nav__list" data-md-scrollfix>
1992
1993
1994
1995
1996
1997     <li class="md-nav__item">
1998       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1999         Overview
2000       </a>
2001     </li>
2002
2003
2004
2005
2006
2007
2008
2009     <li class="md-nav__item">
2010       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2011         Part 1
2012       </a>
2013     </li>
2014
2015
2016
2017
2018
2019
2020
2021     <li class="md-nav__item">
2022       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2023         Part 2
2024       </a>
2025     </li>
2026
2027
2028
2029
2030
2031
2032
2033     <li class="md-nav__item">
2034       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2035         Part 3
2036       </a>
2037     </li>
2038
2039
2040
2041         </ul>
2042       </nav>
2043     </li>
2044
2045
2046
2047         </ul>
2048       </nav>
2049     </li>
2050
2051
2052
2053   </ul>
2054 </nav>
2055                   </div>
2056                 </div>
2057               </div>
2058
2059
2060
2061               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2062                 <div class="md-sidebar__scrollwrap">
2063                   <div class="md-sidebar__inner">
2064
2065 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2066
2067
2068
2069
2070
2071     <label class="md-nav__title" for="__toc">
2072       <span class="md-nav__icon md-icon"></span>
2073       Table of contents
2074     </label>
2075     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2076
2077         <li class="md-nav__item">
2078   <a href="#category-components" class="md-nav__link">
2079     Category Components
2080   </a>
2081
2082     <nav class="md-nav" aria-label="Category Components">
2083       <ul class="md-nav__list">
2084
2085           <li class="md-nav__item">
2086   <a href="#parent" class="md-nav__link">
2087     &lt;parent&gt;
2088   </a>
2089
2090 </li>
2091
2092           <li class="md-nav__item">
2093   <a href="#showorder" class="md-nav__link">
2094     &lt;showorder&gt;
2095   </a>
2096
2097 </li>
2098
2099           <li class="md-nav__item">
2100   <a href="#options" class="md-nav__link">
2101     &lt;options&gt;
2102   </a>
2103
2104 </li>
2105
2106       </ul>
2107     </nav>
2108
2109 </li>
2110
2111         <li class="md-nav__item">
2112   <a href="#option-components" class="md-nav__link">
2113     Option Components
2114   </a>
2115
2116     <nav class="md-nav" aria-label="Option Components">
2117       <ul class="md-nav__list">
2118
2119           <li class="md-nav__item">
2120   <a href="#categoryname" class="md-nav__link">
2121     &lt;categoryname&gt;
2122   </a>
2123
2124 </li>
2125
2126           <li class="md-nav__item">
2127   <a href="#optiontype" class="md-nav__link">
2128     &lt;optiontype&gt;
2129   </a>
2130
2131 </li>
2132
2133           <li class="md-nav__item">
2134   <a href="#defaultvalue" class="md-nav__link">
2135     &lt;defaultvalue&gt;
2136   </a>
2137
2138 </li>
2139
2140           <li class="md-nav__item">
2141   <a href="#validationpattern" class="md-nav__link">
2142     &lt;validationpattern&gt;
2143   </a>
2144
2145 </li>
2146
2147           <li class="md-nav__item">
2148   <a href="#showorder_1" class="md-nav__link">
2149     &lt;showorder&gt;
2150   </a>
2151
2152 </li>
2153
2154           <li class="md-nav__item">
2155   <a href="#selectoptions" class="md-nav__link">
2156     &lt;selectoptions&gt;
2157   </a>
2158
2159 </li>
2160
2161           <li class="md-nav__item">
2162   <a href="#enableoptions" class="md-nav__link">
2163     &lt;enableoptions&gt;
2164   </a>
2165
2166 </li>
2167
2168           <li class="md-nav__item">
2169   <a href="#hidden" class="md-nav__link">
2170     &lt;hidden&gt;
2171   </a>
2172
2173 </li>
2174
2175           <li class="md-nav__item">
2176   <a href="#options_1" class="md-nav__link">
2177     &lt;options&gt;
2178   </a>
2179
2180 </li>
2181
2182           <li class="md-nav__item">
2183   <a href="#supporti18n" class="md-nav__link">
2184     &lt;supporti18n&gt;
2185   </a>
2186
2187 </li>
2188
2189           <li class="md-nav__item">
2190   <a href="#requirei18n" class="md-nav__link">
2191     &lt;requirei18n&gt;
2192   </a>
2193
2194 </li>
2195
2196           <li class="md-nav__item">
2197   <a href="#_1" class="md-nav__link">
2198     &lt;*&gt;
2199   </a>
2200
2201 </li>
2202
2203       </ul>
2204     </nav>
2205
2206 </li>
2207
2208         <li class="md-nav__item">
2209   <a href="#language-items" class="md-nav__link">
2210     Language Items
2211   </a>
2212
2213     <nav class="md-nav" aria-label="Language Items">
2214       <ul class="md-nav__list">
2215
2216           <li class="md-nav__item">
2217   <a href="#categories" class="md-nav__link">
2218     Categories
2219   </a>
2220
2221 </li>
2222
2223           <li class="md-nav__item">
2224   <a href="#options_2" class="md-nav__link">
2225     Options
2226   </a>
2227
2228 </li>
2229
2230       </ul>
2231     </nav>
2232
2233 </li>
2234
2235         <li class="md-nav__item">
2236   <a href="#example" class="md-nav__link">
2237     Example
2238   </a>
2239
2240 </li>
2241
2242     </ul>
2243
2244 </nav>
2245                   </div>
2246                 </div>
2247               </div>
2248
2249
2250           <div class="md-content" data-md-component="content">
2251             <article class="md-content__inner md-typeset">
2252
2253
2254                   <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">
2255                     <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>
2256                   </a>
2257
2258
2259                 <h1 id="option-package-installation-plugin">Option Package Installation Plugin<a class="headerlink" href="#option-package-installation-plugin" title="Permanent link">#</a></h1>
2260 <p>Registers new options.
2261 Options allow the administrator to configure the behaviour of installed packages.
2262 The specified values are exposed as PHP constants.</p>
2263 <h2 id="category-components">Category Components<a class="headerlink" href="#category-components" title="Permanent link">#</a></h2>
2264 <p>Each category is described as an <code>&lt;category&gt;</code> element with the mandatory attribute <code>name</code>.</p>
2265 <h3 id="parent"><code>&lt;parent&gt;</code><a class="headerlink" href="#parent" title="Permanent link">#</a></h3>
2266 <p><span class="label label-info">Optional</span></p>
2267 <p>The category’s parent category.</p>
2268 <h3 id="showorder"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder" title="Permanent link">#</a></h3>
2269 <p><span class="label label-info">Optional</span></p>
2270 <p>Specifies the order of this option within the parent category.</p>
2271 <h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2272 <p><span class="label label-info">Optional</span></p>
2273 <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>
2274 <h2 id="option-components">Option Components<a class="headerlink" href="#option-components" title="Permanent link">#</a></h2>
2275 <p>Each option is described as an <code>&lt;option&gt;</code> element with the mandatory attribute <code>name</code>.
2276 The <code>name</code> is transformed into a PHP constant name by uppercasing it.</p>
2277 <h3 id="categoryname"><code>&lt;categoryname&gt;</code><a class="headerlink" href="#categoryname" title="Permanent link">#</a></h3>
2278 <p>The option’s category.</p>
2279 <h3 id="optiontype"><code>&lt;optiontype&gt;</code><a class="headerlink" href="#optiontype" title="Permanent link">#</a></h3>
2280 <p>The type of input to be used for this option.
2281 Valid types are defined by the <code>wcf\system\option\*OptionType</code> classes.</p>
2282 <h3 id="defaultvalue"><code>&lt;defaultvalue&gt;</code><a class="headerlink" href="#defaultvalue" title="Permanent link">#</a></h3>
2283 <p>The value that is set after installation of a package.
2284 Valid values are defined by the <code>optiontype</code>.</p>
2285 <h3 id="validationpattern"><code>&lt;validationpattern&gt;</code><a class="headerlink" href="#validationpattern" title="Permanent link">#</a></h3>
2286 <p><span class="label label-info">Optional</span></p>
2287 <p>Defines a regular expression that is used to validate the value of a free form option (such as <code>text</code>).</p>
2288 <h3 id="showorder_1"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder_1" title="Permanent link">#</a></h3>
2289 <p><span class="label label-info">Optional</span></p>
2290 <p>Specifies the order of this option within the category.</p>
2291 <h3 id="selectoptions"><code>&lt;selectoptions&gt;</code><a class="headerlink" href="#selectoptions" title="Permanent link">#</a></h3>
2292 <p><span class="label label-info">Optional</span></p>
2293 <div class="admonition warning">
2294 <p class="admonition-title">Defined only for <code>select</code>, <code>multiSelect</code> and <code>radioButton</code> types.</p>
2295 </div>
2296 <p>Specifies a newline-separated list of selectable values.
2297 Each line consists of an internal handle, followed by a colon (<code>:</code>, U+003A), followed by a language item.
2298 The language item is shown to the administrator, the internal handle is what is saved and exposed to the code.</p>
2299 <h3 id="enableoptions"><code>&lt;enableoptions&gt;</code><a class="headerlink" href="#enableoptions" title="Permanent link">#</a></h3>
2300 <p><span class="label label-info">Optional</span></p>
2301 <div class="admonition warning">
2302 <p class="admonition-title">Defined only for <code>boolean</code>, <code>select</code> and <code>radioButton</code> types.</p>
2303 </div>
2304 <p>Specifies a comma-separated list of options which should be visually enabled when this option is enabled.
2305 A leading exclamation mark (<code>!</code>, U+0021) will disable the specified option when this option is enabled.
2306 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>
2307 <p>This setting is a visual helper for the administrator only.
2308 It does not have an effect on the server side processing of the option.</p>
2309 <h3 id="hidden"><code>&lt;hidden&gt;</code><a class="headerlink" href="#hidden" title="Permanent link">#</a></h3>
2310 <p><span class="label label-info">Optional</span></p>
2311 <p>If <code>hidden</code> is set to <code>1</code> the option will not be shown to the administrator.
2312 It still can be modified programmatically.</p>
2313 <h3 id="options_1"><code>&lt;options&gt;</code><a class="headerlink" href="#options_1" title="Permanent link">#</a></h3>
2314 <p><span class="label label-info">Optional</span></p>
2315 <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>
2316 <h3 id="supporti18n"><code>&lt;supporti18n&gt;</code><a class="headerlink" href="#supporti18n" title="Permanent link">#</a></h3>
2317 <p><span class="label label-info">Optional</span></p>
2318 <p>Specifies whether this option supports localized input.</p>
2319 <h3 id="requirei18n"><code>&lt;requirei18n&gt;</code><a class="headerlink" href="#requirei18n" title="Permanent link">#</a></h3>
2320 <p><span class="label label-info">Optional</span></p>
2321 <p>Specifies whether this option requires localized input (i.e. the administrator must specify a value for every installed language).</p>
2322 <h3 id="_1"><code>&lt;*&gt;</code><a class="headerlink" href="#_1" title="Permanent link">#</a></h3>
2323 <p><span class="label label-info">Optional</span></p>
2324 <p>Additional fields may be defined by specific types of options.
2325 Refer to the documentation of these for further explanation.</p>
2326 <h2 id="language-items">Language Items<a class="headerlink" href="#language-items" title="Permanent link">#</a></h2>
2327 <p>All relevant language items have to be put into the <code>wcf.acp.option</code> language item category.</p>
2328 <h3 id="categories">Categories<a class="headerlink" href="#categories" title="Permanent link">#</a></h3>
2329 <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.
2330 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>.
2331 Descriptions are only relevant for categories whose parent has a parent itself, i.e. categories on the third level.</p>
2332 <h3 id="options_2">Options<a class="headerlink" href="#options_2" title="Permanent link">#</a></h3>
2333 <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.
2334 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>
2335 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2336 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2337 <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>
2338     <span class="nt">&lt;import&gt;</span>
2339         <span class="nt">&lt;categories&gt;</span>
2340             <span class="nt">&lt;category</span> <span class="na">name=</span><span class="s">&quot;example&quot;</span> <span class="nt">/&gt;</span>
2341             <span class="nt">&lt;category</span> <span class="na">name=</span><span class="s">&quot;example.sub&quot;</span><span class="nt">&gt;</span>
2342                 <span class="nt">&lt;parent&gt;</span>example<span class="nt">&lt;/parent&gt;</span>
2343                 <span class="nt">&lt;options&gt;</span>module_example<span class="nt">&lt;/options&gt;</span>
2344             <span class="nt">&lt;/category&gt;</span>
2345         <span class="nt">&lt;/categories&gt;</span>
2346
2347         <span class="nt">&lt;options&gt;</span>
2348             <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;module_example&quot;</span><span class="nt">&gt;</span>
2349                 <span class="nt">&lt;categoryname&gt;</span>module.community<span class="nt">&lt;/categoryname&gt;</span>
2350                 <span class="nt">&lt;optiontype&gt;</span>boolean<span class="nt">&lt;/optiontype&gt;</span>
2351                 <span class="nt">&lt;defaultvalue&gt;</span>1<span class="nt">&lt;/defaultvalue&gt;</span>
2352             <span class="nt">&lt;/option&gt;</span>
2353
2354             <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;example_integer&quot;</span><span class="nt">&gt;</span>
2355                 <span class="nt">&lt;categoryname&gt;</span>example.sub<span class="nt">&lt;/categoryname&gt;</span>
2356                 <span class="nt">&lt;optiontype&gt;</span>integer<span class="nt">&lt;/optiontype&gt;</span>
2357                 <span class="nt">&lt;defaultvalue&gt;</span>10<span class="nt">&lt;/defaultvalue&gt;</span>
2358                 <span class="nt">&lt;minvalue&gt;</span>5<span class="nt">&lt;/minvalue&gt;</span>
2359                 <span class="nt">&lt;maxvalue&gt;</span>40<span class="nt">&lt;/maxvalue&gt;</span>
2360             <span class="nt">&lt;/option&gt;</span>
2361
2362             <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;example_select&quot;</span><span class="nt">&gt;</span>
2363                 <span class="nt">&lt;categoryname&gt;</span>example.sub<span class="nt">&lt;/categoryname&gt;</span>
2364                 <span class="nt">&lt;optiontype&gt;</span>select<span class="nt">&lt;/optiontype&gt;</span>
2365                 <span class="nt">&lt;defaultvalue&gt;</span>DESC<span class="nt">&lt;/defaultvalue&gt;</span>
2366                 <span class="nt">&lt;selectoptions&gt;</span>ASC:wcf.global.sortOrder.ascending
2367 DESC:wcf.global.sortOrder.descending<span class="nt">&lt;/selectoptions&gt;</span>
2368             <span class="nt">&lt;/option&gt;</span>
2369         <span class="nt">&lt;/options&gt;</span>
2370     <span class="nt">&lt;/import&gt;</span>
2371
2372     <span class="nt">&lt;delete&gt;</span>
2373         <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;outdated_example&quot;</span> <span class="nt">/&gt;</span>
2374     <span class="nt">&lt;/delete&gt;</span>
2375 <span class="nt">&lt;/data&gt;</span>
2376 </code></pre></div>
2377
2378
2379
2380
2381 <hr>
2382 <div class="md-source-date">
2383   <small>
2384
2385       Last update: 2021-01-08
2386
2387   </small>
2388 </div>
2389
2390
2391
2392
2393
2394
2395
2396
2397             </article>
2398           </div>
2399         </div>
2400
2401       </main>
2402
2403
2404 <footer class="md-footer">
2405
2406     <nav class="md-footer__inner md-grid" aria-label="Footer">
2407
2408         <a href="../object-type-definition/" class="md-footer__link md-footer__link--prev" rel="prev">
2409           <div class="md-footer__button md-icon">
2410             <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>
2411           </div>
2412           <div class="md-footer__title">
2413             <div class="md-ellipsis">
2414               <span class="md-footer__direction">
2415                 Previous
2416               </span>
2417               objectTypeDefinition
2418             </div>
2419           </div>
2420         </a>
2421
2422
2423         <a href="../page/" class="md-footer__link md-footer__link--next" rel="next">
2424           <div class="md-footer__title">
2425             <div class="md-ellipsis">
2426               <span class="md-footer__direction">
2427                 Next
2428               </span>
2429               page
2430             </div>
2431           </div>
2432           <div class="md-footer__button md-icon">
2433             <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>
2434           </div>
2435         </a>
2436
2437     </nav>
2438
2439   <div class="md-footer-meta md-typeset">
2440     <div class="md-footer-meta__inner md-grid">
2441       <div class="md-footer-copyright">
2442
2443           <div class="md-footer-copyright__highlight">
2444             Copyright © 2020 WoltLab GmbH
2445           </div>
2446
2447         Made with
2448         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2449           Material for MkDocs
2450         </a>
2451
2452       </div>
2453       <div class="md-footer-copyright">
2454         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2455         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2456 </div>
2457     </div>
2458   </div>
2459 </footer>
2460
2461     </div>
2462     <div class="md-dialog" data-md-component="dialog">
2463       <div class="md-dialog__inner md-typeset"></div>
2464     </div>
2465     <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>
2466
2467
2468       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2469
2470
2471   </body>
2472 </html>