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     <li class="md-nav__item">
 310       <a href="../../../php/api/caches/" class="md-nav__link">
 311         Caches
 312       </a>
 313     </li>
 314
 315
 316
 317
 318
 319
 320
 321     <li class="md-nav__item">
 322       <a href="../../../php/api/comments/" class="md-nav__link">
 323         Comments
 324       </a>
 325     </li>
 326
 327
 328
 329
 330
 331
 332
 333     <li class="md-nav__item">
 334       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 335         Cronjobs
 336       </a>
 337     </li>
 338
 339
 340
 341
 342
 343
 344
 345     <li class="md-nav__item">
 346       <a href="../../../php/api/events/" class="md-nav__link">
 347         Events
 348       </a>
 349     </li>
 350
 351
 352
 353
 354
 355
 356
 357
 358     <li class="md-nav__item md-nav__item--nested">
 359
 360
 361         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 362
 363       <label class="md-nav__link" for="__nav_2_5_5">
 364         Form Builder
 365         <span class="md-nav__icon md-icon"></span>
 366       </label>
 367       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 368         <label class="md-nav__title" for="__nav_2_5_5">
 369           <span class="md-nav__icon md-icon"></span>
 370           Form Builder
 371         </label>
 372         <ul class="md-nav__list" data-md-scrollfix>
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390     <li class="md-nav__item">
 391       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 392         Structure
 393       </a>
 394     </li>
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 404         Fields
 405       </a>
 406     </li>
 407
 408
 409
 410
 411
 412
 413
 414     <li class="md-nav__item">
 415       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 416         Validation and Data
 417       </a>
 418     </li>
 419
 420
 421
 422
 423
 424
 425
 426     <li class="md-nav__item">
 427       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 428         Dependencies
 429       </a>
 430     </li>
 431
 432
 433
 434         </ul>
 435       </nav>
 436     </li>
 437
 438
 439
 440
 441
 442
 443
 444     <li class="md-nav__item">
 445       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 446         Package Installation Plugins
 447       </a>
 448     </li>
 449
 450
 451
 452
 453
 454
 455
 456     <li class="md-nav__item">
 457       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 458         User Activity Points
 459       </a>
 460     </li>
 461
 462
 463
 464
 465
 466
 467
 468     <li class="md-nav__item">
 469       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 470         User Notifications
 471       </a>
 472     </li>
 473
 474
 475
 476
 477
 478
 479
 480     <li class="md-nav__item">
 481       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 482         Sitemaps
 483       </a>
 484     </li>
 485
 486
 487
 488         </ul>
 489       </nav>
 490     </li>
 491
 492
 493
 494
 495
 496
 497
 498     <li class="md-nav__item">
 499       <a href="../../../php/code-style/" class="md-nav__link">
 500         Code Style
 501       </a>
 502     </li>
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../../php/apps/" class="md-nav__link">
 512         Apps
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522     <li class="md-nav__item">
 523       <a href="../../../php/gdpr/" class="md-nav__link">
 524         GDPR
 525       </a>
 526     </li>
 527
 528
 529
 530         </ul>
 531       </nav>
 532     </li>
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544     <li class="md-nav__item md-nav__item--nested">
 545
 546
 547         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 548
 549       <label class="md-nav__link" for="__nav_3">
 550         Languages, Templates & CSS
 551         <span class="md-nav__icon md-icon"></span>
 552       </label>
 553       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 554         <label class="md-nav__title" for="__nav_3">
 555           <span class="md-nav__icon md-icon"></span>
 556           Languages, Templates & CSS
 557         </label>
 558         <ul class="md-nav__list" data-md-scrollfix>
 559
 560
 561
 562
 563
 564     <li class="md-nav__item">
 565       <a href="../../../view/languages/" class="md-nav__link">
 566         Languages
 567       </a>
 568     </li>
 569
 570
 571
 572
 573
 574
 575
 576     <li class="md-nav__item">
 577       <a href="../../../view/templates/" class="md-nav__link">
 578         Templates
 579       </a>
 580     </li>
 581
 582
 583
 584
 585
 586
 587
 588     <li class="md-nav__item">
 589       <a href="../../../view/css/" class="md-nav__link">
 590         CSS
 591       </a>
 592     </li>
 593
 594
 595
 596         </ul>
 597       </nav>
 598     </li>
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610     <li class="md-nav__item md-nav__item--nested">
 611
 612
 613         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 614
 615       <label class="md-nav__link" for="__nav_4">
 616         JavaScript API
 617         <span class="md-nav__icon md-icon"></span>
 618       </label>
 619       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 620         <label class="md-nav__title" for="__nav_4">
 621           <span class="md-nav__icon md-icon"></span>
 622           JavaScript API
 623         </label>
 624         <ul class="md-nav__list" data-md-scrollfix>
 625
 626
 627
 628
 629
 630     <li class="md-nav__item">
 631       <a href="../../../javascript/general-usage/" class="md-nav__link">
 632         General Usage
 633       </a>
 634     </li>
 635
 636
 637
 638
 639
 640
 641
 642
 643     <li class="md-nav__item md-nav__item--nested">
 644
 645
 646         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 647
 648       <label class="md-nav__link" for="__nav_4_2">
 649         New API
 650         <span class="md-nav__icon md-icon"></span>
 651       </label>
 652       <nav class="md-nav" aria-label="New API" data-md-level="2">
 653         <label class="md-nav__title" for="__nav_4_2">
 654           <span class="md-nav__icon md-icon"></span>
 655           New API
 656         </label>
 657         <ul class="md-nav__list" data-md-scrollfix>
 658
 659
 660
 661
 662
 663     <li class="md-nav__item">
 664       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 665         Writing a module
 666       </a>
 667     </li>
 668
 669
 670
 671
 672
 673
 674
 675     <li class="md-nav__item">
 676       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 677         Data Structures
 678       </a>
 679     </li>
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item">
 688       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 689         Core Functions
 690       </a>
 691     </li>
 692
 693
 694
 695
 696
 697
 698
 699     <li class="md-nav__item">
 700       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 701         DOM
 702       </a>
 703     </li>
 704
 705
 706
 707
 708
 709
 710
 711     <li class="md-nav__item">
 712       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 713         Event Handling
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 725         Ajax
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735     <li class="md-nav__item">
 736       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 737         Dialogs
 738       </a>
 739     </li>
 740
 741
 742
 743
 744
 745
 746
 747     <li class="md-nav__item">
 748       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 749         Browser and Screen Sizes
 750       </a>
 751     </li>
 752
 753
 754
 755
 756
 757
 758
 759     <li class="md-nav__item">
 760       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 761         User Interface
 762       </a>
 763     </li>
 764
 765
 766
 767         </ul>
 768       </nav>
 769     </li>
 770
 771
 772
 773
 774
 775
 776
 777     <li class="md-nav__item">
 778       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 779         Legacy API
 780       </a>
 781     </li>
 782
 783
 784
 785
 786
 787
 788
 789     <li class="md-nav__item">
 790       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 791         Helper Functions
 792       </a>
 793     </li>
 794
 795
 796
 797
 798
 799
 800
 801     <li class="md-nav__item">
 802       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 803         Code Snippets
 804       </a>
 805     </li>
 806
 807
 808
 809         </ul>
 810       </nav>
 811     </li>
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 826
 827
 828         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 829
 830       <label class="md-nav__link" for="__nav_5">
 831         Package Components
 832         <span class="md-nav__icon md-icon"></span>
 833       </label>
 834       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 835         <label class="md-nav__title" for="__nav_5">
 836           <span class="md-nav__icon md-icon"></span>
 837           Package Components
 838         </label>
 839         <ul class="md-nav__list" data-md-scrollfix>
 840
 841
 842
 843
 844
 845     <li class="md-nav__item">
 846       <a href="../../package-xml/" class="md-nav__link">
 847         package.xml
 848       </a>
 849     </li>
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 861
 862
 863         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
 864
 865       <label class="md-nav__link" for="__nav_5_2">
 866         PIPs
 867         <span class="md-nav__icon md-icon"></span>
 868       </label>
 869       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 870         <label class="md-nav__title" for="__nav_5_2">
 871           <span class="md-nav__icon md-icon"></span>
 872           PIPs
 873         </label>
 874         <ul class="md-nav__list" data-md-scrollfix>
 875
 876
 877
 878
 879
 880     <li class="md-nav__item">
 881       <a href="../" class="md-nav__link">
 882         Overview
 883       </a>
 884     </li>
 885
 886
 887
 888
 889
 890
 891
 892     <li class="md-nav__item">
 893       <a href="../acl-option/" class="md-nav__link">
 894         aclOption
 895       </a>
 896     </li>
 897
 898
 899
 900
 901
 902
 903
 904     <li class="md-nav__item">
 905       <a href="../acp-menu/" class="md-nav__link">
 906         acpMenu
 907       </a>
 908     </li>
 909
 910
 911
 912
 913
 914
 915
 916     <li class="md-nav__item">
 917       <a href="../acp-search-provider/" class="md-nav__link">
 918         acpSearchProvider
 919       </a>
 920     </li>
 921
 922
 923
 924
 925
 926
 927
 928     <li class="md-nav__item">
 929       <a href="../acp-template/" class="md-nav__link">
 930         acpTemplate
 931       </a>
 932     </li>
 933
 934
 935
 936
 937
 938
 939
 940     <li class="md-nav__item">
 941       <a href="../bbcode/" class="md-nav__link">
 942         bbcode
 943       </a>
 944     </li>
 945
 946
 947
 948
 949
 950
 951
 952     <li class="md-nav__item">
 953       <a href="../box/" class="md-nav__link">
 954         box
 955       </a>
 956     </li>
 957
 958
 959
 960
 961
 962
 963
 964     <li class="md-nav__item">
 965       <a href="../clipboard-action/" class="md-nav__link">
 966         clipboardAction
 967       </a>
 968     </li>
 969
 970
 971
 972
 973
 974
 975
 976     <li class="md-nav__item">
 977       <a href="../core-object/" class="md-nav__link">
 978         coreObject
 979       </a>
 980     </li>
 981
 982
 983
 984
 985
 986
 987
 988     <li class="md-nav__item">
 989       <a href="../cronjob/" class="md-nav__link">
 990         cronjob
 991       </a>
 992     </li>
 993
 994
 995
 996
 997
 998
 999
