5.4/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="canonical" href="https://docs.woltlab.com/5.4/package/pip/option/">
  13
  14       <link rel="icon" href="../../../assets/default.favicon.ico">
  15       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.2">
  16
  17
  18
  19         <title>option - WoltLab Suite Documentation</title>
  20
  21
  22
  23       <link rel="stylesheet" href="../../../assets/stylesheets/main.6f955dcd.min.css">
  24
  25
  26         <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css">
  27
  28
  29
  30           <meta name="theme-color" content="#009485">
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  41
  42
  43
  44
  45
  46   </head>
  47
  48
  49
  50
  51
  52
  53
  54     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  55
  56
  57     <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  58
  59     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  60     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  61     <label class="md-overlay" for="__drawer"></label>
  62     <div data-md-component="skip">
  63
  64
  65         <a href="#option-package-installation-plugin" class="md-skip">
  66           Skip to content
  67         </a>
  68
  69     </div>
  70     <div data-md-component="announce">
  71
  72         <aside class="md-announce">
  73           <div class="md-announce__inner md-grid md-typeset">
  74
  75     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  76
  77           </div>
  78         </aside>
  79
  80     </div>
  81
  82       <header class="md-header" data-md-component="header">
  83   <nav class="md-header__inner md-grid" aria-label="Header">
  84     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  85
  86   <img src="../../../assets/logo.png" alt="logo">
  87
  88     </a>
  89     <label class="md-header__button md-icon" for="__drawer">
  90       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  91     </label>
  92     <div class="md-header__title" data-md-component="header-title">
  93       <div class="md-header__ellipsis">
  94         <div class="md-header__topic">
  95           <span class="md-ellipsis">
  96             WoltLab Suite Documentation
  97           </span>
  98         </div>
  99         <div class="md-header__topic" data-md-component="header-topic">
 100           <span class="md-ellipsis">
 101
 102               option
 103
 104           </span>
 105         </div>
 106       </div>
 107     </div>
 108
 109
 110
 111       <label class="md-header__button md-icon" for="__search">
 112         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 113       </label>
 114
 115 <div class="md-search" data-md-component="search" role="dialog">
 116   <label class="md-search__overlay" for="__search"></label>
 117   <div class="md-search__inner" role="search">
 118     <form class="md-search__form" name="search">
 119       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
 120       <label class="md-search__icon md-icon" for="__search">
 121         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 122         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
 123       </label>
 124       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 125         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
 126       </button>
 127     </form>
 128     <div class="md-search__output">
 129       <div class="md-search__scrollwrap" data-md-scrollfix>
 130         <div class="md-search-result" data-md-component="search-result">
 131           <div class="md-search-result__meta">
 132             Initializing search
 133           </div>
 134           <ol class="md-search-result__list"></ol>
 135         </div>
 136       </div>
 137     </div>
 138   </div>
 139 </div>
 140
 141
 142       <div class="md-header__source">
 143
 144 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 145   <div class="md-source__icon md-icon">
 146
 147     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 148   </div>
 149   <div class="md-source__repository">
 150     GitHub
 151   </div>
 152 </a>
 153       </div>
 154
 155   </nav>
 156 </header>
 157
 158     <div class="md-container" data-md-component="container">
 159
 160
 161
 162
 163       <main class="md-main" data-md-component="main">
 164         <div class="md-main__inner md-grid">
 165
 166
 167
 168               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 169                 <div class="md-sidebar__scrollwrap">
 170                   <div class="md-sidebar__inner">
 171
 172
 173
 174 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 175   <label class="md-nav__title" for="__drawer">
 176     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 177
 178   <img src="../../../assets/logo.png" alt="logo">
 179
 180     </a>
 181     WoltLab Suite Documentation
 182   </label>
 183
 184     <div class="md-nav__source">
 185
 186 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 187   <div class="md-source__icon md-icon">
 188
 189     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 190   </div>
 191   <div class="md-source__repository">
 192     GitHub
 193   </div>
 194 </a>
 195     </div>
 196
 197   <ul class="md-nav__list" data-md-scrollfix>
 198
 199
 200
 201
 202
 203
 204
 205
 206     <li class="md-nav__item">
 207       <a href="../../../getting-started/" class="md-nav__link">
 208         Getting Started
 209       </a>
 210     </li>
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222     <li class="md-nav__item md-nav__item--nested">
 223
 224
 225         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 226
 227       <label class="md-nav__link" for="__nav_2">
 228         PHP API
 229         <span class="md-nav__icon md-icon"></span>
 230       </label>
 231       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 232         <label class="md-nav__title" for="__nav_2">
 233           <span class="md-nav__icon md-icon"></span>
 234           PHP API
 235         </label>
 236         <ul class="md-nav__list" data-md-scrollfix>
 237
 238
 239
 240
 241
 242     <li class="md-nav__item">
 243       <a href="../../../php/pages/" class="md-nav__link">
 244         Pages
 245       </a>
 246     </li>
 247
 248
 249
 250
 251
 252
 253
 254     <li class="md-nav__item">
 255       <a href="../../../php/database-objects/" class="md-nav__link">
 256         Database Objects
 257       </a>
 258     </li>
 259
 260
 261
 262
 263
 264
 265
 266     <li class="md-nav__item">
 267       <a href="../../../php/database-access/" class="md-nav__link">
 268         Database Access
 269       </a>
 270     </li>
 271
 272
 273
 274
 275
 276
 277
 278     <li class="md-nav__item">
 279       <a href="../../../php/exceptions/" class="md-nav__link">
 280         Exceptions
 281       </a>
 282     </li>
 283
 284
 285
 286
 287
 288
 289
 290
 291     <li class="md-nav__item md-nav__item--nested">
 292
 293
 294         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 295
 296       <label class="md-nav__link" for="__nav_2_5">
 297         API
 298         <span class="md-nav__icon md-icon"></span>
 299       </label>
 300       <nav class="md-nav" aria-label="API" data-md-level="2">
 301         <label class="md-nav__title" for="__nav_2_5">
 302           <span class="md-nav__icon md-icon"></span>
 303           API
 304         </label>
 305         <ul class="md-nav__list" data-md-scrollfix>
 306
 307
 308
 309
 310
 311
 312     <li class="md-nav__item md-nav__item--nested">
 313
 314
 315         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 316
 317       <label class="md-nav__link" for="__nav_2_5_1">
 318         Caches
 319         <span class="md-nav__icon md-icon"></span>
 320       </label>
 321       <nav class="md-nav" aria-label="Caches" data-md-level="3">
 322         <label class="md-nav__title" for="__nav_2_5_1">
 323           <span class="md-nav__icon md-icon"></span>
 324           Caches
 325         </label>
 326         <ul class="md-nav__list" data-md-scrollfix>
 327
 328
 329
 330
 331
 332     <li class="md-nav__item">
 333       <a href="../../../php/api/caches/" class="md-nav__link">
 334         Overview
 335       </a>
 336     </li>
 337
 338
 339
 340
 341
 342
 343
 344     <li class="md-nav__item">
 345       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 346         Persistent Caches
 347       </a>
 348     </li>
 349
 350
 351
 352
 353
 354
 355
 356     <li class="md-nav__item">
 357       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 358         Runtime Caches
 359       </a>
 360     </li>
 361
 362
 363
 364         </ul>
 365       </nav>
 366     </li>
 367
 368
 369
 370
 371
 372
 373
 374     <li class="md-nav__item">
 375       <a href="../../../php/api/comments/" class="md-nav__link">
 376         Comments
 377       </a>
 378     </li>
 379
 380
 381
 382
 383
 384
 385
 386     <li class="md-nav__item">
 387       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 388         Cronjobs
 389       </a>
 390     </li>
 391
 392
 393
 394
 395
 396
 397
 398     <li class="md-nav__item">
 399       <a href="../../../php/api/events/" class="md-nav__link">
 400         Events
 401       </a>
 402     </li>
 403
 404
 405
 406
 407
 408
 409
 410
 411     <li class="md-nav__item md-nav__item--nested">
 412
 413
 414         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 415
 416       <label class="md-nav__link" for="__nav_2_5_5">
 417         Form Builder
 418         <span class="md-nav__icon md-icon"></span>
 419       </label>
 420       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 421         <label class="md-nav__title" for="__nav_2_5_5">
 422           <span class="md-nav__icon md-icon"></span>
 423           Form Builder
 424         </label>
 425         <ul class="md-nav__list" data-md-scrollfix>
 426
 427
 428
 429
 430
 431     <li class="md-nav__item">
 432       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 433         Overview
 434       </a>
 435     </li>
 436
 437
 438
 439
 440
 441
 442
 443     <li class="md-nav__item">
 444       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 445         Structure
 446       </a>
 447     </li>
 448
 449
 450
 451
 452
 453
 454
 455     <li class="md-nav__item">
 456       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 457         Fields
 458       </a>
 459     </li>
 460
 461
 462
 463
 464
 465
 466
 467     <li class="md-nav__item">
 468       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 469         Validation and Data
 470       </a>
 471     </li>
 472
 473
 474
 475
 476
 477
 478
 479     <li class="md-nav__item">
 480       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 481         Dependencies
 482       </a>
 483     </li>
 484
 485
 486
 487         </ul>
 488       </nav>
 489     </li>
 490
 491
 492
 493
 494
 495
 496
 497     <li class="md-nav__item">
 498       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 499         Package Installation Plugins
 500       </a>
 501     </li>
 502
 503
 504
 505
 506
 507
 508
 509     <li class="md-nav__item">
 510       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 511         User Activity Points
 512       </a>
 513     </li>
 514
 515
 516
 517
 518
 519
 520
 521     <li class="md-nav__item">
 522       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 523         User Notifications
 524       </a>
 525     </li>
 526
 527
 528
 529
 530
 531
 532
 533     <li class="md-nav__item">
 534       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 535         Sitemaps
 536       </a>
 537     </li>
 538
 539
 540
 541         </ul>
 542       </nav>
 543     </li>
 544
 545
 546
 547
 548
 549
 550
 551     <li class="md-nav__item">
 552       <a href="../../../php/code-style/" class="md-nav__link">
 553         Code Style
 554       </a>
 555     </li>
 556
 557
 558
 559
 560
 561
 562
 563     <li class="md-nav__item">
 564       <a href="../../../php/apps/" class="md-nav__link">
 565         Apps
 566       </a>
 567     </li>
 568
 569
 570
 571
 572
 573
 574
 575     <li class="md-nav__item">
 576       <a href="../../../php/gdpr/" class="md-nav__link">
 577         GDPR
 578       </a>
 579     </li>
 580
 581
 582
 583         </ul>
 584       </nav>
 585     </li>
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597     <li class="md-nav__item md-nav__item--nested">
 598
 599
 600         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 601
 602       <label class="md-nav__link" for="__nav_3">
 603         Languages, Templates & CSS
 604         <span class="md-nav__icon md-icon"></span>
 605       </label>
 606       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 607         <label class="md-nav__title" for="__nav_3">
 608           <span class="md-nav__icon md-icon"></span>
 609           Languages, Templates & CSS
 610         </label>
 611         <ul class="md-nav__list" data-md-scrollfix>
 612
 613
 614
 615
 616
 617     <li class="md-nav__item">
 618       <a href="../../../view/languages/" class="md-nav__link">
 619         Languages
 620       </a>
 621     </li>
 622
 623
 624
 625
 626
 627
 628
 629     <li class="md-nav__item">
 630       <a href="../../../view/templates/" class="md-nav__link">
 631         Templates
 632       </a>
 633     </li>
 634
 635
 636
 637
 638
 639
 640
 641     <li class="md-nav__item">
 642       <a href="../../../view/template-plugins/" class="md-nav__link">
 643         Template Plugins
 644       </a>
 645     </li>
 646
 647
 648
 649
 650
 651
 652
 653     <li class="md-nav__item">
 654       <a href="../../../view/css/" class="md-nav__link">
 655         CSS
 656       </a>
 657     </li>
 658
 659
 660
 661         </ul>
 662       </nav>
 663     </li>
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675     <li class="md-nav__item md-nav__item--nested">
 676
 677
 678         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 679
 680       <label class="md-nav__link" for="__nav_4">
 681         TypeScript and JavaScript API
 682         <span class="md-nav__icon md-icon"></span>
 683       </label>
 684       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 685         <label class="md-nav__title" for="__nav_4">
 686           <span class="md-nav__icon md-icon"></span>
 687           TypeScript and JavaScript API
 688         </label>
 689         <ul class="md-nav__list" data-md-scrollfix>
 690
 691
 692
 693
 694
 695     <li class="md-nav__item">
 696       <a href="../../../javascript/general-usage/" class="md-nav__link">
 697         General Usage
 698       </a>
 699     </li>
 700
 701
 702
 703
 704
 705
 706
 707     <li class="md-nav__item">
 708       <a href="../../../javascript/typescript/" class="md-nav__link">
 709         TypeScript
 710       </a>
 711     </li>
 712
 713
 714
 715
 716
 717
 718
 719
 720     <li class="md-nav__item md-nav__item--nested">
 721
 722
 723         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 724
 725       <label class="md-nav__link" for="__nav_4_3">
 726         New API
 727         <span class="md-nav__icon md-icon"></span>
 728       </label>
 729       <nav class="md-nav" aria-label="New API" data-md-level="2">
 730         <label class="md-nav__title" for="__nav_4_3">
 731           <span class="md-nav__icon md-icon"></span>
 732           New API
 733         </label>
 734         <ul class="md-nav__list" data-md-scrollfix>
 735
 736
 737
 738
 739
 740     <li class="md-nav__item">
 741       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 742         Writing a module
 743       </a>
 744     </li>
 745
 746
 747
 748
 749
 750
 751
 752     <li class="md-nav__item">
 753       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 754         Data Structures
 755       </a>
 756     </li>
 757
 758
 759
 760
 761
 762
 763
 764     <li class="md-nav__item">
 765       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 766         Core Functions
 767       </a>
 768     </li>
 769
 770
 771
 772
 773
 774
 775
 776     <li class="md-nav__item">
 777       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 778         DOM
 779       </a>
 780     </li>
 781
 782
 783
 784
 785
 786
 787
 788     <li class="md-nav__item">
 789       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 790         Event Handling
 791       </a>
 792     </li>
 793
 794
 795
 796
 797
 798
 799
 800     <li class="md-nav__item">
 801       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 802         Ajax
 803       </a>
 804     </li>
 805
 806
 807
 808
 809
 810
 811
 812     <li class="md-nav__item">
 813       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 814         Dialogs
 815       </a>
 816     </li>
 817
 818
 819
 820
 821
 822
 823
 824     <li class="md-nav__item">
 825       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 826         Browser and Screen Sizes
 827       </a>
 828     </li>
 829
 830
 831
 832
 833
 834
 835
 836     <li class="md-nav__item">
 837       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 838         User Interface
 839       </a>
 840     </li>
 841
 842
 843
 844         </ul>
 845       </nav>
 846     </li>
 847
 848
 849
 850
 851
 852
 853
 854     <li class="md-nav__item">
 855       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 856         Legacy API
 857       </a>
 858     </li>
 859
 860
 861
 862
 863
 864
 865
 866     <li class="md-nav__item">
 867       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 868         Helper Functions
 869       </a>
 870     </li>
 871
 872
 873
 874
 875
 876
 877
 878     <li class="md-nav__item">
 879       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 880         Code Snippets
 881       </a>
 882     </li>
 883
 884
 885
 886         </ul>
 887       </nav>
 888     </li>
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 903
 904
 905         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 906
 907       <label class="md-nav__link" for="__nav_5">
 908         Package Components
 909         <span class="md-nav__icon md-icon"></span>
 910       </label>
 911       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 912         <label class="md-nav__title" for="__nav_5">
 913           <span class="md-nav__icon md-icon"></span>
 914           Package Components
 915         </label>
 916         <ul class="md-nav__list" data-md-scrollfix>
 917
 918
 919
 920
 921
 922     <li class="md-nav__item">
 923       <a href="../../package-xml/" class="md-nav__link">
 924         package.xml
 925       </a>
 926     </li>
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 938
 939
 940         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
 941
 942       <label class="md-nav__link" for="__nav_5_2">
 943         PIPs
 944         <span class="md-nav__icon md-icon"></span>
 945       </label>
 946       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 947         <label class="md-nav__title" for="__nav_5_2">
 948           <span class="md-nav__icon md-icon"></span>
 949           PIPs
 950         </label>
 951         <ul class="md-nav__list" data-md-scrollfix>
 952
 953
 954
 955
 956
 957     <li class="md-nav__item">
 958       <a href="../" class="md-nav__link">
 959         Overview
 960       </a>
 961     </li>
 962
 963
 964
 965
 966
 967
 968
 969     <li class="md-nav__item">
 970       <a href="../acl-option/" class="md-nav__link">
 971         aclOption
 972       </a>
 973     </li>
 974
 975
 976
 977
 978
 979
 980
 981     <li class="md-nav__item">
 982       <a href="../acp-menu/" class="md-nav__link">
 983         acpMenu
 984       </a>
 985     </li>
 986
 987
 988
 989
 990
 991
 992
 993     <li class="md-nav__item">
 994       <a href="../acp-search-provider/" class="md-nav__link">
 995         acpSearchProvider
 996       </a>
 997     </li>
 998
 999
