latest/package/pip/user-option/index.html

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