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