1000
1001
1002
1003
1004
1005     <li class="md-nav__item">
1006       <a href="../acp-template/" class="md-nav__link">
1007         acpTemplate
1008       </a>
1009     </li>
1010
1011
1012
1013
1014
1015
1016
1017     <li class="md-nav__item">
1018       <a href="../bbcode/" class="md-nav__link">
1019         bbcode
1020       </a>
1021     </li>
1022
1023
1024
1025
1026
1027
1028
1029     <li class="md-nav__item">
1030       <a href="../box/" class="md-nav__link">
1031         box
1032       </a>
1033     </li>
1034
1035
1036
1037
1038
1039
1040
1041     <li class="md-nav__item">
1042       <a href="../clipboard-action/" class="md-nav__link">
1043         clipboardAction
1044       </a>
1045     </li>
1046
1047
1048
1049
1050
1051
1052
1053     <li class="md-nav__item">
1054       <a href="../core-object/" class="md-nav__link">
1055         coreObject
1056       </a>
1057     </li>
1058
1059
1060
1061
1062
1063
1064
1065     <li class="md-nav__item">
1066       <a href="../cronjob/" class="md-nav__link">
1067         cronjob
1068       </a>
1069     </li>
1070
1071
1072
1073
1074
1075
1076
1077     <li class="md-nav__item">
1078       <a href="../database/" class="md-nav__link">
1079         database
1080       </a>
1081     </li>
1082
1083
1084
1085
1086
1087
1088
1089     <li class="md-nav__item">
1090       <a href="../event-listener/" class="md-nav__link">
1091         eventListener
1092       </a>
1093     </li>
1094
1095
1096
1097
1098
1099
1100
1101     <li class="md-nav__item">
1102       <a href="../file/" class="md-nav__link">
1103         file
1104       </a>
1105     </li>
1106
1107
1108
1109
1110
1111
1112
1113     <li class="md-nav__item">
1114       <a href="../language/" class="md-nav__link">
1115         language
1116       </a>
1117     </li>
1118
1119
1120
1121
1122
1123
1124
1125     <li class="md-nav__item">
1126       <a href="../media-provider/" class="md-nav__link">
1127         mediaProvider
1128       </a>
1129     </li>
1130
1131
1132
1133
1134
1135
1136
1137     <li class="md-nav__item">
1138       <a href="../menu/" class="md-nav__link">
1139         menu
1140       </a>
1141     </li>
1142
1143
1144
1145
1146
1147
1148
1149     <li class="md-nav__item">
1150       <a href="../menu-item/" class="md-nav__link">
1151         menuItem
1152       </a>
1153     </li>
1154
1155
1156
1157
1158
1159
1160
1161     <li class="md-nav__item">
1162       <a href="../object-type/" class="md-nav__link">
1163         objectType
1164       </a>
1165     </li>
1166
1167
1168
1169
1170
1171
1172
1173     <li class="md-nav__item">
1174       <a href="../object-type-definition/" class="md-nav__link">
1175         objectTypeDefinition
1176       </a>
1177     </li>
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187     <li class="md-nav__item md-nav__item--active">
1188
1189       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1190
1191
1192
1193
1194
1195         <label class="md-nav__link md-nav__link--active" for="__toc">
1196           option
1197           <span class="md-nav__icon md-icon"></span>
1198         </label>
1199
1200       <a href="./" class="md-nav__link md-nav__link--active">
1201         option
1202       </a>
1203
1204
1205 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1206
1207
1208
1209
1210
1211
1212     <label class="md-nav__title" for="__toc">
1213       <span class="md-nav__icon md-icon"></span>
1214       Table of contents
1215     </label>
1216     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1217
1218         <li class="md-nav__item">
1219   <a href="#category-components" class="md-nav__link">
1220     Category Components
1221   </a>
1222
1223     <nav class="md-nav" aria-label="Category Components">
1224       <ul class="md-nav__list">
1225
1226           <li class="md-nav__item">
1227   <a href="#parent" class="md-nav__link">
1228     &lt;parent&gt;
1229   </a>
1230
1231 </li>
1232
1233           <li class="md-nav__item">
1234   <a href="#showorder" class="md-nav__link">
1235     &lt;showorder&gt;
1236   </a>
1237
1238 </li>
1239
1240           <li class="md-nav__item">
1241   <a href="#options" class="md-nav__link">
1242     &lt;options&gt;
1243   </a>
1244
1245 </li>
1246
1247       </ul>
1248     </nav>
1249
1250 </li>
1251
1252         <li class="md-nav__item">
1253   <a href="#option-components" class="md-nav__link">
1254     Option Components
1255   </a>
1256
1257     <nav class="md-nav" aria-label="Option Components">
1258       <ul class="md-nav__list">
1259
1260           <li class="md-nav__item">
1261   <a href="#categoryname" class="md-nav__link">
1262     &lt;categoryname&gt;
1263   </a>
1264
1265 </li>
1266
1267           <li class="md-nav__item">
1268   <a href="#optiontype" class="md-nav__link">
1269     &lt;optiontype&gt;
1270   </a>
1271
1272 </li>
1273
1274           <li class="md-nav__item">
1275   <a href="#defaultvalue" class="md-nav__link">
1276     &lt;defaultvalue&gt;
1277   </a>
1278
1279 </li>
1280
1281           <li class="md-nav__item">
1282   <a href="#validationpattern" class="md-nav__link">
1283     &lt;validationpattern&gt;
1284   </a>
1285
1286 </li>
1287
1288           <li class="md-nav__item">
1289   <a href="#showorder_1" class="md-nav__link">
1290     &lt;showorder&gt;
1291   </a>
1292
1293 </li>
1294
1295           <li class="md-nav__item">
1296   <a href="#selectoptions" class="md-nav__link">
1297     &lt;selectoptions&gt;
1298   </a>
1299
1300 </li>
1301
1302           <li class="md-nav__item">
1303   <a href="#enableoptions" class="md-nav__link">
1304     &lt;enableoptions&gt;
1305   </a>
1306
1307 </li>
1308
1309           <li class="md-nav__item">
1310   <a href="#hidden" class="md-nav__link">
1311     &lt;hidden&gt;
1312   </a>
1313
1314 </li>
1315
1316           <li class="md-nav__item">
1317   <a href="#options_1" class="md-nav__link">
1318     &lt;options&gt;
1319   </a>
1320
1321 </li>
1322
1323           <li class="md-nav__item">
1324   <a href="#supporti18n" class="md-nav__link">
1325     &lt;supporti18n&gt;
1326   </a>
1327
1328 </li>
1329
1330           <li class="md-nav__item">
1331   <a href="#requirei18n" class="md-nav__link">
1332     &lt;requirei18n&gt;
1333   </a>
1334
1335 </li>
1336
1337           <li class="md-nav__item">
1338   <a href="#_1" class="md-nav__link">
1339     &lt;*&gt;
1340   </a>
1341
1342 </li>
1343
1344       </ul>
1345     </nav>
1346
1347 </li>
1348
1349         <li class="md-nav__item">
1350   <a href="#language-items" class="md-nav__link">
1351     Language Items
1352   </a>
1353
1354     <nav class="md-nav" aria-label="Language Items">
1355       <ul class="md-nav__list">
1356
1357           <li class="md-nav__item">
1358   <a href="#categories" class="md-nav__link">
1359     Categories
1360   </a>
1361
1362 </li>
1363
1364           <li class="md-nav__item">
1365   <a href="#options_2" class="md-nav__link">
1366     Options
1367   </a>
1368
1369 </li>
1370
1371       </ul>
1372     </nav>
1373
1374 </li>
1375
1376         <li class="md-nav__item">
1377   <a href="#example" class="md-nav__link">
1378     Example
1379   </a>
1380
1381 </li>
1382
1383     </ul>
1384
1385 </nav>
1386
1387     </li>
1388
1389
1390
1391
1392
1393
1394
1395     <li class="md-nav__item">
1396       <a href="../page/" class="md-nav__link">
1397         page
1398       </a>
1399     </li>
1400
1401
1402
1403
1404
1405
1406
1407     <li class="md-nav__item">
1408       <a href="../pip/" class="md-nav__link">
1409         pip
1410       </a>
1411     </li>
1412
1413
1414
1415
1416
1417
1418
1419     <li class="md-nav__item">
1420       <a href="../script/" class="md-nav__link">
1421         script
1422       </a>
1423     </li>
1424
1425
1426
1427
1428
1429
1430
1431     <li class="md-nav__item">
1432       <a href="../smiley/" class="md-nav__link">
1433         smiley
1434       </a>
1435     </li>
1436
1437
1438
1439
1440
1441
1442
1443     <li class="md-nav__item">
1444       <a href="../sql/" class="md-nav__link">
1445         sql
1446       </a>
1447     </li>
1448
1449
1450
1451
1452
1453
1454
1455     <li class="md-nav__item">
1456       <a href="../style/" class="md-nav__link">
1457         style
1458       </a>
1459     </li>
1460
1461
1462
1463
1464
1465
1466
1467     <li class="md-nav__item">
1468       <a href="../template/" class="md-nav__link">
1469         template
1470       </a>
1471     </li>
1472
1473
1474
1475
1476
1477
1478
1479     <li class="md-nav__item">
1480       <a href="../template-listener/" class="md-nav__link">
1481         templateListener
1482       </a>
1483     </li>
1484
1485
1486
1487
1488
1489
1490
1491     <li class="md-nav__item">
1492       <a href="../user-group-option/" class="md-nav__link">
1493         userGroupOption
1494       </a>
1495     </li>
1496
1497
1498
1499
1500
1501
1502
1503     <li class="md-nav__item">
1504       <a href="../user-menu/" class="md-nav__link">
1505         userMenu
1506       </a>
1507     </li>
1508
1509
1510
1511
1512
1513
1514
1515     <li class="md-nav__item">
1516       <a href="../user-notification-event/" class="md-nav__link">
1517         userNotificationEvent
1518       </a>
1519     </li>
1520
1521
1522
1523
1524
1525
1526
1527     <li class="md-nav__item">
1528       <a href="../user-option/" class="md-nav__link">
1529         userOption
1530       </a>
1531     </li>
1532
1533
1534
1535
1536
1537
1538
1539     <li class="md-nav__item">
1540       <a href="../user-profile-menu/" class="md-nav__link">
1541         userProfileMenu
1542       </a>
1543     </li>
1544
1545
1546
1547         </ul>
1548       </nav>
1549     </li>
1550
1551
1552
1553
1554
1555
1556
1557     <li class="md-nav__item">
1558       <a href="../../database-php-api/" class="md-nav__link">
1559         Database PHP API
1560       </a>
1561     </li>
1562
1563
1564
1565         </ul>
1566       </nav>
1567     </li>
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579     <li class="md-nav__item md-nav__item--nested">
1580
1581
1582         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1583
1584       <label class="md-nav__link" for="__nav_6">
1585         Migration
1586         <span class="md-nav__icon md-icon"></span>
1587       </label>
1588       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1589         <label class="md-nav__title" for="__nav_6">
1590           <span class="md-nav__icon md-icon"></span>
1591           Migration
1592         </label>
1593         <ul class="md-nav__list" data-md-scrollfix>
1594
1595
1596
1597
1598
1599
1600     <li class="md-nav__item md-nav__item--nested">
1601
1602
1603         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1604
1605       <label class="md-nav__link" for="__nav_6_1">
1606         Migrating from WSC 5.3
1607         <span class="md-nav__icon md-icon"></span>
1608       </label>
1609       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1610         <label class="md-nav__title" for="__nav_6_1">
1611           <span class="md-nav__icon md-icon"></span>
1612           Migrating from WSC 5.3
1613         </label>
1614         <ul class="md-nav__list" data-md-scrollfix>
1615
1616
1617
1618
1619
1620     <li class="md-nav__item">
1621       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1622         PHP API
1623       </a>
1624     </li>
1625
1626
1627
1628
1629
1630
1631
1632     <li class="md-nav__item">
1633       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1634         Session Handling and Authentication
1635       </a>
1636     </li>
1637
1638
1639
1640
1641
1642
1643
1644     <li class="md-nav__item">
1645       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1646         TypeScript and JavaScript
1647       </a>
1648     </li>
1649
1650
1651
1652
1653
1654
1655
1656     <li class="md-nav__item">
1657       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1658         Templates
1659       </a>
1660     </li>
1661
1662
1663
1664
1665
1666
1667
1668     <li class="md-nav__item">
1669       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1670         Third Party Libraries
1671       </a>
1672     </li>
1673
1674
1675
1676         </ul>
1677       </nav>
1678     </li>
1679
1680
1681
1682
1683
1684
1685
1686
1687     <li class="md-nav__item md-nav__item--nested">
1688
1689
1690         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1691
1692       <label class="md-nav__link" for="__nav_6_2">
1693         Migrating from WSC 5.2
1694         <span class="md-nav__icon md-icon"></span>
1695       </label>
1696       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1697         <label class="md-nav__title" for="__nav_6_2">
1698           <span class="md-nav__icon md-icon"></span>
1699           Migrating from WSC 5.2
1700         </label>
1701         <ul class="md-nav__list" data-md-scrollfix>
1702
1703
1704
1705
1706
1707     <li class="md-nav__item">
1708       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1709         PHP API
1710       </a>
1711     </li>
1712
1713
1714
1715
1716
1717
1718
1719     <li class="md-nav__item">
1720       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1721         Templates and Languages
1722       </a>
1723     </li>
1724
1725
1726
1727
1728
1729
1730
1731     <li class="md-nav__item">
1732       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1733         Third Party Libraries
1734       </a>
1735     </li>
1736
1737
1738
1739         </ul>
1740       </nav>
1741     </li>
1742
1743
1744
1745
1746
1747
1748
1749
1750     <li class="md-nav__item md-nav__item--nested">
1751
1752
1753         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1754
1755       <label class="md-nav__link" for="__nav_6_3">
1756         Migrating from WSC 3.1
1757         <span class="md-nav__icon md-icon"></span>
1758       </label>
1759       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1760         <label class="md-nav__title" for="__nav_6_3">
1761           <span class="md-nav__icon md-icon"></span>
1762           Migrating from WSC 3.1
1763         </label>
1764         <ul class="md-nav__list" data-md-scrollfix>
1765
1766
1767
1768
1769
1770     <li class="md-nav__item">
1771       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1772         PHP API
1773       </a>
1774     </li>
1775
1776
1777
1778         </ul>
1779       </nav>
1780     </li>
1781
1782
1783
1784
1785
1786
1787
1788
1789     <li class="md-nav__item md-nav__item--nested">
1790
1791
1792         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1793
1794       <label class="md-nav__link" for="__nav_6_4">
1795         Migrating from WSC 3.0
1796         <span class="md-nav__icon md-icon"></span>
1797       </label>
1798       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1799         <label class="md-nav__title" for="__nav_6_4">
1800           <span class="md-nav__icon md-icon"></span>
1801           Migrating from WSC 3.0
1802         </label>
1803         <ul class="md-nav__list" data-md-scrollfix>
1804
1805
1806
1807
1808
1809     <li class="md-nav__item">
1810       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1811         PHP API
1812       </a>
1813     </li>
1814
1815
1816
1817
1818
1819
1820
1821     <li class="md-nav__item">
1822       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1823         JavaScript API
1824       </a>
1825     </li>
1826
1827
1828
1829
1830
1831
1832
1833     <li class="md-nav__item">
1834       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1835         Templates
1836       </a>
1837     </li>
1838
1839
1840
1841
1842
1843
1844
1845     <li class="md-nav__item">
1846       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1847         CSS
1848       </a>
1849     </li>
1850
1851
1852
1853
1854
1855
1856
1857     <li class="md-nav__item">
1858       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1859         Package Components
1860       </a>
1861     </li>
1862
1863
1864
1865         </ul>
1866       </nav>
1867     </li>
1868
1869
1870
1871
1872
1873
1874
1875
1876     <li class="md-nav__item md-nav__item--nested">
1877
1878
1879         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1880
1881       <label class="md-nav__link" for="__nav_6_5">
1882         Migrating from WCF 2.1
1883         <span class="md-nav__icon md-icon"></span>
1884       </label>
1885       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1886         <label class="md-nav__title" for="__nav_6_5">
1887           <span class="md-nav__icon md-icon"></span>
1888           Migrating from WCF 2.1
1889         </label>
1890         <ul class="md-nav__list" data-md-scrollfix>
1891
1892
1893
1894
1895
1896     <li class="md-nav__item">
1897       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1898         PHP API
1899       </a>
1900     </li>
1901
1902
1903
1904
1905
1906
1907
1908     <li class="md-nav__item">
1909       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1910         Templates
1911       </a>
1912     </li>
1913
1914
1915
1916
1917
1918
1919
1920     <li class="md-nav__item">
1921       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1922         CSS
1923       </a>
1924     </li>
1925
1926
1927
1928
1929
1930
1931
1932     <li class="md-nav__item">
1933       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1934         Package Components
1935       </a>
1936     </li>
1937
1938
1939
1940         </ul>
1941       </nav>
1942     </li>
1943
1944
1945
1946         </ul>
1947       </nav>
1948     </li>
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960     <li class="md-nav__item md-nav__item--nested">
1961
1962
1963         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1964
1965       <label class="md-nav__link" for="__nav_7">
1966         Tutorials
1967         <span class="md-nav__icon md-icon"></span>
1968       </label>
1969       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1970         <label class="md-nav__title" for="__nav_7">
1971           <span class="md-nav__icon md-icon"></span>
1972           Tutorials
1973         </label>
1974         <ul class="md-nav__list" data-md-scrollfix>
1975
1976
1977
1978
1979
1980
1981     <li class="md-nav__item md-nav__item--nested">
1982
1983
1984         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1985
1986       <label class="md-nav__link" for="__nav_7_1">
1987         Tutorial Series
1988         <span class="md-nav__icon md-icon"></span>
1989       </label>
1990       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1991         <label class="md-nav__title" for="__nav_7_1">
1992           <span class="md-nav__icon md-icon"></span>
1993           Tutorial Series
1994         </label>
1995         <ul class="md-nav__list" data-md-scrollfix>
1996
1997
1998
1999
2000
2001     <li class="md-nav__item">
2002       <a href="../../../tutorial/series/overview/" class="md-nav__link">
2003         Overview
2004       </a>
2005     </li>
2006
2007
2008
2009
2010
2011
2012
2013     <li class="md-nav__item">
2014       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2015         Part 1
2016       </a>
2017     </li>
2018
2019
2020
2021
2022
2023
2024
2025     <li class="md-nav__item">
2026       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2027         Part 2
2028       </a>
2029     </li>
2030
2031
2032
2033
2034
2035
2036
2037     <li class="md-nav__item">
2038       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2039         Part 3
2040       </a>
2041     </li>
2042
2043
2044
2045
2046
2047
2048
2049     <li class="md-nav__item">
2050       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2051         Part 4
2052       </a>
2053     </li>
2054
2055
2056
2057
2058
2059
2060
2061     <li class="md-nav__item">
2062       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2063         Part 5
2064       </a>
2065     </li>
2066
2067
2068
2069         </ul>
2070       </nav>
2071     </li>
2072
2073
2074
2075         </ul>
2076       </nav>
2077     </li>
2078
2079
2080
2081   </ul>
2082 </nav>
2083                   </div>
2084                 </div>
2085               </div>
2086
2087
2088
2089               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2090                 <div class="md-sidebar__scrollwrap">
2091                   <div class="md-sidebar__inner">
2092
2093 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2094
2095
2096
2097
2098
2099
2100     <label class="md-nav__title" for="__toc">
2101       <span class="md-nav__icon md-icon"></span>
2102       Table of contents
2103     </label>
2104     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2105
2106         <li class="md-nav__item">
2107   <a href="#category-components" class="md-nav__link">
2108     Category Components
2109   </a>
2110
2111     <nav class="md-nav" aria-label="Category Components">
2112       <ul class="md-nav__list">
2113
2114           <li class="md-nav__item">
2115   <a href="#parent" class="md-nav__link">
2116     &lt;parent&gt;
2117   </a>
2118
2119 </li>
2120
2121           <li class="md-nav__item">
2122   <a href="#showorder" class="md-nav__link">
2123     &lt;showorder&gt;
2124   </a>
2125
2126 </li>
2127
2128           <li class="md-nav__item">
2129   <a href="#options" class="md-nav__link">
2130     &lt;options&gt;
2131   </a>
2132
2133 </li>
2134
2135       </ul>
2136     </nav>
2137
2138 </li>
2139
2140         <li class="md-nav__item">
2141   <a href="#option-components" class="md-nav__link">
2142     Option Components
2143   </a>
2144
2145     <nav class="md-nav" aria-label="Option Components">
2146       <ul class="md-nav__list">
2147
2148           <li class="md-nav__item">
2149   <a href="#categoryname" class="md-nav__link">
2150     &lt;categoryname&gt;
2151   </a>
2152
2153 </li>
2154
2155           <li class="md-nav__item">
2156   <a href="#optiontype" class="md-nav__link">
2157     &lt;optiontype&gt;
2158   </a>
2159
2160 </li>
2161
2162           <li class="md-nav__item">
2163   <a href="#defaultvalue" class="md-nav__link">
2164     &lt;defaultvalue&gt;
2165   </a>
2166
2167 </li>
2168
2169           <li class="md-nav__item">
2170   <a href="#validationpattern" class="md-nav__link">
2171     &lt;validationpattern&gt;
2172   </a>
2173
2174 </li>
2175
2176           <li class="md-nav__item">
2177   <a href="#showorder_1" class="md-nav__link">
2178     &lt;showorder&gt;
2179   </a>
2180
2181 </li>
2182
2183           <li class="md-nav__item">
2184   <a href="#selectoptions" class="md-nav__link">
2185     &lt;selectoptions&gt;
2186   </a>
2187
2188 </li>
2189
2190           <li class="md-nav__item">
2191   <a href="#enableoptions" class="md-nav__link">
2192     &lt;enableoptions&gt;
2193   </a>
2194
2195 </li>
2196
2197           <li class="md-nav__item">
2198   <a href="#hidden" class="md-nav__link">
2199     &lt;hidden&gt;
2200   </a>
2201
2202 </li>
2203
2204           <li class="md-nav__item">
2205   <a href="#options_1" class="md-nav__link">
2206     &lt;options&gt;
2207   </a>
2208
2209 </li>
2210
2211           <li class="md-nav__item">
2212   <a href="#supporti18n" class="md-nav__link">
2213     &lt;supporti18n&gt;
2214   </a>
2215
2216 </li>
2217
2218           <li class="md-nav__item">
2219   <a href="#requirei18n" class="md-nav__link">
2220     &lt;requirei18n&gt;
2221   </a>
2222
2223 </li>
2224
2225           <li class="md-nav__item">
2226   <a href="#_1" class="md-nav__link">
2227     &lt;*&gt;
2228   </a>
2229
2230 </li>
2231
2232       </ul>
2233     </nav>
2234
2235 </li>
2236
2237         <li class="md-nav__item">
2238   <a href="#language-items" class="md-nav__link">
2239     Language Items
2240   </a>
2241
2242     <nav class="md-nav" aria-label="Language Items">
2243       <ul class="md-nav__list">
2244
2245           <li class="md-nav__item">
2246   <a href="#categories" class="md-nav__link">
2247     Categories
2248   </a>
2249
2250 </li>
2251
2252           <li class="md-nav__item">
2253   <a href="#options_2" class="md-nav__link">
2254     Options
2255   </a>
2256
2257 </li>
2258
2259       </ul>
2260     </nav>
2261
2262 </li>
2263
2264         <li class="md-nav__item">
2265   <a href="#example" class="md-nav__link">
2266     Example
2267   </a>
2268
2269 </li>
2270
2271     </ul>
2272
2273 </nav>
2274                   </div>
2275                 </div>
2276               </div>
2277
2278
2279           <div class="md-content" data-md-component="content">
2280             <article class="md-content__inner md-typeset">
2281
2282
2283                   <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">
2284                     <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>
2285                   </a>
2286
2287
2288                 <h1 id="option-package-installation-plugin">Option Package Installation Plugin<a class="headerlink" href="#option-package-installation-plugin" title="Permanent link">#</a></h1>
2289 <p>Registers new options.
2290 Options allow the administrator to configure the behaviour of installed packages.
2291 The specified values are exposed as PHP constants.</p>
2292 <h2 id="category-components">Category Components<a class="headerlink" href="#category-components" title="Permanent link">#</a></h2>
2293 <p>Each category is described as an <code>&lt;category&gt;</code> element with the mandatory attribute <code>name</code>.</p>
2294 <h3 id="parent"><code>&lt;parent&gt;</code><a class="headerlink" href="#parent" title="Permanent link">#</a></h3>
2295 <p><span class="label label-info">Optional</span></p>
2296 <p>The category’s parent category.</p>
2297 <h3 id="showorder"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder" title="Permanent link">#</a></h3>
2298 <p><span class="label label-info">Optional</span></p>
2299 <p>Specifies the order of this option within the parent category.</p>
2300 <h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2301 <p><span class="label label-info">Optional</span></p>
2302 <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>
2303 <h2 id="option-components">Option Components<a class="headerlink" href="#option-components" title="Permanent link">#</a></h2>
2304 <p>Each option is described as an <code>&lt;option&gt;</code> element with the mandatory attribute <code>name</code>.
2305 The <code>name</code> is transformed into a PHP constant name by uppercasing it.</p>
2306 <h3 id="categoryname"><code>&lt;categoryname&gt;</code><a class="headerlink" href="#categoryname" title="Permanent link">#</a></h3>
2307 <p>The option’s category.</p>
2308 <h3 id="optiontype"><code>&lt;optiontype&gt;</code><a class="headerlink" href="#optiontype" title="Permanent link">#</a></h3>
2309 <p>The type of input to be used for this option.
2310 Valid types are defined by the <code>wcf\system\option\*OptionType</code> classes.</p>
2311 <h3 id="defaultvalue"><code>&lt;defaultvalue&gt;</code><a class="headerlink" href="#defaultvalue" title="Permanent link">#</a></h3>
2312 <p>The value that is set after installation of a package.
2313 Valid values are defined by the <code>optiontype</code>.</p>
2314 <h3 id="validationpattern"><code>&lt;validationpattern&gt;</code><a class="headerlink" href="#validationpattern" title="Permanent link">#</a></h3>
2315 <p><span class="label label-info">Optional</span></p>
2316 <p>Defines a regular expression that is used to validate the value of a free form option (such as <code>text</code>).</p>
2317 <h3 id="showorder_1"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder_1" title="Permanent link">#</a></h3>
2318 <p><span class="label label-info">Optional</span></p>
2319 <p>Specifies the order of this option within the category.</p>
2320 <h3 id="selectoptions"><code>&lt;selectoptions&gt;</code><a class="headerlink" href="#selectoptions" title="Permanent link">#</a></h3>
2321 <p><span class="label label-info">Optional</span></p>
2322 <div class="admonition warning">
2323 <p class="admonition-title">Defined only for <code>select</code>, <code>multiSelect</code> and <code>radioButton</code> types.</p>
2324 </div>
2325 <p>Specifies a newline-separated list of selectable values.
2326 Each line consists of an internal handle, followed by a colon (<code>:</code>, U+003A), followed by a language item.
2327 The language item is shown to the administrator, the internal handle is what is saved and exposed to the code.</p>
2328 <h3 id="enableoptions"><code>&lt;enableoptions&gt;</code><a class="headerlink" href="#enableoptions" title="Permanent link">#</a></h3>
2329 <p><span class="label label-info">Optional</span></p>
2330 <div class="admonition warning">
2331 <p class="admonition-title">Defined only for <code>boolean</code>, <code>select</code> and <code>radioButton</code> types.</p>
2332 </div>
2333 <p>Specifies a comma-separated list of options which should be visually enabled when this option is enabled.
2334 A leading exclamation mark (<code>!</code>, U+0021) will disable the specified option when this option is enabled.
2335 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>
2336 <p>This setting is a visual helper for the administrator only.
2337 It does not have an effect on the server side processing of the option.</p>
2338 <h3 id="hidden"><code>&lt;hidden&gt;</code><a class="headerlink" href="#hidden" title="Permanent link">#</a></h3>
2339 <p><span class="label label-info">Optional</span></p>
2340 <p>If <code>hidden</code> is set to <code>1</code> the option will not be shown to the administrator.
2341 It still can be modified programmatically.</p>
2342 <h3 id="options_1"><code>&lt;options&gt;</code><a class="headerlink" href="#options_1" title="Permanent link">#</a></h3>
2343 <p><span class="label label-info">Optional</span></p>
2344 <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>
2345 <h3 id="supporti18n"><code>&lt;supporti18n&gt;</code><a class="headerlink" href="#supporti18n" title="Permanent link">#</a></h3>
2346 <p><span class="label label-info">Optional</span></p>
2347 <p>Specifies whether this option supports localized input.</p>
2348 <h3 id="requirei18n"><code>&lt;requirei18n&gt;</code><a class="headerlink" href="#requirei18n" title="Permanent link">#</a></h3>
2349 <p><span class="label label-info">Optional</span></p>
2350 <p>Specifies whether this option requires localized input (i.e. the administrator must specify a value for every installed language).</p>
2351 <h3 id="_1"><code>&lt;*&gt;</code><a class="headerlink" href="#_1" title="Permanent link">#</a></h3>
2352 <p><span class="label label-info">Optional</span></p>
2353 <p>Additional fields may be defined by specific types of options.
2354 Refer to the documentation of these for further explanation.</p>
2355 <h2 id="language-items">Language Items<a class="headerlink" href="#language-items" title="Permanent link">#</a></h2>
2356 <p>All relevant language items have to be put into the <code>wcf.acp.option</code> language item category.</p>
2357 <h3 id="categories">Categories<a class="headerlink" href="#categories" title="Permanent link">#</a></h3>
2358 <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.
2359 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>.
2360 Descriptions are only relevant for categories whose parent has a parent itself, i.e. categories on the third level.</p>
2361 <h3 id="options_2">Options<a class="headerlink" href="#options_2" title="Permanent link">#</a></h3>
2362 <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.
2363 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>
2364 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2365 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2366 <span class="normal"> 2</span>
2367 <span class="normal"> 3</span>
2368 <span class="normal"> 4</span>
2369 <span class="normal"> 5</span>
2370 <span class="normal"> 6</span>
2371 <span class="normal"> 7</span>
2372 <span class="normal"> 8</span>
2373 <span class="normal"> 9</span>
2374 <span class="normal">10</span>
2375 <span class="normal">11</span>
2376 <span class="normal">12</span>
2377 <span class="normal">13</span>
2378 <span class="normal">14</span>
2379 <span class="normal">15</span>
2380 <span class="normal">16</span>
2381 <span class="normal">17</span>
2382 <span class="normal">18</span>
2383 <span class="normal">19</span>
2384 <span class="normal">20</span>
2385 <span class="normal">21</span>
2386 <span class="normal">22</span>
2387 <span class="normal">23</span>
2388 <span class="normal">24</span>
2389 <span class="normal">25</span>
2390 <span class="normal">26</span>
2391 <span class="normal">27</span>
2392 <span class="normal">28</span>
2393 <span class="normal">29</span>
2394 <span class="normal">30</span>
2395 <span class="normal">31</span>
2396 <span class="normal">32</span>
2397 <span class="normal">33</span>
2398 <span class="normal">34</span>
2399 <span class="normal">35</span>
2400 <span class="normal">36</span>
2401 <span class="normal">37</span>
2402 <span class="normal">38</span>
2403 <span class="normal">39</span>
2404 <span class="normal">40</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2405 <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>
2406     <span class="nt">&lt;import&gt;</span>
2407         <span class="nt">&lt;categories&gt;</span>
2408             <span class="nt">&lt;category</span> <span class="na">name=</span><span class="s">&quot;example&quot;</span> <span class="nt">/&gt;</span>
2409             <span class="nt">&lt;category</span> <span class="na">name=</span><span class="s">&quot;example.sub&quot;</span><span class="nt">&gt;</span>
2410                 <span class="nt">&lt;parent&gt;</span>example<span class="nt">&lt;/parent&gt;</span>
2411                 <span class="nt">&lt;options&gt;</span>module_example<span class="nt">&lt;/options&gt;</span>
2412             <span class="nt">&lt;/category&gt;</span>
2413         <span class="nt">&lt;/categories&gt;</span>
2414
2415         <span class="nt">&lt;options&gt;</span>
2416             <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;module_example&quot;</span><span class="nt">&gt;</span>
2417                 <span class="nt">&lt;categoryname&gt;</span>module.community<span class="nt">&lt;/categoryname&gt;</span>
2418                 <span class="nt">&lt;optiontype&gt;</span>boolean<span class="nt">&lt;/optiontype&gt;</span>
2419                 <span class="nt">&lt;defaultvalue&gt;</span>1<span class="nt">&lt;/defaultvalue&gt;</span>
2420             <span class="nt">&lt;/option&gt;</span>
2421
2422             <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;example_integer&quot;</span><span class="nt">&gt;</span>
2423                 <span class="nt">&lt;categoryname&gt;</span>example.sub<span class="nt">&lt;/categoryname&gt;</span>
2424                 <span class="nt">&lt;optiontype&gt;</span>integer<span class="nt">&lt;/optiontype&gt;</span>
2425                 <span class="nt">&lt;defaultvalue&gt;</span>10<span class="nt">&lt;/defaultvalue&gt;</span>
2426                 <span class="nt">&lt;minvalue&gt;</span>5<span class="nt">&lt;/minvalue&gt;</span>
2427                 <span class="nt">&lt;maxvalue&gt;</span>40<span class="nt">&lt;/maxvalue&gt;</span>
2428             <span class="nt">&lt;/option&gt;</span>
2429
2430             <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;example_select&quot;</span><span class="nt">&gt;</span>
2431                 <span class="nt">&lt;categoryname&gt;</span>example.sub<span class="nt">&lt;/categoryname&gt;</span>
2432                 <span class="nt">&lt;optiontype&gt;</span>select<span class="nt">&lt;/optiontype&gt;</span>
2433                 <span class="nt">&lt;defaultvalue&gt;</span>DESC<span class="nt">&lt;/defaultvalue&gt;</span>
2434                 <span class="nt">&lt;selectoptions&gt;</span>ASC:wcf.global.sortOrder.ascending
2435 DESC:wcf.global.sortOrder.descending<span class="nt">&lt;/selectoptions&gt;</span>
2436             <span class="nt">&lt;/option&gt;</span>
2437         <span class="nt">&lt;/options&gt;</span>
2438     <span class="nt">&lt;/import&gt;</span>
2439
2440     <span class="nt">&lt;delete&gt;</span>
2441         <span class="nt">&lt;option</span> <span class="na">name=</span><span class="s">&quot;outdated_example&quot;</span> <span class="nt">/&gt;</span>
2442     <span class="nt">&lt;/delete&gt;</span>
2443 <span class="nt">&lt;/data&gt;</span>
2444 </code></pre></div>
2445 </td></tr></table>
2446
2447
2448
2449
2450 <hr>
2451 <div class="md-source-date">
2452   <small>
2453
2454       Last update: 2021-01-08
2455
2456   </small>
2457 </div>
2458
2459
2460
2461
2462
2463
2464
2465
2466             </article>
2467           </div>
2468         </div>
2469
2470       </main>
2471
2472
2473 <footer class="md-footer">
2474
2475     <nav class="md-footer__inner md-grid" aria-label="Footer">
2476
2477         <a href="../object-type-definition/" class="md-footer__link md-footer__link--prev" rel="prev">
2478           <div class="md-footer__button md-icon">
2479             <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>
2480           </div>
2481           <div class="md-footer__title">
2482             <div class="md-ellipsis">
2483               <span class="md-footer__direction">
2484                 Previous
2485               </span>
2486               objectTypeDefinition
2487             </div>
2488           </div>
2489         </a>
2490
2491
2492         <a href="../page/" class="md-footer__link md-footer__link--next" rel="next">
2493           <div class="md-footer__title">
2494             <div class="md-ellipsis">
2495               <span class="md-footer__direction">
2496                 Next
2497               </span>
2498               page
2499             </div>
2500           </div>
2501           <div class="md-footer__button md-icon">
2502             <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>
2503           </div>
2504         </a>
2505
2506     </nav>
2507
2508   <div class="md-footer-meta md-typeset">
2509     <div class="md-footer-meta__inner md-grid">
2510       <div class="md-footer-copyright">
2511
2512           <div class="md-footer-copyright__highlight">
2513             Copyright © 2020 WoltLab GmbH
2514           </div>
2515
2516         Made with
2517         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2518           Material for MkDocs
2519         </a>
2520
2521       </div>
2522       <div class="md-footer-copyright">
2523         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2524         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2525 </div>
2526     </div>
2527   </div>
2528 </footer>
2529
2530     </div>
2531     <div class="md-dialog" data-md-component="dialog">
2532       <div class="md-dialog__inner md-typeset"></div>
2533     </div>
2534     <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>
2535
2536
2537       <script src="../../../assets/javascripts/bundle.4ea5477f.min.js"></script>
2538
2539
2540   </body>
2541 </html>