6.0/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         <link rel="canonical" href="https://docs.woltlab.com/6.0/package/pip/option/">
  12
  13
  14         <link rel="prev" href="../object-type-definition/">
  15
  16
  17         <link rel="next" href="../page/">
  18
  19       <link rel="icon" href="../../../assets/default.favicon.ico">
  20       <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.15">
  21
  22
  23
  24         <title>option - WoltLab Suite Documentation</title>
  25
  26
  27
  28       <link rel="stylesheet" href="../../../assets/stylesheets/main.26e3688c.min.css">
  29
  30
  31         <link rel="stylesheet" href="../../../assets/stylesheets/palette.ecc896b0.min.css">
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  42
  43     <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  44
  45
  46
  47
  48
  49
  50   </head>
  51
  52
  53
  54
  55
  56
  57
  58     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  59
  60
  61
  62     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  63     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  64     <label class="md-overlay" for="__drawer"></label>
  65     <div data-md-component="skip">
  66
  67
  68         <a href="#option-package-installation-plugin" class="md-skip">
  69           Skip to content
  70         </a>
  71
  72     </div>
  73     <div data-md-component="announce">
  74
  75         <aside class="md-banner">
  76           <div class="md-banner__inner md-grid md-typeset">
  77
  78
  79     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  80
  81           </div>
  82
  83         </aside>
  84
  85     </div>
  86
  87       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  88
  89       </div>
  90
  91
  92
  93
  94
  95
  96 <header class="md-header md-header--shadow" data-md-component="header">
  97   <nav class="md-header__inner md-grid" aria-label="Header">
  98     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  99
 100   <img src="../../../assets/logo.png" alt="logo">
 101
 102     </a>
 103     <label class="md-header__button md-icon" for="__drawer">
 104       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 105     </label>
 106     <div class="md-header__title" data-md-component="header-title">
 107       <div class="md-header__ellipsis">
 108         <div class="md-header__topic">
 109           <span class="md-ellipsis">
 110             WoltLab Suite Documentation
 111           </span>
 112         </div>
 113         <div class="md-header__topic" data-md-component="header-topic">
 114           <span class="md-ellipsis">
 115
 116               option
 117
 118           </span>
 119         </div>
 120       </div>
 121     </div>
 122
 123
 124
 125
 126
 127       <label class="md-header__button md-icon" for="__search">
 128         <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>
 129       </label>
 130       <div class="md-search" data-md-component="search" role="dialog">
 131   <label class="md-search__overlay" for="__search"></label>
 132   <div class="md-search__inner" role="search">
 133     <form class="md-search__form" name="search">
 134       <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" required>
 135       <label class="md-search__icon md-icon" for="__search">
 136         <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>
 137         <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>
 138       </label>
 139       <nav class="md-search__options" aria-label="Search">
 140
 141         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 142           <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>
 143         </button>
 144       </nav>
 145
 146     </form>
 147     <div class="md-search__output">
 148       <div class="md-search__scrollwrap" data-md-scrollfix>
 149         <div class="md-search-result" data-md-component="search-result">
 150           <div class="md-search-result__meta">
 151             Initializing search
 152           </div>
 153           <ol class="md-search-result__list" role="presentation"></ol>
 154         </div>
 155       </div>
 156     </div>
 157   </div>
 158 </div>
 159
 160
 161       <div class="md-header__source">
 162         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 163   <div class="md-source__icon md-icon">
 164
 165     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
 166   </div>
 167   <div class="md-source__repository">
 168     GitHub
 169   </div>
 170 </a>
 171       </div>
 172
 173   </nav>
 174
 175 </header>
 176
 177     <div class="md-container" data-md-component="container">
 178
 179
 180
 181
 182
 183
 184       <main class="md-main" data-md-component="main">
 185         <div class="md-main__inner md-grid">
 186
 187
 188
 189               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 190                 <div class="md-sidebar__scrollwrap">
 191                   <div class="md-sidebar__inner">
 192
 193
 194
 195 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 196   <label class="md-nav__title" for="__drawer">
 197     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 198
 199   <img src="../../../assets/logo.png" alt="logo">
 200
 201     </a>
 202     WoltLab Suite Documentation
 203   </label>
 204
 205     <div class="md-nav__source">
 206       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 207   <div class="md-source__icon md-icon">
 208
 209     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
 210   </div>
 211   <div class="md-source__repository">
 212     GitHub
 213   </div>
 214 </a>
 215     </div>
 216
 217   <ul class="md-nav__list" data-md-scrollfix>
 218
 219
 220
 221
 222
 223
 224
 225
 226     <li class="md-nav__item">
 227       <a href="../../../getting-started/" class="md-nav__link">
 228         Getting Started
 229       </a>
 230     </li>
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242     <li class="md-nav__item md-nav__item--nested">
 243
 244
 245
 246
 247       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 248
 249
 250
 251         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 252           PHP API
 253           <span class="md-nav__icon md-icon"></span>
 254         </label>
 255
 256       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 257         <label class="md-nav__title" for="__nav_2">
 258           <span class="md-nav__icon md-icon"></span>
 259           PHP API
 260         </label>
 261         <ul class="md-nav__list" data-md-scrollfix>
 262
 263
 264
 265
 266
 267
 268     <li class="md-nav__item">
 269       <a href="../../../php/pages/" class="md-nav__link">
 270         Pages
 271       </a>
 272     </li>
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282     <li class="md-nav__item">
 283       <a href="../../../php/database-objects/" class="md-nav__link">
 284         Database Objects
 285       </a>
 286     </li>
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296     <li class="md-nav__item">
 297       <a href="../../../php/database-access/" class="md-nav__link">
 298         Database Access
 299       </a>
 300     </li>
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item">
 311       <a href="../../../php/exceptions/" class="md-nav__link">
 312         Exceptions
 313       </a>
 314     </li>
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325     <li class="md-nav__item md-nav__item--nested">
 326
 327
 328
 329
 330       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 331
 332
 333
 334         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 335           API
 336           <span class="md-nav__icon md-icon"></span>
 337         </label>
 338
 339       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 340         <label class="md-nav__title" for="__nav_2_5">
 341           <span class="md-nav__icon md-icon"></span>
 342           API
 343         </label>
 344         <ul class="md-nav__list" data-md-scrollfix>
 345
 346
 347
 348
 349
 350
 351
 352     <li class="md-nav__item md-nav__item--nested">
 353
 354
 355
 356
 357       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 358
 359
 360
 361         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 362           Caches
 363           <span class="md-nav__icon md-icon"></span>
 364         </label>
 365
 366       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 367         <label class="md-nav__title" for="__nav_2_5_1">
 368           <span class="md-nav__icon md-icon"></span>
 369           Caches
 370         </label>
 371         <ul class="md-nav__list" data-md-scrollfix>
 372
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../../php/api/caches/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392     <li class="md-nav__item">
 393       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 394         Persistent Caches
 395       </a>
 396     </li>
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406     <li class="md-nav__item">
 407       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 408         Runtime Caches
 409       </a>
 410     </li>
 411
 412
 413
 414
 415         </ul>
 416       </nav>
 417     </li>
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427     <li class="md-nav__item">
 428       <a href="../../../php/api/comments/" class="md-nav__link">
 429         Comments
 430       </a>
 431     </li>
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 443         Cronjobs
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455     <li class="md-nav__item">
 456       <a href="../../../php/api/events/" class="md-nav__link">
 457         Events
 458       </a>
 459     </li>
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470     <li class="md-nav__item md-nav__item--nested">
 471
 472
 473
 474
 475       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 476
 477
 478
 479         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 480           Form Builder
 481           <span class="md-nav__icon md-icon"></span>
 482         </label>
 483
 484       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 485         <label class="md-nav__title" for="__nav_2_5_5">
 486           <span class="md-nav__icon md-icon"></span>
 487           Form Builder
 488         </label>
 489         <ul class="md-nav__list" data-md-scrollfix>
 490
 491
 492
 493
 494
 495
 496     <li class="md-nav__item">
 497       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 498         Overview
 499       </a>
 500     </li>
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 512         Structure
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524     <li class="md-nav__item">
 525       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 526         Fields
 527       </a>
 528     </li>
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538     <li class="md-nav__item">
 539       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 540         Validation and Data
 541       </a>
 542     </li>
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552     <li class="md-nav__item">
 553       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 554         Dependencies
 555       </a>
 556     </li>
 557
 558
 559
 560
 561         </ul>
 562       </nav>
 563     </li>
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 575         Package Installation Plugins
 576       </a>
 577     </li>
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587     <li class="md-nav__item">
 588       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 589         User Activity Points
 590       </a>
 591     </li>
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601     <li class="md-nav__item">
 602       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 603         User Notifications
 604       </a>
 605     </li>
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 617         Sitemaps
 618       </a>
 619     </li>
 620
 621
 622
 623
 624         </ul>
 625       </nav>
 626     </li>
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636     <li class="md-nav__item">
 637       <a href="../../../php/code-style/" class="md-nav__link">
 638         Code Style
 639       </a>
 640     </li>
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650     <li class="md-nav__item">
 651       <a href="../../../php/apps/" class="md-nav__link">
 652         Apps
 653       </a>
 654     </li>
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664     <li class="md-nav__item">
 665       <a href="../../../php/gdpr/" class="md-nav__link">
 666         GDPR
 667       </a>
 668     </li>
 669
 670
 671
 672
 673         </ul>
 674       </nav>
 675     </li>
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item md-nav__item--nested">
 688
 689
 690
 691
 692       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 693
 694
 695
 696         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 697           Languages, Templates & CSS
 698           <span class="md-nav__icon md-icon"></span>
 699         </label>
 700
 701       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 702         <label class="md-nav__title" for="__nav_3">
 703           <span class="md-nav__icon md-icon"></span>
 704           Languages, Templates & CSS
 705         </label>
 706         <ul class="md-nav__list" data-md-scrollfix>
 707
 708
 709
 710
 711
 712
 713     <li class="md-nav__item">
 714       <a href="../../../view/languages/" class="md-nav__link">
 715         Languages
 716       </a>
 717     </li>
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727     <li class="md-nav__item">
 728       <a href="../../../view/templates/" class="md-nav__link">
 729         Templates
 730       </a>
 731     </li>
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741     <li class="md-nav__item">
 742       <a href="../../../view/template-plugins/" class="md-nav__link">
 743         Template Plugins
 744       </a>
 745     </li>
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755     <li class="md-nav__item">
 756       <a href="../../../view/css/" class="md-nav__link">
 757         CSS
 758       </a>
 759     </li>
 760
 761
 762
 763
 764         </ul>
 765       </nav>
 766     </li>
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778     <li class="md-nav__item md-nav__item--nested">
 779
 780
 781
 782
 783       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
 784
 785
 786
 787         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
 788           TypeScript and JavaScript API
 789           <span class="md-nav__icon md-icon"></span>
 790         </label>
 791
 792       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
 793         <label class="md-nav__title" for="__nav_4">
 794           <span class="md-nav__icon md-icon"></span>
 795           TypeScript and JavaScript API
 796         </label>
 797         <ul class="md-nav__list" data-md-scrollfix>
 798
 799
 800
 801
 802
 803
 804     <li class="md-nav__item">
 805       <a href="../../../javascript/general-usage/" class="md-nav__link">
 806         General Usage
 807       </a>
 808     </li>
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818     <li class="md-nav__item">
 819       <a href="../../../javascript/typescript/" class="md-nav__link">
 820         TypeScript
 821       </a>
 822     </li>
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833     <li class="md-nav__item md-nav__item--nested">
 834
 835
 836
 837
 838       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
 839
 840
 841
 842         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
 843           Components
 844           <span class="md-nav__icon md-icon"></span>
 845         </label>
 846
 847       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
 848         <label class="md-nav__title" for="__nav_4_3">
 849           <span class="md-nav__icon md-icon"></span>
 850           Components
 851         </label>
 852         <ul class="md-nav__list" data-md-scrollfix>
 853
 854
 855
 856
 857
 858
 859     <li class="md-nav__item">
 860       <a href="../../../javascript/components_confirmation/" class="md-nav__link">
 861         Confirmation
 862       </a>
 863     </li>
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873     <li class="md-nav__item">
 874       <a href="../../../javascript/components_dialog/" class="md-nav__link">
 875         Dialog
 876       </a>
 877     </li>
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887     <li class="md-nav__item">
 888       <a href="../../../javascript/components_google_maps/" class="md-nav__link">
 889         Google Maps
 890       </a>
 891     </li>
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901     <li class="md-nav__item">
 902       <a href="../../../javascript/components_pagination/" class="md-nav__link">
 903         Pagination
 904       </a>
 905     </li>
 906
 907
 908
 909
 910         </ul>
 911       </nav>
 912     </li>
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923     <li class="md-nav__item md-nav__item--nested">
 924
 925
 926
 927
 928       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
 929
 930
 931
 932         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
 933           New API
 934           <span class="md-nav__icon md-icon"></span>
 935         </label>
 936
 937       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
 938         <label class="md-nav__title" for="__nav_4_4">
 939           <span class="md-nav__icon md-icon"></span>
 940           New API
 941         </label>
 942         <ul class="md-nav__list" data-md-scrollfix>
 943
 944
 945
 946
 947
 948
 949     <li class="md-nav__item">
 950       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 951         Writing a module
 952       </a>
 953     </li>
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963     <li class="md-nav__item">
 964       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 965         Core Functions
 966       </a>
 967     </li>
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977     <li class="md-nav__item">
 978       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 979         DOM
 980       </a>
 981     </li>
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991     <li class="md-nav__item">
 992       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 993         Event Handling
 994       </a>
 995     </li>
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005     <li class="md-nav__item">
1006       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1007         Ajax
1008       </a>
1009     </li>
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019     <li class="md-nav__item">
1020       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1021         Dialogs
1022       </a>
1023     </li>
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033     <li class="md-nav__item">
1034       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1035         Browser and Screen Sizes
1036       </a>
1037     </li>
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047     <li class="md-nav__item">
1048       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1049         User Interface
1050       </a>
1051     </li>
1052
1053
1054
1055
1056         </ul>
1057       </nav>
1058     </li>
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068     <li class="md-nav__item">
1069       <a href="../../../javascript/legacy-api/" class="md-nav__link">
1070         Legacy API
1071       </a>
1072     </li>
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082     <li class="md-nav__item">
1083       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1084         Code Snippets
1085       </a>
1086     </li>
1087
1088
1089
1090
1091         </ul>
1092       </nav>
1093     </li>
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1108
1109
1110
1111
1112       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
1113
1114
1115
1116         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1117           Package Components
1118           <span class="md-nav__icon md-icon"></span>
1119         </label>
1120
1121       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
1122         <label class="md-nav__title" for="__nav_5">
1123           <span class="md-nav__icon md-icon"></span>
1124           Package Components
1125         </label>
1126         <ul class="md-nav__list" data-md-scrollfix>
1127
1128
1129
1130
1131
1132
1133     <li class="md-nav__item">
1134       <a href="../../package-xml/" class="md-nav__link">
1135         package.xml
1136       </a>
1137     </li>
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1151
1152
1153
1154
1155       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" checked>
1156
1157
1158
1159         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1160           PIPs
1161           <span class="md-nav__icon md-icon"></span>
1162         </label>
1163
1164       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="true">
1165         <label class="md-nav__title" for="__nav_5_2">
1166           <span class="md-nav__icon md-icon"></span>
1167           PIPs
1168         </label>
1169         <ul class="md-nav__list" data-md-scrollfix>
1170
1171
1172
1173
1174
1175
1176     <li class="md-nav__item">
1177       <a href="../" class="md-nav__link">
1178         Overview
1179       </a>
1180     </li>
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190     <li class="md-nav__item">
1191       <a href="../acl-option/" class="md-nav__link">
1192         aclOption
1193       </a>
1194     </li>
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204     <li class="md-nav__item">
1205       <a href="../acp-menu/" class="md-nav__link">
1206         acpMenu
1207       </a>
1208     </li>
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218     <li class="md-nav__item">
1219       <a href="../acp-search-provider/" class="md-nav__link">
1220         acpSearchProvider
1221       </a>
1222     </li>
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232     <li class="md-nav__item">
1233       <a href="../acp-template/" class="md-nav__link">
1234         acpTemplate
1235       </a>
1236     </li>
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246     <li class="md-nav__item">
1247       <a href="../acp-template-delete/" class="md-nav__link">
1248         acpTemplateDelete
1249       </a>
1250     </li>
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260     <li class="md-nav__item">
1261       <a href="../bbcode/" class="md-nav__link">
1262         bbcode
1263       </a>
1264     </li>
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274     <li class="md-nav__item">
1275       <a href="../box/" class="md-nav__link">
1276         box
1277       </a>
1278     </li>
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288     <li class="md-nav__item">
1289       <a href="../clipboard-action/" class="md-nav__link">
1290         clipboardAction
1291       </a>
1292     </li>
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302     <li class="md-nav__item">
1303       <a href="../core-object/" class="md-nav__link">
1304         coreObject
1305       </a>
1306     </li>
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316     <li class="md-nav__item">
1317       <a href="../cronjob/" class="md-nav__link">
1318         cronjob
1319       </a>
1320     </li>
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330     <li class="md-nav__item">
1331       <a href="../database/" class="md-nav__link">
1332         database
1333       </a>
1334     </li>
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344     <li class="md-nav__item">
1345       <a href="../event-listener/" class="md-nav__link">
1346         eventListener
1347       </a>
1348     </li>
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358     <li class="md-nav__item">
1359       <a href="../file/" class="md-nav__link">
1360         file
1361       </a>
1362     </li>
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372     <li class="md-nav__item">
1373       <a href="../file-delete/" class="md-nav__link">
1374         fileDelete
1375       </a>
1376     </li>
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386     <li class="md-nav__item">
1387       <a href="../language/" class="md-nav__link">
1388         language
1389       </a>
1390     </li>
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400     <li class="md-nav__item">
1401       <a href="../media-provider/" class="md-nav__link">
1402         mediaProvider
1403       </a>
1404     </li>
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414     <li class="md-nav__item">
1415       <a href="../menu/" class="md-nav__link">
1416         menu
1417       </a>
1418     </li>
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428     <li class="md-nav__item">
1429       <a href="../menu-item/" class="md-nav__link">
1430         menuItem
1431       </a>
1432     </li>
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442     <li class="md-nav__item">
1443       <a href="../object-type/" class="md-nav__link">
1444         objectType
1445       </a>
1446     </li>
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456     <li class="md-nav__item">
1457       <a href="../object-type-definition/" class="md-nav__link">
1458         objectTypeDefinition
1459       </a>
1460     </li>
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472     <li class="md-nav__item md-nav__item--active">
1473
1474       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1475
1476
1477
1478
1479
1480         <label class="md-nav__link md-nav__link--active" for="__toc">
1481           option
1482           <span class="md-nav__icon md-icon"></span>
1483         </label>
1484
1485       <a href="./" class="md-nav__link md-nav__link--active">
1486         option
1487       </a>
1488
1489
1490
1491 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1492
1493
1494
1495
1496
1497
1498     <label class="md-nav__title" for="__toc">
1499       <span class="md-nav__icon md-icon"></span>
1500       Table of contents
1501     </label>
1502     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1503
1504         <li class="md-nav__item">
1505   <a href="#category-components" class="md-nav__link">
1506     Category Components
1507   </a>
1508
1509     <nav class="md-nav" aria-label="Category Components">
1510       <ul class="md-nav__list">
1511
1512           <li class="md-nav__item">
1513   <a href="#parent" class="md-nav__link">
1514     &lt;parent&gt;
1515   </a>
1516
1517 </li>
1518
1519           <li class="md-nav__item">
1520   <a href="#showorder" class="md-nav__link">
1521     &lt;showorder&gt;
1522   </a>
1523
1524 </li>
1525
1526           <li class="md-nav__item">
1527   <a href="#options" class="md-nav__link">
1528     &lt;options&gt;
1529   </a>
1530
1531 </li>
1532
1533       </ul>
1534     </nav>
1535
1536 </li>
1537
1538         <li class="md-nav__item">
1539   <a href="#option-components" class="md-nav__link">
1540     Option Components
1541   </a>
1542
1543     <nav class="md-nav" aria-label="Option Components">
1544       <ul class="md-nav__list">
1545
1546           <li class="md-nav__item">
1547   <a href="#categoryname" class="md-nav__link">
1548     &lt;categoryname&gt;
1549   </a>
1550
1551 </li>
1552
1553           <li class="md-nav__item">
1554   <a href="#optiontype" class="md-nav__link">
1555     &lt;optiontype&gt;
1556   </a>
1557
1558 </li>
1559
1560           <li class="md-nav__item">
1561   <a href="#defaultvalue" class="md-nav__link">
1562     &lt;defaultvalue&gt;
1563   </a>
1564
1565 </li>
1566
1567           <li class="md-nav__item">
1568   <a href="#validationpattern" class="md-nav__link">
1569     &lt;validationpattern&gt;
1570   </a>
1571
1572 </li>
1573
1574           <li class="md-nav__item">
1575   <a href="#showorder_1" class="md-nav__link">
1576     &lt;showorder&gt;
1577   </a>
1578
1579 </li>
1580
1581           <li class="md-nav__item">
1582   <a href="#selectoptions" class="md-nav__link">
1583     &lt;selectoptions&gt;
1584   </a>
1585
1586 </li>
1587
1588           <li class="md-nav__item">
1589   <a href="#enableoptions" class="md-nav__link">
1590     &lt;enableoptions&gt;
1591   </a>
1592
1593 </li>
1594
1595           <li class="md-nav__item">
1596   <a href="#hidden" class="md-nav__link">
1597     &lt;hidden&gt;
1598   </a>
1599
1600 </li>
1601
1602           <li class="md-nav__item">
1603   <a href="#options_1" class="md-nav__link">
1604     &lt;options&gt;
1605   </a>
1606
1607 </li>
1608
1609           <li class="md-nav__item">
1610   <a href="#supporti18n" class="md-nav__link">
1611     &lt;supporti18n&gt;
1612   </a>
1613
1614 </li>
1615
1616           <li class="md-nav__item">
1617   <a href="#requirei18n" class="md-nav__link">
1618     &lt;requirei18n&gt;
1619   </a>
1620
1621 </li>
1622
1623           <li class="md-nav__item">
1624   <a href="#_1" class="md-nav__link">
1625     &lt;*&gt;
1626   </a>
1627
1628 </li>
1629
1630       </ul>
1631     </nav>
1632
1633 </li>
1634
1635         <li class="md-nav__item">
1636   <a href="#language-items" class="md-nav__link">
1637     Language Items
1638   </a>
1639
1640     <nav class="md-nav" aria-label="Language Items">
1641       <ul class="md-nav__list">
1642
1643           <li class="md-nav__item">
1644   <a href="#categories" class="md-nav__link">
1645     Categories
1646   </a>
1647
1648 </li>
1649
1650           <li class="md-nav__item">
1651   <a href="#options_2" class="md-nav__link">
1652     Options
1653   </a>
1654
1655 </li>
1656
1657       </ul>
1658     </nav>
1659
1660 </li>
1661
1662         <li class="md-nav__item">
1663   <a href="#example" class="md-nav__link">
1664     Example
1665   </a>
1666
1667 </li>
1668
1669     </ul>
1670
1671 </nav>
1672
1673     </li>
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683     <li class="md-nav__item">
1684       <a href="../page/" class="md-nav__link">
1685         page
1686       </a>
1687     </li>
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697     <li class="md-nav__item">
1698       <a href="../pip/" class="md-nav__link">
1699         pip
1700       </a>
1701     </li>
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711     <li class="md-nav__item">
1712       <a href="../script/" class="md-nav__link">
1713         script
1714       </a>
1715     </li>
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725     <li class="md-nav__item">
1726       <a href="../smiley/" class="md-nav__link">
1727         smiley
1728       </a>
1729     </li>
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739     <li class="md-nav__item">
1740       <a href="../sql/" class="md-nav__link">
1741         sql
1742       </a>
1743     </li>
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753     <li class="md-nav__item">
1754       <a href="../style/" class="md-nav__link">
1755         style
1756       </a>
1757     </li>
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767     <li class="md-nav__item">
1768       <a href="../template/" class="md-nav__link">
1769         template
1770       </a>
1771     </li>
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781     <li class="md-nav__item">
1782       <a href="../template-delete/" class="md-nav__link">
1783         templateDelete
1784       </a>
1785     </li>
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795     <li class="md-nav__item">
1796       <a href="../template-listener/" class="md-nav__link">
1797         templateListener
1798       </a>
1799     </li>
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809     <li class="md-nav__item">
1810       <a href="../user-group-option/" class="md-nav__link">
1811         userGroupOption
1812       </a>
1813     </li>
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823     <li class="md-nav__item">
1824       <a href="../user-menu/" class="md-nav__link">
1825         userMenu
1826       </a>
1827     </li>
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837     <li class="md-nav__item">
1838       <a href="../user-notification-event/" class="md-nav__link">
1839         userNotificationEvent
1840       </a>
1841     </li>
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851     <li class="md-nav__item">
1852       <a href="../user-option/" class="md-nav__link">
1853         userOption
1854       </a>
1855     </li>
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865     <li class="md-nav__item">
1866       <a href="../user-profile-menu/" class="md-nav__link">
1867         userProfileMenu
1868       </a>
1869     </li>
1870
1871
1872
1873
1874         </ul>
1875       </nav>
1876     </li>
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886     <li class="md-nav__item">
1887       <a href="../../database-php-api/" class="md-nav__link">
1888         Database PHP API
1889       </a>
1890     </li>
1891
1892
1893
1894
1895         </ul>
1896       </nav>
1897     </li>
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909     <li class="md-nav__item md-nav__item--nested">
1910
1911
1912
1913
1914       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1915
1916
1917
1918         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1919           Migration
1920           <span class="md-nav__icon md-icon"></span>
1921         </label>
1922
1923       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1924         <label class="md-nav__title" for="__nav_6">
1925           <span class="md-nav__icon md-icon"></span>
1926           Migration
1927         </label>
1928         <ul class="md-nav__list" data-md-scrollfix>
1929
1930
1931
1932
1933
1934
1935
1936     <li class="md-nav__item md-nav__item--nested">
1937
1938
1939
1940
1941       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1942
1943
1944
1945         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1946           From WoltLab Suite 5.5
1947           <span class="md-nav__icon md-icon"></span>
1948         </label>
1949
1950       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1951         <label class="md-nav__title" for="__nav_6_1">
1952           <span class="md-nav__icon md-icon"></span>
1953           From WoltLab Suite 5.5
1954         </label>
1955         <ul class="md-nav__list" data-md-scrollfix>
1956
1957
1958
1959
1960
1961
1962     <li class="md-nav__item">
1963       <a href="../../../migration/wsc55/php/" class="md-nav__link">
1964         PHP API
1965       </a>
1966     </li>
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976     <li class="md-nav__item">
1977       <a href="../../../migration/wsc55/javascript/" class="md-nav__link">
1978         TypeScript and JavaScript
1979       </a>
1980     </li>
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990     <li class="md-nav__item">
1991       <a href="../../../migration/wsc55/templates/" class="md-nav__link">
1992         Templates
1993       </a>
1994     </li>
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004     <li class="md-nav__item">
2005       <a href="../../../migration/wsc55/icons/" class="md-nav__link">
2006         Icons
2007       </a>
2008     </li>
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018     <li class="md-nav__item">
2019       <a href="../../../migration/wsc55/dialogs/" class="md-nav__link">
2020         Dialogs
2021       </a>
2022     </li>
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032     <li class="md-nav__item">
2033       <a href="../../../migration/wsc55/libraries/" class="md-nav__link">
2034         Third Party Libraries
2035       </a>
2036     </li>
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046     <li class="md-nav__item">
2047       <a href="../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
2048         Deprecations and Removals
2049       </a>
2050     </li>
2051
2052
2053
2054
2055         </ul>
2056       </nav>
2057     </li>
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068     <li class="md-nav__item md-nav__item--nested">
2069
2070
2071
2072
2073       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
2074
2075
2076
2077         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
2078           From WoltLab Suite 5.4
2079           <span class="md-nav__icon md-icon"></span>
2080         </label>
2081
2082       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
2083         <label class="md-nav__title" for="__nav_6_2">
2084           <span class="md-nav__icon md-icon"></span>
2085           From WoltLab Suite 5.4
2086         </label>
2087         <ul class="md-nav__list" data-md-scrollfix>
2088
2089
2090
2091
2092
2093
2094     <li class="md-nav__item">
2095       <a href="../../../migration/wsc54/php/" class="md-nav__link">
2096         PHP API
2097       </a>
2098     </li>
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108     <li class="md-nav__item">
2109       <a href="../../../migration/wsc54/javascript/" class="md-nav__link">
2110         TypeScript and JavaScript
2111       </a>
2112     </li>
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122     <li class="md-nav__item">
2123       <a href="../../../migration/wsc54/templates/" class="md-nav__link">
2124         Templates
2125       </a>
2126     </li>
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136     <li class="md-nav__item">
2137       <a href="../../../migration/wsc54/libraries/" class="md-nav__link">
2138         Third Party Libraries
2139       </a>
2140     </li>
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150     <li class="md-nav__item">
2151       <a href="../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2152         Deprecations and Removals
2153       </a>
2154     </li>
2155
2156
2157
2158
2159         </ul>
2160       </nav>
2161     </li>
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172     <li class="md-nav__item md-nav__item--nested">
2173
2174
2175
2176
2177       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2178
2179
2180
2181         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2182           From WoltLab Suite 5.3
2183           <span class="md-nav__icon md-icon"></span>
2184         </label>
2185
2186       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2187         <label class="md-nav__title" for="__nav_6_3">
2188           <span class="md-nav__icon md-icon"></span>
2189           From WoltLab Suite 5.3
2190         </label>
2191         <ul class="md-nav__list" data-md-scrollfix>
2192
2193
2194
2195
2196
2197
2198     <li class="md-nav__item">
2199       <a href="../../../migration/wsc53/php/" class="md-nav__link">
2200         PHP API
2201       </a>
2202     </li>
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212     <li class="md-nav__item">
2213       <a href="../../../migration/wsc53/session/" class="md-nav__link">
2214         Session Handling and Authentication
2215       </a>
2216     </li>
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226     <li class="md-nav__item">
2227       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
2228         TypeScript and JavaScript
2229       </a>
2230     </li>
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240     <li class="md-nav__item">
2241       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
2242         Templates
2243       </a>
2244     </li>
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254     <li class="md-nav__item">
2255       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
2256         Third Party Libraries
2257       </a>
2258     </li>
2259
2260
2261
2262
2263         </ul>
2264       </nav>
2265     </li>
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276     <li class="md-nav__item md-nav__item--nested">
2277
2278
2279
2280
2281       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2282
2283
2284
2285         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2286           From WoltLab Suite 5.2
2287           <span class="md-nav__icon md-icon"></span>
2288         </label>
2289
2290       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2291         <label class="md-nav__title" for="__nav_6_4">
2292           <span class="md-nav__icon md-icon"></span>
2293           From WoltLab Suite 5.2
2294         </label>
2295         <ul class="md-nav__list" data-md-scrollfix>
2296
2297
2298
2299
2300
2301
2302     <li class="md-nav__item">
2303       <a href="../../../migration/wsc52/php/" class="md-nav__link">
2304         PHP API
2305       </a>
2306     </li>
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316     <li class="md-nav__item">
2317       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
2318         Templates and Languages
2319       </a>
2320     </li>
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330     <li class="md-nav__item">
2331       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
2332         Third Party Libraries
2333       </a>
2334     </li>
2335
2336
2337
2338
2339         </ul>
2340       </nav>
2341     </li>
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352     <li class="md-nav__item md-nav__item--nested">
2353
2354
2355
2356
2357       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2358
2359
2360
2361         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2362           From WoltLab Suite 3.1
2363           <span class="md-nav__icon md-icon"></span>
2364         </label>
2365
2366       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2367         <label class="md-nav__title" for="__nav_6_5">
2368           <span class="md-nav__icon md-icon"></span>
2369           From WoltLab Suite 3.1
2370         </label>
2371         <ul class="md-nav__list" data-md-scrollfix>
2372
2373
2374
2375
2376
2377
2378     <li class="md-nav__item">
2379       <a href="../../../migration/wsc31/php/" class="md-nav__link">
2380         PHP API
2381       </a>
2382     </li>
2383
2384
2385
2386
2387         </ul>
2388       </nav>
2389     </li>
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400     <li class="md-nav__item md-nav__item--nested">
2401
2402
2403
2404
2405       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2406
2407
2408
2409         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2410           From WoltLab Suite 3.0
2411           <span class="md-nav__icon md-icon"></span>
2412         </label>
2413
2414       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2415         <label class="md-nav__title" for="__nav_6_6">
2416           <span class="md-nav__icon md-icon"></span>
2417           From WoltLab Suite 3.0
2418         </label>
2419         <ul class="md-nav__list" data-md-scrollfix>
2420
2421
2422
2423
2424
2425
2426     <li class="md-nav__item">
2427       <a href="../../../migration/wsc30/php/" class="md-nav__link">
2428         PHP API
2429       </a>
2430     </li>
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440     <li class="md-nav__item">
2441       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
2442         JavaScript API
2443       </a>
2444     </li>
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454     <li class="md-nav__item">
2455       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
2456         Templates
2457       </a>
2458     </li>
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468     <li class="md-nav__item">
2469       <a href="../../../migration/wsc30/css/" class="md-nav__link">
2470         CSS
2471       </a>
2472     </li>
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482     <li class="md-nav__item">
2483       <a href="../../../migration/wsc30/package/" class="md-nav__link">
2484         Package Components
2485       </a>
2486     </li>
2487
2488
2489
2490
2491         </ul>
2492       </nav>
2493     </li>
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504     <li class="md-nav__item md-nav__item--nested">
2505
2506
2507
2508
2509       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2510
2511
2512
2513         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2514           From WCF 2.1
2515           <span class="md-nav__icon md-icon"></span>
2516         </label>
2517
2518       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2519         <label class="md-nav__title" for="__nav_6_7">
2520           <span class="md-nav__icon md-icon"></span>
2521           From WCF 2.1
2522         </label>
2523         <ul class="md-nav__list" data-md-scrollfix>
2524
2525
2526
2527
2528
2529
2530     <li class="md-nav__item">
2531       <a href="../../../migration/wcf21/php/" class="md-nav__link">
2532         PHP API
2533       </a>
2534     </li>
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544     <li class="md-nav__item">
2545       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
2546         Templates
2547       </a>
2548     </li>
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558     <li class="md-nav__item">
2559       <a href="../../../migration/wcf21/css/" class="md-nav__link">
2560         CSS
2561       </a>
2562     </li>
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572     <li class="md-nav__item">
2573       <a href="../../../migration/wcf21/package/" class="md-nav__link">
2574         Package Components
2575       </a>
2576     </li>
2577
2578
2579
2580
2581         </ul>
2582       </nav>
2583     </li>
2584
2585
2586
2587
2588         </ul>
2589       </nav>
2590     </li>
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602     <li class="md-nav__item md-nav__item--nested">
2603
2604
2605
2606
2607       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2608
2609
2610
2611         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2612           Tutorials
2613           <span class="md-nav__icon md-icon"></span>
2614         </label>
2615
2616       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2617         <label class="md-nav__title" for="__nav_7">
2618           <span class="md-nav__icon md-icon"></span>
2619           Tutorials
2620         </label>
2621         <ul class="md-nav__list" data-md-scrollfix>
2622
2623
2624
2625
2626
2627
2628
2629     <li class="md-nav__item md-nav__item--nested">
2630
2631
2632
2633
2634       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2635
2636
2637
2638         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2639           Tutorial Series
2640           <span class="md-nav__icon md-icon"></span>
2641         </label>
2642
2643       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2644         <label class="md-nav__title" for="__nav_7_1">
2645           <span class="md-nav__icon md-icon"></span>
2646           Tutorial Series
2647         </label>
2648         <ul class="md-nav__list" data-md-scrollfix>
2649
2650
2651
2652
2653
2654
2655     <li class="md-nav__item">
2656       <a href="../../../tutorial/series/overview/" class="md-nav__link">
2657         Overview
2658       </a>
2659     </li>
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669     <li class="md-nav__item">
2670       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2671         Part 1
2672       </a>
2673     </li>
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683     <li class="md-nav__item">
2684       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2685         Part 2
2686       </a>
2687     </li>
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697     <li class="md-nav__item">
2698       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2699         Part 3
2700       </a>
2701     </li>
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711     <li class="md-nav__item">
2712       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2713         Part 4
2714       </a>
2715     </li>
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725     <li class="md-nav__item">
2726       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2727         Part 5
2728       </a>
2729     </li>
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739     <li class="md-nav__item">
2740       <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2741         Part 6
2742       </a>
2743     </li>
2744
2745
2746
2747
2748         </ul>
2749       </nav>
2750     </li>
2751
2752
2753
2754
2755         </ul>
2756       </nav>
2757     </li>
2758
2759
2760
2761   </ul>
2762 </nav>
2763                   </div>
2764                 </div>
2765               </div>
2766
2767
2768
2769               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2770                 <div class="md-sidebar__scrollwrap">
2771                   <div class="md-sidebar__inner">
2772
2773
2774 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2775
2776
2777
2778
2779
2780
2781     <label class="md-nav__title" for="__toc">
2782       <span class="md-nav__icon md-icon"></span>
2783       Table of contents
2784     </label>
2785     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2786
2787         <li class="md-nav__item">
2788   <a href="#category-components" class="md-nav__link">
2789     Category Components
2790   </a>
2791
2792     <nav class="md-nav" aria-label="Category Components">
2793       <ul class="md-nav__list">
2794
2795           <li class="md-nav__item">
2796   <a href="#parent" class="md-nav__link">
2797     &lt;parent&gt;
2798   </a>
2799
2800 </li>
2801
2802           <li class="md-nav__item">
2803   <a href="#showorder" class="md-nav__link">
2804     &lt;showorder&gt;
2805   </a>
2806
2807 </li>
2808
2809           <li class="md-nav__item">
2810   <a href="#options" class="md-nav__link">
2811     &lt;options&gt;
2812   </a>
2813
2814 </li>
2815
2816       </ul>
2817     </nav>
2818
2819 </li>
2820
2821         <li class="md-nav__item">
2822   <a href="#option-components" class="md-nav__link">
2823     Option Components
2824   </a>
2825
2826     <nav class="md-nav" aria-label="Option Components">
2827       <ul class="md-nav__list">
2828
2829           <li class="md-nav__item">
2830   <a href="#categoryname" class="md-nav__link">
2831     &lt;categoryname&gt;
2832   </a>
2833
2834 </li>
2835
2836           <li class="md-nav__item">
2837   <a href="#optiontype" class="md-nav__link">
2838     &lt;optiontype&gt;
2839   </a>
2840
2841 </li>
2842
2843           <li class="md-nav__item">
2844   <a href="#defaultvalue" class="md-nav__link">
2845     &lt;defaultvalue&gt;
2846   </a>
2847
2848 </li>
2849
2850           <li class="md-nav__item">
2851   <a href="#validationpattern" class="md-nav__link">
2852     &lt;validationpattern&gt;
2853   </a>
2854
2855 </li>
2856
2857           <li class="md-nav__item">
2858   <a href="#showorder_1" class="md-nav__link">
2859     &lt;showorder&gt;
2860   </a>
2861
2862 </li>
2863
2864           <li class="md-nav__item">
2865   <a href="#selectoptions" class="md-nav__link">
2866     &lt;selectoptions&gt;
2867   </a>
2868
2869 </li>
2870
2871           <li class="md-nav__item">
2872   <a href="#enableoptions" class="md-nav__link">
2873     &lt;enableoptions&gt;
2874   </a>
2875
2876 </li>
2877
2878           <li class="md-nav__item">
2879   <a href="#hidden" class="md-nav__link">
2880     &lt;hidden&gt;
2881   </a>
2882
2883 </li>
2884
2885           <li class="md-nav__item">
2886   <a href="#options_1" class="md-nav__link">
2887     &lt;options&gt;
2888   </a>
2889
2890 </li>
2891
2892           <li class="md-nav__item">
2893   <a href="#supporti18n" class="md-nav__link">
2894     &lt;supporti18n&gt;
2895   </a>
2896
2897 </li>
2898
2899           <li class="md-nav__item">
2900   <a href="#requirei18n" class="md-nav__link">
2901     &lt;requirei18n&gt;
2902   </a>
2903
2904 </li>
2905
2906           <li class="md-nav__item">
2907   <a href="#_1" class="md-nav__link">
2908     &lt;*&gt;
2909   </a>
2910
2911 </li>
2912
2913       </ul>
2914     </nav>
2915
2916 </li>
2917
2918         <li class="md-nav__item">
2919   <a href="#language-items" class="md-nav__link">
2920     Language Items
2921   </a>
2922
2923     <nav class="md-nav" aria-label="Language Items">
2924       <ul class="md-nav__list">
2925
2926           <li class="md-nav__item">
2927   <a href="#categories" class="md-nav__link">
2928     Categories
2929   </a>
2930
2931 </li>
2932
2933           <li class="md-nav__item">
2934   <a href="#options_2" class="md-nav__link">
2935     Options
2936   </a>
2937
2938 </li>
2939
2940       </ul>
2941     </nav>
2942
2943 </li>
2944
2945         <li class="md-nav__item">
2946   <a href="#example" class="md-nav__link">
2947     Example
2948   </a>
2949
2950 </li>
2951
2952     </ul>
2953
2954 </nav>
2955                   </div>
2956                 </div>
2957               </div>
2958
2959
2960
2961             <div class="md-content" data-md-component="content">
2962               <article class="md-content__inner md-typeset">
2963
2964
2965
2966
2967
2968
2969
2970 <h1 id="option-package-installation-plugin">Option Package Installation Plugin<a class="headerlink" href="#option-package-installation-plugin" title="Permanent link">#</a></h1>
2971 <p>Registers new options.
2972 Options allow the administrator to configure the behaviour of installed packages.
2973 The specified values are exposed as PHP constants.</p>
2974 <h2 id="category-components">Category Components<a class="headerlink" href="#category-components" title="Permanent link">#</a></h2>
2975 <p>Each category is described as an <code>&lt;category&gt;</code> element with the mandatory attribute <code>name</code>.</p>
2976 <h3 id="parent"><code>&lt;parent&gt;</code><a class="headerlink" href="#parent" title="Permanent link">#</a></h3>
2977 <p><span class="label label-info">Optional</span></p>
2978 <p>The category’s parent category.</p>
2979 <h3 id="showorder"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder" title="Permanent link">#</a></h3>
2980 <p><span class="label label-info">Optional</span></p>
2981 <p>Specifies the order of this option within the parent category.</p>
2982 <h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2983 <p><span class="label label-info">Optional</span></p>
2984 <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>
2985 <h2 id="option-components">Option Components<a class="headerlink" href="#option-components" title="Permanent link">#</a></h2>
2986 <p>Each option is described as an <code>&lt;option&gt;</code> element with the mandatory attribute <code>name</code>.
2987 The <code>name</code> is transformed into a PHP constant name by uppercasing it.</p>
2988 <h3 id="categoryname"><code>&lt;categoryname&gt;</code><a class="headerlink" href="#categoryname" title="Permanent link">#</a></h3>
2989 <p>The option’s category.</p>
2990 <h3 id="optiontype"><code>&lt;optiontype&gt;</code><a class="headerlink" href="#optiontype" title="Permanent link">#</a></h3>
2991 <p>The type of input to be used for this option.
2992 Valid types are defined by the <code>wcf\system\option\*OptionType</code> classes.</p>
2993 <h3 id="defaultvalue"><code>&lt;defaultvalue&gt;</code><a class="headerlink" href="#defaultvalue" title="Permanent link">#</a></h3>
2994 <p>The value that is set after installation of a package.
2995 Valid values are defined by the <code>optiontype</code>.</p>
2996 <h3 id="validationpattern"><code>&lt;validationpattern&gt;</code><a class="headerlink" href="#validationpattern" title="Permanent link">#</a></h3>
2997 <p><span class="label label-info">Optional</span></p>
2998 <p>Defines a regular expression that is used to validate the value of a free form option (such as <code>text</code>).</p>
2999 <h3 id="showorder_1"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder_1" title="Permanent link">#</a></h3>
3000 <p><span class="label label-info">Optional</span></p>
3001 <p>Specifies the order of this option within the category.</p>
3002 <h3 id="selectoptions"><code>&lt;selectoptions&gt;</code><a class="headerlink" href="#selectoptions" title="Permanent link">#</a></h3>
3003 <p><span class="label label-info">Optional</span></p>
3004 <div class="admonition warning">
3005 <p class="admonition-title">Defined only for <code>select</code>, <code>multiSelect</code> and <code>radioButton</code> types.</p>
3006 </div>
3007 <p>Specifies a newline-separated list of selectable values.
3008 Each line consists of an internal handle, followed by a colon (<code>:</code>, U+003A), followed by a language item.
3009 The language item is shown to the administrator, the internal handle is what is saved and exposed to the code.</p>
3010 <h3 id="enableoptions"><code>&lt;enableoptions&gt;</code><a class="headerlink" href="#enableoptions" title="Permanent link">#</a></h3>
3011 <p><span class="label label-info">Optional</span></p>
3012 <div class="admonition warning">
3013 <p class="admonition-title">Defined only for <code>boolean</code>, <code>select</code> and <code>radioButton</code> types.</p>
3014 </div>
3015 <p>Specifies a comma-separated list of options which should be visually enabled when this option is enabled.
3016 A leading exclamation mark (<code>!</code>, U+0021) will disable the specified option when this option is enabled.
3017 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>
3018 <p>This setting is a visual helper for the administrator only.
3019 It does not have an effect on the server side processing of the option.</p>
3020 <h3 id="hidden"><code>&lt;hidden&gt;</code><a class="headerlink" href="#hidden" title="Permanent link">#</a></h3>
3021 <p><span class="label label-info">Optional</span></p>
3022 <p>If <code>hidden</code> is set to <code>1</code> the option will not be shown to the administrator.
3023 It still can be modified programmatically.</p>
3024 <h3 id="options_1"><code>&lt;options&gt;</code><a class="headerlink" href="#options_1" title="Permanent link">#</a></h3>
3025 <p><span class="label label-info">Optional</span></p>
3026 <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>
3027 <h3 id="supporti18n"><code>&lt;supporti18n&gt;</code><a class="headerlink" href="#supporti18n" title="Permanent link">#</a></h3>
3028 <p><span class="label label-info">Optional</span></p>
3029 <p>Specifies whether this option supports localized input.</p>
3030 <h3 id="requirei18n"><code>&lt;requirei18n&gt;</code><a class="headerlink" href="#requirei18n" title="Permanent link">#</a></h3>
3031 <p><span class="label label-info">Optional</span></p>
3032 <p>Specifies whether this option requires localized input (i.e. the administrator must specify a value for every installed language).</p>
3033 <h3 id="_1"><code>&lt;*&gt;</code><a class="headerlink" href="#_1" title="Permanent link">#</a></h3>
3034 <p><span class="label label-info">Optional</span></p>
3035 <p>Additional fields may be defined by specific types of options.
3036 Refer to the documentation of these for further explanation.</p>
3037 <h2 id="language-items">Language Items<a class="headerlink" href="#language-items" title="Permanent link">#</a></h2>
3038 <p>All relevant language items have to be put into the <code>wcf.acp.option</code> language item category.</p>
3039 <h3 id="categories">Categories<a class="headerlink" href="#categories" title="Permanent link">#</a></h3>
3040 <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.
3041 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>.
3042 Descriptions are only relevant for categories whose parent has a parent itself, i.e. categories on the third level.</p>
3043 <h3 id="options_2">Options<a class="headerlink" href="#options_2" title="Permanent link">#</a></h3>
3044 <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.
3045 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>
3046 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
3047 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">option.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/package/pip/option.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3048 <span class="normal"> 2</span>
3049 <span class="normal"> 3</span>
3050 <span class="normal"> 4</span>
3051 <span class="normal"> 5</span>
3052 <span class="normal"> 6</span>
3053 <span class="normal"> 7</span>
3054 <span class="normal"> 8</span>
3055 <span class="normal"> 9</span>
3056 <span class="normal">10</span>
3057 <span class="normal">11</span>
3058 <span class="normal">12</span>
3059 <span class="normal">13</span>
3060 <span class="normal">14</span>
3061 <span class="normal">15</span>
3062 <span class="normal">16</span>
3063 <span class="normal">17</span>
3064 <span class="normal">18</span>
3065 <span class="normal">19</span>
3066 <span class="normal">20</span>
3067 <span class="normal">21</span>
3068 <span class="normal">22</span>
3069 <span class="normal">23</span>
3070 <span class="normal">24</span>
3071 <span class="normal">25</span>
3072 <span class="normal">26</span>
3073 <span class="normal">27</span>
3074 <span class="normal">28</span>
3075 <span class="normal">29</span>
3076 <span class="normal">30</span>
3077 <span class="normal">31</span>
3078 <span class="normal">32</span>
3079 <span class="normal">33</span>
3080 <span class="normal">34</span>
3081 <span class="normal">35</span>
3082 <span class="normal">36</span>
3083 <span class="normal">37</span>
3084 <span class="normal">38</span>
3085 <span class="normal">39</span>
3086 <span class="normal">40</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
3087 <span class="nt">&lt;data</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </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>
3088 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
3089 <span class="w">        </span><span class="nt">&lt;categories&gt;</span>
3090 <span class="w">            </span><span class="nt">&lt;category</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;example&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
3091 <span class="w">            </span><span class="nt">&lt;category</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;example.sub&quot;</span><span class="nt">&gt;</span>
3092 <span class="w">                </span><span class="nt">&lt;parent&gt;</span>example<span class="nt">&lt;/parent&gt;</span>
3093 <span class="w">                </span><span class="nt">&lt;options&gt;</span>module_example<span class="nt">&lt;/options&gt;</span>
3094 <span class="w">            </span><span class="nt">&lt;/category&gt;</span>
3095 <span class="w">        </span><span class="nt">&lt;/categories&gt;</span>
3096
3097 <span class="w">        </span><span class="nt">&lt;options&gt;</span>
3098 <span class="w">            </span><span class="nt">&lt;option</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;module_example&quot;</span><span class="nt">&gt;</span>
3099 <span class="w">                </span><span class="nt">&lt;categoryname&gt;</span>module.community<span class="nt">&lt;/categoryname&gt;</span>
3100 <span class="w">                </span><span class="nt">&lt;optiontype&gt;</span>boolean<span class="nt">&lt;/optiontype&gt;</span>
3101 <span class="w">                </span><span class="nt">&lt;defaultvalue&gt;</span>1<span class="nt">&lt;/defaultvalue&gt;</span>
3102 <span class="w">            </span><span class="nt">&lt;/option&gt;</span>
3103
3104 <span class="w">            </span><span class="nt">&lt;option</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;example_integer&quot;</span><span class="nt">&gt;</span>
3105 <span class="w">                </span><span class="nt">&lt;categoryname&gt;</span>example.sub<span class="nt">&lt;/categoryname&gt;</span>
3106 <span class="w">                </span><span class="nt">&lt;optiontype&gt;</span>integer<span class="nt">&lt;/optiontype&gt;</span>
3107 <span class="w">                </span><span class="nt">&lt;defaultvalue&gt;</span>10<span class="nt">&lt;/defaultvalue&gt;</span>
3108 <span class="w">                </span><span class="nt">&lt;minvalue&gt;</span>5<span class="nt">&lt;/minvalue&gt;</span>
3109 <span class="w">                </span><span class="nt">&lt;maxvalue&gt;</span>40<span class="nt">&lt;/maxvalue&gt;</span>
3110 <span class="w">            </span><span class="nt">&lt;/option&gt;</span>
3111
3112 <span class="w">            </span><span class="nt">&lt;option</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;example_select&quot;</span><span class="nt">&gt;</span>
3113 <span class="w">                </span><span class="nt">&lt;categoryname&gt;</span>example.sub<span class="nt">&lt;/categoryname&gt;</span>
3114 <span class="w">                </span><span class="nt">&lt;optiontype&gt;</span>select<span class="nt">&lt;/optiontype&gt;</span>
3115 <span class="w">                </span><span class="nt">&lt;defaultvalue&gt;</span>DESC<span class="nt">&lt;/defaultvalue&gt;</span>
3116 <span class="w">                </span><span class="nt">&lt;selectoptions&gt;</span>ASC:wcf.global.sortOrder.ascending
3117 <span class="w">                    </span>DESC:wcf.global.sortOrder.descending<span class="nt">&lt;/selectoptions&gt;</span>
3118 <span class="w">            </span><span class="nt">&lt;/option&gt;</span>
3119 <span class="w">        </span><span class="nt">&lt;/options&gt;</span>
3120 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
3121
3122 <span class="w">    </span><span class="nt">&lt;delete&gt;</span>
3123 <span class="w">        </span><span class="nt">&lt;option</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;outdated_example&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
3124 <span class="w">    </span><span class="nt">&lt;/delete&gt;</span>
3125 <span class="nt">&lt;/data&gt;</span>
3126 </code></pre></div></td></tr></table></div>
3127
3128   <hr>
3129 <div class="md-source-file">
3130   <small>
3131
3132       Last update:
3133       2021-04-23
3134
3135   </small>
3136 </div>
3137
3138
3139
3140
3141
3142
3143               </article>
3144             </div>
3145
3146
3147         </div>
3148
3149       </main>
3150
3151         <footer class="md-footer">
3152
3153   <div class="md-footer-meta md-typeset">
3154     <div class="md-footer-meta__inner md-grid">
3155       <div class="md-copyright">
3156
3157     <div class="md-copyright__highlight">
3158       Copyright © 2020 WoltLab GmbH
3159     </div>
3160
3161
3162     Made with
3163     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3164       Material for MkDocs
3165     </a>
3166
3167 </div>
3168
3169         <div class="md-copyright">
3170         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
3171         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
3172 </div>
3173
3174     </div>
3175   </div>
3176 </footer>
3177
3178     </div>
3179     <div class="md-dialog" data-md-component="dialog">
3180       <div class="md-dialog__inner md-typeset"></div>
3181     </div>
3182
3183     <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
3184
3185
3186       <script src="../../../assets/javascripts/bundle.b4d07000.min.js"></script>
3187
3188
3189   </body>
3190 </html>