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