1000     <li class="md-nav__item">
1001       <a href="../event-listener/" class="md-nav__link">
1002         eventListener
1003       </a>
1004     </li>
1005
1006
1007
1008
1009
1010
1011
1012     <li class="md-nav__item">
1013       <a href="../file/" class="md-nav__link">
1014         file
1015       </a>
1016     </li>
1017
1018
1019
1020
1021
1022
1023
1024     <li class="md-nav__item">
1025       <a href="../language/" class="md-nav__link">
1026         language
1027       </a>
1028     </li>
1029
1030
1031
1032
1033
1034
1035
1036     <li class="md-nav__item">
1037       <a href="../media-provider/" class="md-nav__link">
1038         mediaProvider
1039       </a>
1040     </li>
1041
1042
1043
1044
1045
1046
1047
1048     <li class="md-nav__item">
1049       <a href="../menu/" class="md-nav__link">
1050         menu
1051       </a>
1052     </li>
1053
1054
1055
1056
1057
1058
1059
1060     <li class="md-nav__item">
1061       <a href="../menu-item/" class="md-nav__link">
1062         menuItem
1063       </a>
1064     </li>
1065
1066
1067
1068
1069
1070
1071
1072     <li class="md-nav__item">
1073       <a href="../object-type/" class="md-nav__link">
1074         objectType
1075       </a>
1076     </li>
1077
1078
1079
1080
1081
1082
1083
1084     <li class="md-nav__item">
1085       <a href="../object-type-definition/" class="md-nav__link">
1086         objectTypeDefinition
1087       </a>
1088     </li>
1089
1090
1091
1092
1093
1094
1095
1096     <li class="md-nav__item">
1097       <a href="../option/" class="md-nav__link">
1098         option
1099       </a>
1100     </li>
1101
1102
1103
1104
1105
1106
1107
1108     <li class="md-nav__item">
1109       <a href="../page/" class="md-nav__link">
1110         page
1111       </a>
1112     </li>
1113
1114
1115
1116
1117
1118
1119
1120     <li class="md-nav__item">
1121       <a href="../pip/" class="md-nav__link">
1122         pip
1123       </a>
1124     </li>
1125
1126
1127
1128
1129
1130
1131
1132     <li class="md-nav__item">
1133       <a href="../script/" class="md-nav__link">
1134         script
1135       </a>
1136     </li>
1137
1138
1139
1140
1141
1142
1143
1144     <li class="md-nav__item">
1145       <a href="../smiley/" class="md-nav__link">
1146         smiley
1147       </a>
1148     </li>
1149
1150
1151
1152
1153
1154
1155
1156     <li class="md-nav__item">
1157       <a href="../sql/" class="md-nav__link">
1158         sql
1159       </a>
1160     </li>
1161
1162
1163
1164
1165
1166
1167
1168     <li class="md-nav__item">
1169       <a href="../style/" class="md-nav__link">
1170         style
1171       </a>
1172     </li>
1173
1174
1175
1176
1177
1178
1179
1180     <li class="md-nav__item">
1181       <a href="../template/" class="md-nav__link">
1182         template
1183       </a>
1184     </li>
1185
1186
1187
1188
1189
1190
1191
1192     <li class="md-nav__item">
1193       <a href="../template-listener/" class="md-nav__link">
1194         templateListener
1195       </a>
1196     </li>
1197
1198
1199
1200
1201
1202
1203
1204     <li class="md-nav__item">
1205       <a href="../user-group-option/" class="md-nav__link">
1206         userGroupOption
1207       </a>
1208     </li>
1209
1210
1211
1212
1213
1214
1215
1216     <li class="md-nav__item">
1217       <a href="../user-menu/" class="md-nav__link">
1218         userMenu
1219       </a>
1220     </li>
1221
1222
1223
1224
1225
1226
1227
1228     <li class="md-nav__item">
1229       <a href="../user-notification-event/" class="md-nav__link">
1230         userNotificationEvent
1231       </a>
1232     </li>
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242     <li class="md-nav__item md-nav__item--active">
1243
1244       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1245
1246
1247
1248
1249         <label class="md-nav__link md-nav__link--active" for="__toc">
1250           userOption
1251           <span class="md-nav__icon md-icon"></span>
1252         </label>
1253
1254       <a href="./" class="md-nav__link md-nav__link--active">
1255         userOption
1256       </a>
1257
1258
1259 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1260
1261
1262
1263
1264
1265     <label class="md-nav__title" for="__toc">
1266       <span class="md-nav__icon md-icon"></span>
1267       Table of contents
1268     </label>
1269     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1270
1271         <li class="md-nav__item">
1272   <a href="#category-components" class="md-nav__link">
1273     Category Components
1274   </a>
1275
1276 </li>
1277
1278         <li class="md-nav__item">
1279   <a href="#option-components" class="md-nav__link">
1280     Option Components
1281   </a>
1282
1283     <nav class="md-nav" aria-label="Option Components">
1284       <ul class="md-nav__list">
1285
1286           <li class="md-nav__item">
1287   <a href="#required" class="md-nav__link">
1288     &lt;required&gt;
1289   </a>
1290
1291 </li>
1292
1293           <li class="md-nav__item">
1294   <a href="#askduringregistration" class="md-nav__link">
1295     &lt;askduringregistration&gt;
1296   </a>
1297
1298 </li>
1299
1300           <li class="md-nav__item">
1301   <a href="#editable" class="md-nav__link">
1302     &lt;editable&gt;
1303   </a>
1304
1305 </li>
1306
1307           <li class="md-nav__item">
1308   <a href="#visible" class="md-nav__link">
1309     &lt;visible&gt;
1310   </a>
1311
1312 </li>
1313
1314           <li class="md-nav__item">
1315   <a href="#searchable" class="md-nav__link">
1316     &lt;searchable&gt;
1317   </a>
1318
1319 </li>
1320
1321           <li class="md-nav__item">
1322   <a href="#outputclass" class="md-nav__link">
1323     &lt;outputclass&gt;
1324   </a>
1325
1326 </li>
1327
1328       </ul>
1329     </nav>
1330
1331 </li>
1332
1333         <li class="md-nav__item">
1334   <a href="#language-items" class="md-nav__link">
1335     Language Items
1336   </a>
1337
1338     <nav class="md-nav" aria-label="Language Items">
1339       <ul class="md-nav__list">
1340
1341           <li class="md-nav__item">
1342   <a href="#categories" class="md-nav__link">
1343     Categories
1344   </a>
1345
1346 </li>
1347
1348           <li class="md-nav__item">
1349   <a href="#options" class="md-nav__link">
1350     Options
1351   </a>
1352
1353 </li>
1354
1355       </ul>
1356     </nav>
1357
1358 </li>
1359
1360     </ul>
1361
1362 </nav>
1363
1364     </li>
1365
1366
1367
1368
1369
1370
1371
1372     <li class="md-nav__item">
1373       <a href="../user-profile-menu/" class="md-nav__link">
1374         userProfileMenu
1375       </a>
1376     </li>
1377
1378
1379
1380         </ul>
1381       </nav>
1382     </li>
1383
1384
1385
1386
1387
1388
1389
1390     <li class="md-nav__item">
1391       <a href="../../database-php-api/" class="md-nav__link">
1392         Database PHP API
1393       </a>
1394     </li>
1395
1396
1397
1398         </ul>
1399       </nav>
1400     </li>
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412     <li class="md-nav__item md-nav__item--nested">
1413
1414
1415         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1416
1417       <label class="md-nav__link" for="__nav_6">
1418         Migration
1419         <span class="md-nav__icon md-icon"></span>
1420       </label>
1421       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1422         <label class="md-nav__title" for="__nav_6">
1423           <span class="md-nav__icon md-icon"></span>
1424           Migration
1425         </label>
1426         <ul class="md-nav__list" data-md-scrollfix>
1427
1428
1429
1430
1431
1432
1433     <li class="md-nav__item md-nav__item--nested">
1434
1435
1436         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1437
1438       <label class="md-nav__link" for="__nav_6_1">
1439         Migrating from WSC 5.3
1440         <span class="md-nav__icon md-icon"></span>
1441       </label>
1442       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1443         <label class="md-nav__title" for="__nav_6_1">
1444           <span class="md-nav__icon md-icon"></span>
1445           Migrating from WSC 5.3
1446         </label>
1447         <ul class="md-nav__list" data-md-scrollfix>
1448
1449
1450
1451
1452
1453     <li class="md-nav__item">
1454       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1455         PHP API
1456       </a>
1457     </li>
1458
1459
1460
1461
1462
1463
1464
1465     <li class="md-nav__item">
1466       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1467         Session Handling and Authentication
1468       </a>
1469     </li>
1470
1471
1472
1473
1474
1475
1476
1477     <li class="md-nav__item">
1478       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1479         JavaScript
1480       </a>
1481     </li>
1482
1483
1484
1485
1486
1487
1488
1489     <li class="md-nav__item">
1490       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1491         Templates
1492       </a>
1493     </li>
1494
1495
1496
1497
1498
1499
1500
1501     <li class="md-nav__item">
1502       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1503         Third Party Libraries
1504       </a>
1505     </li>
1506
1507
1508
1509         </ul>
1510       </nav>
1511     </li>
1512
1513
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_2" type="checkbox" id="__nav_6_2" >
1524
1525       <label class="md-nav__link" for="__nav_6_2">
1526         Migrating from WSC 5.2
1527         <span class="md-nav__icon md-icon"></span>
1528       </label>
1529       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1530         <label class="md-nav__title" for="__nav_6_2">
1531           <span class="md-nav__icon md-icon"></span>
1532           Migrating from WSC 5.2
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/wsc52/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/wsc52/templates/" class="md-nav__link">
1554         Templates and Languages
1555       </a>
1556     </li>
1557
1558
1559
1560
1561
1562
1563
1564     <li class="md-nav__item">
1565       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1566         Third Party Libraries
1567       </a>
1568     </li>
1569
1570
1571
1572         </ul>
1573       </nav>
1574     </li>
1575
1576
1577
1578
1579
1580
1581
1582
1583     <li class="md-nav__item md-nav__item--nested">
1584
1585
1586         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1587
1588       <label class="md-nav__link" for="__nav_6_3">
1589         Migrating from WSC 3.1
1590         <span class="md-nav__icon md-icon"></span>
1591       </label>
1592       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1593         <label class="md-nav__title" for="__nav_6_3">
1594           <span class="md-nav__icon md-icon"></span>
1595           Migrating from WSC 3.1
1596         </label>
1597         <ul class="md-nav__list" data-md-scrollfix>
1598
1599
1600
1601
1602
1603     <li class="md-nav__item">
1604       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1605         PHP API
1606       </a>
1607     </li>
1608
1609
1610
1611         </ul>
1612       </nav>
1613     </li>
1614
1615
1616
1617
1618
1619
1620
1621
1622     <li class="md-nav__item md-nav__item--nested">
1623
1624
1625         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1626
1627       <label class="md-nav__link" for="__nav_6_4">
1628         Migrating from WSC 3.0
1629         <span class="md-nav__icon md-icon"></span>
1630       </label>
1631       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1632         <label class="md-nav__title" for="__nav_6_4">
1633           <span class="md-nav__icon md-icon"></span>
1634           Migrating from WSC 3.0
1635         </label>
1636         <ul class="md-nav__list" data-md-scrollfix>
1637
1638
1639
1640
1641
1642     <li class="md-nav__item">
1643       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1644         PHP API
1645       </a>
1646     </li>
1647
1648
1649
1650
1651
1652
1653
1654     <li class="md-nav__item">
1655       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1656         JavaScript API
1657       </a>
1658     </li>
1659
1660
1661
1662
1663
1664
1665
1666     <li class="md-nav__item">
1667       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1668         Templates
1669       </a>
1670     </li>
1671
1672
1673
1674
1675
1676
1677
1678     <li class="md-nav__item">
1679       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1680         CSS
1681       </a>
1682     </li>
1683
1684
1685
1686
1687
1688
1689
1690     <li class="md-nav__item">
1691       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1692         Package Components
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_5" type="checkbox" id="__nav_6_5" >
1713
1714       <label class="md-nav__link" for="__nav_6_5">
1715         Migrating from WCF 2.1
1716         <span class="md-nav__icon md-icon"></span>
1717       </label>
1718       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1719         <label class="md-nav__title" for="__nav_6_5">
1720           <span class="md-nav__icon md-icon"></span>
1721           Migrating from WCF 2.1
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/wcf21/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/wcf21/templates/" class="md-nav__link">
1743         Templates
1744       </a>
1745     </li>
1746
1747
1748
1749
1750
1751
1752
1753     <li class="md-nav__item">
1754       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1755         CSS
1756       </a>
1757     </li>
1758
1759
1760
1761
1762
1763
1764
1765     <li class="md-nav__item">
1766       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1767         Package Components
1768       </a>
1769     </li>
1770
1771
1772
1773         </ul>
1774       </nav>
1775     </li>
1776
1777
1778
1779         </ul>
1780       </nav>
1781     </li>
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793     <li class="md-nav__item md-nav__item--nested">
1794
1795
1796         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1797
1798       <label class="md-nav__link" for="__nav_7">
1799         Tutorials
1800         <span class="md-nav__icon md-icon"></span>
1801       </label>
1802       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1803         <label class="md-nav__title" for="__nav_7">
1804           <span class="md-nav__icon md-icon"></span>
1805           Tutorials
1806         </label>
1807         <ul class="md-nav__list" data-md-scrollfix>
1808
1809
1810
1811
1812
1813
1814     <li class="md-nav__item md-nav__item--nested">
1815
1816
1817         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1818
1819       <label class="md-nav__link" for="__nav_7_1">
1820         Tutorial Series
1821         <span class="md-nav__icon md-icon"></span>
1822       </label>
1823       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1824         <label class="md-nav__title" for="__nav_7_1">
1825           <span class="md-nav__icon md-icon"></span>
1826           Tutorial Series
1827         </label>
1828         <ul class="md-nav__list" data-md-scrollfix>
1829
1830
1831
1832
1833
1834     <li class="md-nav__item">
1835       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1836         Overview
1837       </a>
1838     </li>
1839
1840
1841
1842
1843
1844
1845
1846     <li class="md-nav__item">
1847       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1848         Part 1
1849       </a>
1850     </li>
1851
1852
1853
1854
1855
1856
1857
1858     <li class="md-nav__item">
1859       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1860         Part 2
1861       </a>
1862     </li>
1863
1864
1865
1866
1867
1868
1869
1870     <li class="md-nav__item">
1871       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1872         Part 3
1873       </a>
1874     </li>
1875
1876
1877
1878         </ul>
1879       </nav>
1880     </li>
1881
1882
1883
1884         </ul>
1885       </nav>
1886     </li>
1887
1888
1889
1890   </ul>
1891 </nav>
1892                   </div>
1893                 </div>
1894               </div>
1895
1896
1897
1898               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1899                 <div class="md-sidebar__scrollwrap">
1900                   <div class="md-sidebar__inner">
1901
1902 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1903
1904
1905
1906
1907
1908     <label class="md-nav__title" for="__toc">
1909       <span class="md-nav__icon md-icon"></span>
1910       Table of contents
1911     </label>
1912     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1913
1914         <li class="md-nav__item">
1915   <a href="#category-components" class="md-nav__link">
1916     Category Components
1917   </a>
1918
1919 </li>
1920
1921         <li class="md-nav__item">
1922   <a href="#option-components" class="md-nav__link">
1923     Option Components
1924   </a>
1925
1926     <nav class="md-nav" aria-label="Option Components">
1927       <ul class="md-nav__list">
1928
1929           <li class="md-nav__item">
1930   <a href="#required" class="md-nav__link">
1931     &lt;required&gt;
1932   </a>
1933
1934 </li>
1935
1936           <li class="md-nav__item">
1937   <a href="#askduringregistration" class="md-nav__link">
1938     &lt;askduringregistration&gt;
1939   </a>
1940
1941 </li>
1942
1943           <li class="md-nav__item">
1944   <a href="#editable" class="md-nav__link">
1945     &lt;editable&gt;
1946   </a>
1947
1948 </li>
1949
1950           <li class="md-nav__item">
1951   <a href="#visible" class="md-nav__link">
1952     &lt;visible&gt;
1953   </a>
1954
1955 </li>
1956
1957           <li class="md-nav__item">
1958   <a href="#searchable" class="md-nav__link">
1959     &lt;searchable&gt;
1960   </a>
1961
1962 </li>
1963
1964           <li class="md-nav__item">
1965   <a href="#outputclass" class="md-nav__link">
1966     &lt;outputclass&gt;
1967   </a>
1968
1969 </li>
1970
1971       </ul>
1972     </nav>
1973
1974 </li>
1975
1976         <li class="md-nav__item">
1977   <a href="#language-items" class="md-nav__link">
1978     Language Items
1979   </a>
1980
1981     <nav class="md-nav" aria-label="Language Items">
1982       <ul class="md-nav__list">
1983
1984           <li class="md-nav__item">
1985   <a href="#categories" class="md-nav__link">
1986     Categories
1987   </a>
1988
1989 </li>
1990
1991           <li class="md-nav__item">
1992   <a href="#options" class="md-nav__link">
1993     Options
1994   </a>
1995
1996 </li>
1997
1998       </ul>
1999     </nav>
2000
2001 </li>
2002
2003     </ul>
2004
2005 </nav>
2006                   </div>
2007                 </div>
2008               </div>
2009
2010
2011           <div class="md-content" data-md-component="content">
2012             <article class="md-content__inner md-typeset">
2013
2014
2015                   <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">
2016                     <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>
2017                   </a>
2018
2019
2020                 <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>
2021 <p>Registers new user options (profile fields / user settings).
2022 The behaviour of this package installation plugin closely follows the <a href="../option/">option</a> PIP.</p>
2023 <h2 id="category-components">Category Components<a class="headerlink" href="#category-components" title="Permanent link">#</a></h2>
2024 <p>The category definition works exactly like the option PIP.</p>
2025 <h2 id="option-components">Option Components<a class="headerlink" href="#option-components" title="Permanent link">#</a></h2>
2026 <p>The fields <code>hidden</code>, <code>supporti18n</code> and <code>requirei18n</code> do not apply.
2027 The following extra fields are defined:</p>
2028 <h3 id="required"><code>&lt;required&gt;</code><a class="headerlink" href="#required" title="Permanent link">#</a></h3>
2029 <p>Requires that a value is provided.</p>
2030 <h3 id="askduringregistration"><code>&lt;askduringregistration&gt;</code><a class="headerlink" href="#askduringregistration" title="Permanent link">#</a></h3>
2031 <p>If set to <code>1</code> the field is shown during user registration in the frontend.</p>
2032 <h3 id="editable"><code>&lt;editable&gt;</code><a class="headerlink" href="#editable" title="Permanent link">#</a></h3>
2033 <p>Bitfield with the following options (constants in <code>wcf\data\user\option\UserOption</code>)</p>
2034 <table>
2035 <thead>
2036 <tr>
2037 <th>Name</th>
2038 <th>Value</th>
2039 </tr>
2040 </thead>
2041 <tbody>
2042 <tr>
2043 <td>EDITABILITY_OWNER</td>
2044 <td>1</td>
2045 </tr>
2046 <tr>
2047 <td>EDITABILITY_ADMINISTRATOR</td>
2048 <td>2</td>
2049 </tr>
2050 <tr>
2051 <td>EDITABILITY_OWNER_DURING_REGISTRATION</td>
2052 <td>4</td>
2053 </tr>
2054 </tbody>
2055 </table>
2056 <h3 id="visible"><code>&lt;visible&gt;</code><a class="headerlink" href="#visible" title="Permanent link">#</a></h3>
2057 <p>Bitfield with the following options (constants in <code>wcf\data\user\option\UserOption</code>)</p>
2058 <table>
2059 <thead>
2060 <tr>
2061 <th>Name</th>
2062 <th>Value</th>
2063 </tr>
2064 </thead>
2065 <tbody>
2066 <tr>
2067 <td>VISIBILITY_OWNER</td>
2068 <td>1</td>
2069 </tr>
2070 <tr>
2071 <td>VISIBILITY_ADMINISTRATOR</td>
2072 <td>2</td>
2073 </tr>
2074 <tr>
2075 <td>VISIBILITY_REGISTERED</td>
2076 <td>4</td>
2077 </tr>
2078 <tr>
2079 <td>VISIBILITY_GUEST</td>
2080 <td>8</td>
2081 </tr>
2082 </tbody>
2083 </table>
2084 <h3 id="searchable"><code>&lt;searchable&gt;</code><a class="headerlink" href="#searchable" title="Permanent link">#</a></h3>
2085 <p>If set to <code>1</code> the field is searchable.</p>
2086 <h3 id="outputclass"><code>&lt;outputclass&gt;</code><a class="headerlink" href="#outputclass" title="Permanent link">#</a></h3>
2087 <p>PHP class responsible for output formatting of this field.
2088 the class has to implement the <code>wcf\system\option\user\IUserOptionOutput</code> interface.</p>
2089 <h2 id="language-items">Language Items<a class="headerlink" href="#language-items" title="Permanent link">#</a></h2>
2090 <p>All relevant language items have to be put into the <code>wcf.user.option</code> language item category.</p>
2091 <h3 id="categories">Categories<a class="headerlink" href="#categories" title="Permanent link">#</a></h3>
2092 <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.
2093 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>.
2094 Descriptions are only relevant for categories whose parent has a parent itself, i.e. categories on the third level.</p>
2095 <h3 id="options">Options<a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2096 <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.
2097 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>
2098
2099
2100
2101
2102 <hr>
2103 <div class="md-source-date">
2104   <small>
2105
2106       Last update: 2021-01-08
2107
2108   </small>
2109 </div>
2110
2111
2112
2113
2114
2115
2116
2117
2118             </article>
2119           </div>
2120         </div>
2121
2122       </main>
2123
2124
2125 <footer class="md-footer">
2126
2127     <nav class="md-footer__inner md-grid" aria-label="Footer">
2128
2129         <a href="../user-notification-event/" class="md-footer__link md-footer__link--prev" rel="prev">
2130           <div class="md-footer__button md-icon">
2131             <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>
2132           </div>
2133           <div class="md-footer__title">
2134             <div class="md-ellipsis">
2135               <span class="md-footer__direction">
2136                 Previous
2137               </span>
2138               userNotificationEvent
2139             </div>
2140           </div>
2141         </a>
2142
2143
2144         <a href="../user-profile-menu/" class="md-footer__link md-footer__link--next" rel="next">
2145           <div class="md-footer__title">
2146             <div class="md-ellipsis">
2147               <span class="md-footer__direction">
2148                 Next
2149               </span>
2150               userProfileMenu
2151             </div>
2152           </div>
2153           <div class="md-footer__button md-icon">
2154             <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>
2155           </div>
2156         </a>
2157
2158     </nav>
2159
2160   <div class="md-footer-meta md-typeset">
2161     <div class="md-footer-meta__inner md-grid">
2162       <div class="md-footer-copyright">
2163
2164           <div class="md-footer-copyright__highlight">
2165             Copyright © 2020 WoltLab GmbH
2166           </div>
2167
2168         Made with
2169         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2170           Material for MkDocs
2171         </a>
2172
2173       </div>
2174       <div class="md-footer-copyright">
2175         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2176         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2177 </div>
2178     </div>
2179   </div>
2180 </footer>
2181
2182     </div>
2183     <div class="md-dialog" data-md-component="dialog">
2184       <div class="md-dialog__inner md-typeset"></div>
2185     </div>
2186     <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>
2187
2188
2189       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2190
2191
2192   </body>
2193 </html>