6.0/php/api/form_builder/form_fields/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11         <link rel="canonical" href="https://docs.woltlab.com/6.0/php/api/form_builder/form_fields/">
  12
  13
  14         <link rel="prev" href="../structure/">
  15
  16
  17         <link rel="next" href="../validation_data/">
  18
  19       <link rel="icon" href="../../../../assets/default.favicon.ico">
  20       <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.8">
  21
  22
  23
  24         <title>Fields - WoltLab Suite Documentation</title>
  25
  26
  27
  28       <link rel="stylesheet" href="../../../../assets/stylesheets/main.ded33207.min.css">
  29
  30
  31         <link rel="stylesheet" href="../../../../assets/stylesheets/palette.a0c5b2b5.min.css">
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41       <link rel="stylesheet" href="../../../../stylesheets/extra.css">
  42
  43     <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  44
  45
  46
  47
  48
  49
  50   </head>
  51
  52
  53
  54
  55
  56
  57
  58     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  59
  60
  61
  62     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  63     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  64     <label class="md-overlay" for="__drawer"></label>
  65     <div data-md-component="skip">
  66
  67
  68         <a href="#form-builder-fields" class="md-skip">
  69           Skip to content
  70         </a>
  71
  72     </div>
  73     <div data-md-component="announce">
  74
  75         <aside class="md-banner">
  76           <div class="md-banner__inner md-grid md-typeset">
  77
  78
  79     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  80
  81           </div>
  82
  83         </aside>
  84
  85     </div>
  86
  87       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  88
  89       </div>
  90
  91
  92
  93
  94
  95
  96 <header class="md-header md-header--shadow" data-md-component="header">
  97   <nav class="md-header__inner md-grid" aria-label="Header">
  98     <a href="../../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  99
 100   <img src="../../../../assets/logo.png" alt="logo">
 101
 102     </a>
 103     <label class="md-header__button md-icon" for="__drawer">
 104       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 105     </label>
 106     <div class="md-header__title" data-md-component="header-title">
 107       <div class="md-header__ellipsis">
 108         <div class="md-header__topic">
 109           <span class="md-ellipsis">
 110             WoltLab Suite Documentation
 111           </span>
 112         </div>
 113         <div class="md-header__topic" data-md-component="header-topic">
 114           <span class="md-ellipsis">
 115
 116               Fields
 117
 118           </span>
 119         </div>
 120       </div>
 121     </div>
 122
 123
 124
 125
 126
 127       <label class="md-header__button md-icon" for="__search">
 128         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
 129       </label>
 130       <div class="md-search" data-md-component="search" role="dialog">
 131   <label class="md-search__overlay" for="__search"></label>
 132   <div class="md-search__inner" role="search">
 133     <form class="md-search__form" name="search">
 134       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
 135       <label class="md-search__icon md-icon" for="__search">
 136         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
 137         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
 138       </label>
 139       <nav class="md-search__options" aria-label="Search">
 140
 141         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 142           <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
 143         </button>
 144       </nav>
 145
 146     </form>
 147     <div class="md-search__output">
 148       <div class="md-search__scrollwrap" data-md-scrollfix>
 149         <div class="md-search-result" data-md-component="search-result">
 150           <div class="md-search-result__meta">
 151             Initializing search
 152           </div>
 153           <ol class="md-search-result__list" role="presentation"></ol>
 154         </div>
 155       </div>
 156     </div>
 157   </div>
 158 </div>
 159
 160
 161       <div class="md-header__source">
 162         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 163   <div class="md-source__icon md-icon">
 164
 165     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 166   </div>
 167   <div class="md-source__repository">
 168     GitHub
 169   </div>
 170 </a>
 171       </div>
 172
 173   </nav>
 174
 175 </header>
 176
 177     <div class="md-container" data-md-component="container">
 178
 179
 180
 181
 182
 183
 184       <main class="md-main" data-md-component="main">
 185         <div class="md-main__inner md-grid">
 186
 187
 188
 189               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 190                 <div class="md-sidebar__scrollwrap">
 191                   <div class="md-sidebar__inner">
 192
 193
 194
 195 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 196   <label class="md-nav__title" for="__drawer">
 197     <a href="../../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 198
 199   <img src="../../../../assets/logo.png" alt="logo">
 200
 201     </a>
 202     WoltLab Suite Documentation
 203   </label>
 204
 205     <div class="md-nav__source">
 206       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 207   <div class="md-source__icon md-icon">
 208
 209     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 210   </div>
 211   <div class="md-source__repository">
 212     GitHub
 213   </div>
 214 </a>
 215     </div>
 216
 217   <ul class="md-nav__list" data-md-scrollfix>
 218
 219
 220
 221
 222
 223
 224
 225
 226     <li class="md-nav__item">
 227       <a href="../../../../getting-started/" class="md-nav__link">
 228         Getting Started
 229       </a>
 230     </li>
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 245
 246
 247
 248
 249       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
 250
 251
 252
 253         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 254           PHP API
 255           <span class="md-nav__icon md-icon"></span>
 256         </label>
 257
 258       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
 259         <label class="md-nav__title" for="__nav_2">
 260           <span class="md-nav__icon md-icon"></span>
 261           PHP API
 262         </label>
 263         <ul class="md-nav__list" data-md-scrollfix>
 264
 265
 266
 267
 268
 269
 270     <li class="md-nav__item">
 271       <a href="../../../pages/" class="md-nav__link">
 272         Pages
 273       </a>
 274     </li>
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284     <li class="md-nav__item">
 285       <a href="../../../database-objects/" class="md-nav__link">
 286         Database Objects
 287       </a>
 288     </li>
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298     <li class="md-nav__item">
 299       <a href="../../../database-access/" class="md-nav__link">
 300         Database Access
 301       </a>
 302     </li>
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312     <li class="md-nav__item">
 313       <a href="../../../exceptions/" class="md-nav__link">
 314         Exceptions
 315       </a>
 316     </li>
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 330
 331
 332
 333
 334       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" checked>
 335
 336
 337
 338         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 339           API
 340           <span class="md-nav__icon md-icon"></span>
 341         </label>
 342
 343       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="true">
 344         <label class="md-nav__title" for="__nav_2_5">
 345           <span class="md-nav__icon md-icon"></span>
 346           API
 347         </label>
 348         <ul class="md-nav__list" data-md-scrollfix>
 349
 350
 351
 352
 353
 354
 355
 356     <li class="md-nav__item md-nav__item--nested">
 357
 358
 359
 360
 361       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 362
 363
 364
 365         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 366           Caches
 367           <span class="md-nav__icon md-icon"></span>
 368         </label>
 369
 370       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 371         <label class="md-nav__title" for="__nav_2_5_1">
 372           <span class="md-nav__icon md-icon"></span>
 373           Caches
 374         </label>
 375         <ul class="md-nav__list" data-md-scrollfix>
 376
 377
 378
 379
 380
 381
 382     <li class="md-nav__item">
 383       <a href="../../caches/" class="md-nav__link">
 384         Overview
 385       </a>
 386     </li>
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../../caches_persistent-caches/" class="md-nav__link">
 398         Persistent Caches
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410     <li class="md-nav__item">
 411       <a href="../../caches_runtime-caches/" class="md-nav__link">
 412         Runtime Caches
 413       </a>
 414     </li>
 415
 416
 417
 418
 419         </ul>
 420       </nav>
 421     </li>
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431     <li class="md-nav__item">
 432       <a href="../../comments/" class="md-nav__link">
 433         Comments
 434       </a>
 435     </li>
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445     <li class="md-nav__item">
 446       <a href="../../cronjobs/" class="md-nav__link">
 447         Cronjobs
 448       </a>
 449     </li>
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459     <li class="md-nav__item">
 460       <a href="../../events/" class="md-nav__link">
 461         Events
 462       </a>
 463     </li>
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 477
 478
 479
 480
 481       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" checked>
 482
 483
 484
 485         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 486           Form Builder
 487           <span class="md-nav__icon md-icon"></span>
 488         </label>
 489
 490       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="true">
 491         <label class="md-nav__title" for="__nav_2_5_5">
 492           <span class="md-nav__icon md-icon"></span>
 493           Form Builder
 494         </label>
 495         <ul class="md-nav__list" data-md-scrollfix>
 496
 497
 498
 499
 500
 501
 502     <li class="md-nav__item">
 503       <a href="../overview/" class="md-nav__link">
 504         Overview
 505       </a>
 506     </li>
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516     <li class="md-nav__item">
 517       <a href="../structure/" class="md-nav__link">
 518         Structure
 519       </a>
 520     </li>
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532     <li class="md-nav__item md-nav__item--active">
 533
 534       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
 535
 536
 537
 538
 539
 540         <label class="md-nav__link md-nav__link--active" for="__toc">
 541           Fields
 542           <span class="md-nav__icon md-icon"></span>
 543         </label>
 544
 545       <a href="./" class="md-nav__link md-nav__link--active">
 546         Fields
 547       </a>
 548
 549
 550
 551 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 552
 553
 554
 555
 556
 557
 558     <label class="md-nav__title" for="__toc">
 559       <span class="md-nav__icon md-icon"></span>
 560       Table of contents
 561     </label>
 562     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 563
 564         <li class="md-nav__item">
 565   <a href="#abstract-form-fields" class="md-nav__link">
 566     Abstract Form Fields
 567   </a>
 568
 569     <nav class="md-nav" aria-label="Abstract Form Fields">
 570       <ul class="md-nav__list">
 571
 572           <li class="md-nav__item">
 573   <a href="#abstractformfield" class="md-nav__link">
 574     AbstractFormField
 575   </a>
 576
 577 </li>
 578
 579           <li class="md-nav__item">
 580   <a href="#abstractnumericformfield" class="md-nav__link">
 581     AbstractNumericFormField
 582   </a>
 583
 584 </li>
 585
 586           <li class="md-nav__item">
 587   <a href="#abstractformfielddecorator" class="md-nav__link">
 588     AbstractFormFieldDecorator
 589   </a>
 590
 591 </li>
 592
 593       </ul>
 594     </nav>
 595
 596 </li>
 597
 598         <li class="md-nav__item">
 599   <a href="#general-form-fields" class="md-nav__link">
 600     General Form Fields
 601   </a>
 602
 603     <nav class="md-nav" aria-label="General Form Fields">
 604       <ul class="md-nav__list">
 605
 606           <li class="md-nav__item">
 607   <a href="#booleanformfield" class="md-nav__link">
 608     BooleanFormField
 609   </a>
 610
 611 </li>
 612
 613           <li class="md-nav__item">
 614   <a href="#checkboxformfield" class="md-nav__link">
 615     CheckboxFormField
 616   </a>
 617
 618 </li>
 619
 620           <li class="md-nav__item">
 621   <a href="#classnameformfield" class="md-nav__link">
 622     ClassNameFormField
 623   </a>
 624
 625 </li>
 626
 627           <li class="md-nav__item">
 628   <a href="#dateformfield" class="md-nav__link">
 629     DateFormField
 630   </a>
 631
 632 </li>
 633
 634           <li class="md-nav__item">
 635   <a href="#descriptionformfield" class="md-nav__link">
 636     DescriptionFormField
 637   </a>
 638
 639 </li>
 640
 641           <li class="md-nav__item">
 642   <a href="#emailformfield" class="md-nav__link">
 643     EmailFormField
 644   </a>
 645
 646 </li>
 647
 648           <li class="md-nav__item">
 649   <a href="#floatformfield" class="md-nav__link">
 650     FloatFormField
 651   </a>
 652
 653 </li>
 654
 655           <li class="md-nav__item">
 656   <a href="#hiddenformfield" class="md-nav__link">
 657     HiddenFormField
 658   </a>
 659
 660 </li>
 661
 662           <li class="md-nav__item">
 663   <a href="#iconformfield" class="md-nav__link">
 664     IconFormField
 665   </a>
 666
 667 </li>
 668
 669           <li class="md-nav__item">
 670   <a href="#integerformfield" class="md-nav__link">
 671     IntegerFormField
 672   </a>
 673
 674 </li>
 675
 676           <li class="md-nav__item">
 677   <a href="#isdisabledformfield" class="md-nav__link">
 678     IsDisabledFormField
 679   </a>
 680
 681 </li>
 682
 683           <li class="md-nav__item">
 684   <a href="#itemlistformfield" class="md-nav__link">
 685     ItemListFormField
 686   </a>
 687
 688 </li>
 689
 690           <li class="md-nav__item">
 691   <a href="#multilinetextformfield" class="md-nav__link">
 692     MultilineTextFormField
 693   </a>
 694
 695 </li>
 696
 697           <li class="md-nav__item">
 698   <a href="#multipleselectionformfield" class="md-nav__link">
 699     MultipleSelectionFormField
 700   </a>
 701
 702 </li>
 703
 704           <li class="md-nav__item">
 705   <a href="#radiobuttonformfield" class="md-nav__link">
 706     RadioButtonFormField
 707   </a>
 708
 709 </li>
 710
 711           <li class="md-nav__item">
 712   <a href="#ratingformfield" class="md-nav__link">
 713     RatingFormField
 714   </a>
 715
 716 </li>
 717
 718           <li class="md-nav__item">
 719   <a href="#showorderformfield" class="md-nav__link">
 720     ShowOrderFormField
 721   </a>
 722
 723 </li>
 724
 725           <li class="md-nav__item">
 726   <a href="#singleselectionformfield" class="md-nav__link">
 727     SingleSelectionFormField
 728   </a>
 729
 730 </li>
 731
 732           <li class="md-nav__item">
 733   <a href="#sortorderformfield" class="md-nav__link">
 734     SortOrderFormField
 735   </a>
 736
 737 </li>
 738
 739           <li class="md-nav__item">
 740   <a href="#textformfield" class="md-nav__link">
 741     TextFormField
 742   </a>
 743
 744 </li>
 745
 746           <li class="md-nav__item">
 747   <a href="#titleformfield" class="md-nav__link">
 748     TitleFormField
 749   </a>
 750
 751 </li>
 752
 753           <li class="md-nav__item">
 754   <a href="#urlformfield" class="md-nav__link">
 755     UrlFormField
 756   </a>
 757
 758 </li>
 759
 760       </ul>
 761     </nav>
 762
 763 </li>
 764
 765         <li class="md-nav__item">
 766   <a href="#specific-fields" class="md-nav__link">
 767     Specific Fields
 768   </a>
 769
 770     <nav class="md-nav" aria-label="Specific Fields">
 771       <ul class="md-nav__list">
 772
 773           <li class="md-nav__item">
 774   <a href="#aclformfield" class="md-nav__link">
 775     AclFormField
 776   </a>
 777
 778 </li>
 779
 780           <li class="md-nav__item">
 781   <a href="#buttonformfield" class="md-nav__link">
 782     ButtonFormField
 783   </a>
 784
 785 </li>
 786
 787           <li class="md-nav__item">
 788   <a href="#captchaformfield" class="md-nav__link">
 789     CaptchaFormField
 790   </a>
 791
 792 </li>
 793
 794           <li class="md-nav__item">
 795   <a href="#colorformfield" class="md-nav__link">
 796     ColorFormField
 797   </a>
 798
 799 </li>
 800
 801           <li class="md-nav__item">
 802   <a href="#contentlanguageformfield" class="md-nav__link">
 803     ContentLanguageFormField
 804   </a>
 805
 806 </li>
 807
 808           <li class="md-nav__item">
 809   <a href="#labelformfield" class="md-nav__link">
 810     LabelFormField
 811   </a>
 812
 813 </li>
 814
 815           <li class="md-nav__item">
 816   <a href="#optionformfield" class="md-nav__link">
 817     OptionFormField
 818   </a>
 819
 820 </li>
 821
 822           <li class="md-nav__item">
 823   <a href="#simpleaclformfield" class="md-nav__link">
 824     SimpleAclFormField
 825   </a>
 826
 827 </li>
 828
 829           <li class="md-nav__item">
 830   <a href="#singlemediaselectionformfield" class="md-nav__link">
 831     SingleMediaSelectionFormField
 832   </a>
 833
 834 </li>
 835
 836           <li class="md-nav__item">
 837   <a href="#tagformfield" class="md-nav__link">
 838     TagFormField
 839   </a>
 840
 841 </li>
 842
 843           <li class="md-nav__item">
 844   <a href="#uploadformfield" class="md-nav__link">
 845     UploadFormField
 846   </a>
 847
 848     <nav class="md-nav" aria-label="UploadFormField">
 849       <ul class="md-nav__list">
 850
 851           <li class="md-nav__item">
 852   <a href="#provide-value-from-database-object" class="md-nav__link">
 853     Provide value from database object
 854   </a>
 855
 856 </li>
 857
 858           <li class="md-nav__item">
 859   <a href="#process-files" class="md-nav__link">
 860     Process files
 861   </a>
 862
 863 </li>
 864
 865       </ul>
 866     </nav>
 867
 868 </li>
 869
 870           <li class="md-nav__item">
 871   <a href="#userformfield" class="md-nav__link">
 872     UserFormField
 873   </a>
 874
 875 </li>
 876
 877           <li class="md-nav__item">
 878   <a href="#userpasswordfield" class="md-nav__link">
 879     UserPasswordField
 880   </a>
 881
 882 </li>
 883
 884           <li class="md-nav__item">
 885   <a href="#usergroupoptionformfield" class="md-nav__link">
 886     UserGroupOptionFormField
 887   </a>
 888
 889 </li>
 890
 891           <li class="md-nav__item">
 892   <a href="#usernameformfield" class="md-nav__link">
 893     UsernameFormField
 894   </a>
 895
 896 </li>
 897
 898       </ul>
 899     </nav>
 900
 901 </li>
 902
 903         <li class="md-nav__item">
 904   <a href="#wysiwyg-form-container" class="md-nav__link">
 905     Wysiwyg form container
 906   </a>
 907
 908     <nav class="md-nav" aria-label="Wysiwyg form container">
 909       <ul class="md-nav__list">
 910
 911           <li class="md-nav__item">
 912   <a href="#wysiwygattachmentformfield" class="md-nav__link">
 913     WysiwygAttachmentFormField
 914   </a>
 915
 916 </li>
 917
 918           <li class="md-nav__item">
 919   <a href="#wysiwygpollformcontainer" class="md-nav__link">
 920     WysiwygPollFormContainer
 921   </a>
 922
 923 </li>
 924
 925           <li class="md-nav__item">
 926   <a href="#wysiwygsmileyformcontainer" class="md-nav__link">
 927     WysiwygSmileyFormContainer
 928   </a>
 929
 930     <nav class="md-nav" aria-label="WysiwygSmileyFormContainer">
 931       <ul class="md-nav__list">
 932
 933           <li class="md-nav__item">
 934   <a href="#wysiwygsmileyformnode" class="md-nav__link">
 935     WysiwygSmileyFormNode
 936   </a>
 937
 938 </li>
 939
 940       </ul>
 941     </nav>
 942
 943 </li>
 944
 945           <li class="md-nav__item">
 946   <a href="#example" class="md-nav__link">
 947     Example
 948   </a>
 949
 950 </li>
 951
 952           <li class="md-nav__item">
 953   <a href="#wysiwygformfield" class="md-nav__link">
 954     WysiwygFormField
 955   </a>
 956
 957 </li>
 958
 959           <li class="md-nav__item">
 960   <a href="#twysiwygformnode" class="md-nav__link">
 961     TWysiwygFormNode
 962   </a>
 963
 964 </li>
 965
 966       </ul>
 967     </nav>
 968
 969 </li>
 970
 971         <li class="md-nav__item">
 972   <a href="#application-specific-form-fields" class="md-nav__link">
 973     Application-Specific Form Fields
 974   </a>
 975
 976     <nav class="md-nav" aria-label="Application-Specific Form Fields">
 977       <ul class="md-nav__list">
 978
 979           <li class="md-nav__item">
 980   <a href="#woltlab-suite-forum" class="md-nav__link">
 981     WoltLab Suite Forum
 982   </a>
 983
 984     <nav class="md-nav" aria-label="WoltLab Suite Forum">
 985       <ul class="md-nav__list">
 986
 987           <li class="md-nav__item">
 988   <a href="#multipleboardselectionformfield" class="md-nav__link">
 989     MultipleBoardSelectionFormField
 990   </a>
 991
 992 </li>
 993
 994       </ul>
 995     </nav>
 996
 997 </li>
 998
 999       </ul>
1000     </nav>
1001
1002 </li>
1003
1004         <li class="md-nav__item">
1005   <a href="#single-use-form-fields" class="md-nav__link">
1006     Single-Use Form Fields
1007   </a>
1008
1009     <nav class="md-nav" aria-label="Single-Use Form Fields">
1010       <ul class="md-nav__list">
1011
1012           <li class="md-nav__item">
1013   <a href="#bbcodeattributesformfield" class="md-nav__link">
1014     BBCodeAttributesFormField
1015   </a>
1016
1017 </li>
1018
1019           <li class="md-nav__item">
1020   <a href="#devtoolsprojectexcludedpackagesformfield" class="md-nav__link">
1021     DevtoolsProjectExcludedPackagesFormField
1022   </a>
1023
1024 </li>
1025
1026           <li class="md-nav__item">
1027   <a href="#devtoolsprojectinstructionsformfield" class="md-nav__link">
1028     DevtoolsProjectInstructionsFormField
1029   </a>
1030
1031 </li>
1032
1033           <li class="md-nav__item">
1034   <a href="#devtoolsprojectoptionalpackagesformfield" class="md-nav__link">
1035     DevtoolsProjectOptionalPackagesFormField
1036   </a>
1037
1038 </li>
1039
1040           <li class="md-nav__item">
1041   <a href="#devtoolsprojectrequiredpackagesformfield" class="md-nav__link">
1042     DevtoolsProjectRequiredPackagesFormField
1043   </a>
1044
1045 </li>
1046
1047       </ul>
1048     </nav>
1049
1050 </li>
1051
1052     </ul>
1053
1054 </nav>
1055
1056     </li>
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066     <li class="md-nav__item">
1067       <a href="../validation_data/" class="md-nav__link">
1068         Validation and Data
1069       </a>
1070     </li>
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080     <li class="md-nav__item">
1081       <a href="../dependencies/" class="md-nav__link">
1082         Dependencies
1083       </a>
1084     </li>
1085
1086
1087
1088
1089         </ul>
1090       </nav>
1091     </li>
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101     <li class="md-nav__item">
1102       <a href="../../package_installation_plugins/" class="md-nav__link">
1103         Package Installation Plugins
1104       </a>
1105     </li>
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115     <li class="md-nav__item">
1116       <a href="../../user_activity_points/" class="md-nav__link">
1117         User Activity Points
1118       </a>
1119     </li>
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129     <li class="md-nav__item">
1130       <a href="../../user_notifications/" class="md-nav__link">
1131         User Notifications
1132       </a>
1133     </li>
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143     <li class="md-nav__item">
1144       <a href="../../sitemaps/" class="md-nav__link">
1145         Sitemaps
1146       </a>
1147     </li>
1148
1149
1150
1151
1152         </ul>
1153       </nav>
1154     </li>
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164     <li class="md-nav__item">
1165       <a href="../../../code-style/" class="md-nav__link">
1166         Code Style
1167       </a>
1168     </li>
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178     <li class="md-nav__item">
1179       <a href="../../../apps/" class="md-nav__link">
1180         Apps
1181       </a>
1182     </li>
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192     <li class="md-nav__item">
1193       <a href="../../../gdpr/" class="md-nav__link">
1194         GDPR
1195       </a>
1196     </li>
1197
1198
1199
1200
1201         </ul>
1202       </nav>
1203     </li>
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215     <li class="md-nav__item md-nav__item--nested">
1216
1217
1218
1219
1220       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
1221
1222
1223
1224         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
1225           Languages, Templates & CSS
1226           <span class="md-nav__icon md-icon"></span>
1227         </label>
1228
1229       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
1230         <label class="md-nav__title" for="__nav_3">
1231           <span class="md-nav__icon md-icon"></span>
1232           Languages, Templates & CSS
1233         </label>
1234         <ul class="md-nav__list" data-md-scrollfix>
1235
1236
1237
1238
1239
1240
1241     <li class="md-nav__item">
1242       <a href="../../../../view/languages/" class="md-nav__link">
1243         Languages
1244       </a>
1245     </li>
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255     <li class="md-nav__item">
1256       <a href="../../../../view/templates/" class="md-nav__link">
1257         Templates
1258       </a>
1259     </li>
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269     <li class="md-nav__item">
1270       <a href="../../../../view/template-plugins/" class="md-nav__link">
1271         Template Plugins
1272       </a>
1273     </li>
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283     <li class="md-nav__item">
1284       <a href="../../../../view/css/" class="md-nav__link">
1285         CSS
1286       </a>
1287     </li>
1288
1289
1290
1291
1292         </ul>
1293       </nav>
1294     </li>
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306     <li class="md-nav__item md-nav__item--nested">
1307
1308
1309
1310
1311       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
1312
1313
1314
1315         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
1316           TypeScript and JavaScript API
1317           <span class="md-nav__icon md-icon"></span>
1318         </label>
1319
1320       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
1321         <label class="md-nav__title" for="__nav_4">
1322           <span class="md-nav__icon md-icon"></span>
1323           TypeScript and JavaScript API
1324         </label>
1325         <ul class="md-nav__list" data-md-scrollfix>
1326
1327
1328
1329
1330
1331
1332     <li class="md-nav__item">
1333       <a href="../../../../javascript/general-usage/" class="md-nav__link">
1334         General Usage
1335       </a>
1336     </li>
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346     <li class="md-nav__item">
1347       <a href="../../../../javascript/typescript/" class="md-nav__link">
1348         TypeScript
1349       </a>
1350     </li>
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361     <li class="md-nav__item md-nav__item--nested">
1362
1363
1364
1365
1366       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
1367
1368
1369
1370         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
1371           Components
1372           <span class="md-nav__icon md-icon"></span>
1373         </label>
1374
1375       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
1376         <label class="md-nav__title" for="__nav_4_3">
1377           <span class="md-nav__icon md-icon"></span>
1378           Components
1379         </label>
1380         <ul class="md-nav__list" data-md-scrollfix>
1381
1382
1383
1384
1385
1386
1387     <li class="md-nav__item">
1388       <a href="../../../../javascript/components_confirmation/" class="md-nav__link">
1389         Confirmation
1390       </a>
1391     </li>
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401     <li class="md-nav__item">
1402       <a href="../../../../javascript/components_dialog/" class="md-nav__link">
1403         Dialog
1404       </a>
1405     </li>
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415     <li class="md-nav__item">
1416       <a href="../../../../javascript/components_google_maps/" class="md-nav__link">
1417         Google Maps
1418       </a>
1419     </li>
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429     <li class="md-nav__item">
1430       <a href="../../../../javascript/components_pagination/" class="md-nav__link">
1431         Pagination
1432       </a>
1433     </li>
1434
1435
1436
1437
1438         </ul>
1439       </nav>
1440     </li>
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451     <li class="md-nav__item md-nav__item--nested">
1452
1453
1454
1455
1456       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
1457
1458
1459
1460         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
1461           New API
1462           <span class="md-nav__icon md-icon"></span>
1463         </label>
1464
1465       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
1466         <label class="md-nav__title" for="__nav_4_4">
1467           <span class="md-nav__icon md-icon"></span>
1468           New API
1469         </label>
1470         <ul class="md-nav__list" data-md-scrollfix>
1471
1472
1473
1474
1475
1476
1477     <li class="md-nav__item">
1478       <a href="../../../../javascript/new-api_writing-a-module/" class="md-nav__link">
1479         Writing a module
1480       </a>
1481     </li>
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491     <li class="md-nav__item">
1492       <a href="../../../../javascript/new-api_core/" class="md-nav__link">
1493         Core Functions
1494       </a>
1495     </li>
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505     <li class="md-nav__item">
1506       <a href="../../../../javascript/new-api_dom/" class="md-nav__link">
1507         DOM
1508       </a>
1509     </li>
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519     <li class="md-nav__item">
1520       <a href="../../../../javascript/new-api_events/" class="md-nav__link">
1521         Event Handling
1522       </a>
1523     </li>
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533     <li class="md-nav__item">
1534       <a href="../../../../javascript/new-api_ajax/" class="md-nav__link">
1535         Ajax
1536       </a>
1537     </li>
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547     <li class="md-nav__item">
1548       <a href="../../../../javascript/new-api_dialogs/" class="md-nav__link">
1549         Dialogs
1550       </a>
1551     </li>
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561     <li class="md-nav__item">
1562       <a href="../../../../javascript/new-api_browser/" class="md-nav__link">
1563         Browser and Screen Sizes
1564       </a>
1565     </li>
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575     <li class="md-nav__item">
1576       <a href="../../../../javascript/new-api_ui/" class="md-nav__link">
1577         User Interface
1578       </a>
1579     </li>
1580
1581
1582
1583
1584         </ul>
1585       </nav>
1586     </li>
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596     <li class="md-nav__item">
1597       <a href="../../../../javascript/legacy-api/" class="md-nav__link">
1598         Legacy API
1599       </a>
1600     </li>
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610     <li class="md-nav__item">
1611       <a href="../../../../javascript/code-snippets/" class="md-nav__link">
1612         Code Snippets
1613       </a>
1614     </li>
1615
1616
1617
1618
1619         </ul>
1620       </nav>
1621     </li>
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633     <li class="md-nav__item md-nav__item--nested">
1634
1635
1636
1637
1638       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1639
1640
1641
1642         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1643           Package Components
1644           <span class="md-nav__icon md-icon"></span>
1645         </label>
1646
1647       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1648         <label class="md-nav__title" for="__nav_5">
1649           <span class="md-nav__icon md-icon"></span>
1650           Package Components
1651         </label>
1652         <ul class="md-nav__list" data-md-scrollfix>
1653
1654
1655
1656
1657
1658
1659     <li class="md-nav__item">
1660       <a href="../../../../package/package-xml/" class="md-nav__link">
1661         package.xml
1662       </a>
1663     </li>
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674     <li class="md-nav__item md-nav__item--nested">
1675
1676
1677
1678
1679       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1680
1681
1682
1683         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1684           PIPs
1685           <span class="md-nav__icon md-icon"></span>
1686         </label>
1687
1688       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1689         <label class="md-nav__title" for="__nav_5_2">
1690           <span class="md-nav__icon md-icon"></span>
1691           PIPs
1692         </label>
1693         <ul class="md-nav__list" data-md-scrollfix>
1694
1695
1696
1697
1698
1699
1700     <li class="md-nav__item">
1701       <a href="../../../../package/pip/" class="md-nav__link">
1702         Overview
1703       </a>
1704     </li>
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714     <li class="md-nav__item">
1715       <a href="../../../../package/pip/acl-option/" class="md-nav__link">
1716         aclOption
1717       </a>
1718     </li>
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728     <li class="md-nav__item">
1729       <a href="../../../../package/pip/acp-menu/" class="md-nav__link">
1730         acpMenu
1731       </a>
1732     </li>
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742     <li class="md-nav__item">
1743       <a href="../../../../package/pip/acp-search-provider/" class="md-nav__link">
1744         acpSearchProvider
1745       </a>
1746     </li>
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756     <li class="md-nav__item">
1757       <a href="../../../../package/pip/acp-template/" class="md-nav__link">
1758         acpTemplate
1759       </a>
1760     </li>
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770     <li class="md-nav__item">
1771       <a href="../../../../package/pip/acp-template-delete/" class="md-nav__link">
1772         acpTemplateDelete
1773       </a>
1774     </li>
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784     <li class="md-nav__item">
1785       <a href="../../../../package/pip/bbcode/" class="md-nav__link">
1786         bbcode
1787       </a>
1788     </li>
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798     <li class="md-nav__item">
1799       <a href="../../../../package/pip/box/" class="md-nav__link">
1800         box
1801       </a>
1802     </li>
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812     <li class="md-nav__item">
1813       <a href="../../../../package/pip/clipboard-action/" class="md-nav__link">
1814         clipboardAction
1815       </a>
1816     </li>
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826     <li class="md-nav__item">
1827       <a href="../../../../package/pip/core-object/" class="md-nav__link">
1828         coreObject
1829       </a>
1830     </li>
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840     <li class="md-nav__item">
1841       <a href="../../../../package/pip/cronjob/" class="md-nav__link">
1842         cronjob
1843       </a>
1844     </li>
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854     <li class="md-nav__item">
1855       <a href="../../../../package/pip/database/" class="md-nav__link">
1856         database
1857       </a>
1858     </li>
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868     <li class="md-nav__item">
1869       <a href="../../../../package/pip/event-listener/" class="md-nav__link">
1870         eventListener
1871       </a>
1872     </li>
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882     <li class="md-nav__item">
1883       <a href="../../../../package/pip/file/" class="md-nav__link">
1884         file
1885       </a>
1886     </li>
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896     <li class="md-nav__item">
1897       <a href="../../../../package/pip/file-delete/" class="md-nav__link">
1898         fileDelete
1899       </a>
1900     </li>
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910     <li class="md-nav__item">
1911       <a href="../../../../package/pip/language/" class="md-nav__link">
1912         language
1913       </a>
1914     </li>
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924     <li class="md-nav__item">
1925       <a href="../../../../package/pip/media-provider/" class="md-nav__link">
1926         mediaProvider
1927       </a>
1928     </li>
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938     <li class="md-nav__item">
1939       <a href="../../../../package/pip/menu/" class="md-nav__link">
1940         menu
1941       </a>
1942     </li>
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952     <li class="md-nav__item">
1953       <a href="../../../../package/pip/menu-item/" class="md-nav__link">
1954         menuItem
1955       </a>
1956     </li>
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966     <li class="md-nav__item">
1967       <a href="../../../../package/pip/object-type/" class="md-nav__link">
1968         objectType
1969       </a>
1970     </li>
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980     <li class="md-nav__item">
1981       <a href="../../../../package/pip/object-type-definition/" class="md-nav__link">
1982         objectTypeDefinition
1983       </a>
1984     </li>
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994     <li class="md-nav__item">
1995       <a href="../../../../package/pip/option/" class="md-nav__link">
1996         option
1997       </a>
1998     </li>
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008     <li class="md-nav__item">
2009       <a href="../../../../package/pip/page/" class="md-nav__link">
2010         page
2011       </a>
2012     </li>
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022     <li class="md-nav__item">
2023       <a href="../../../../package/pip/pip/" class="md-nav__link">
2024         pip
2025       </a>
2026     </li>
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036     <li class="md-nav__item">
2037       <a href="../../../../package/pip/script/" class="md-nav__link">
2038         script
2039       </a>
2040     </li>
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050     <li class="md-nav__item">
2051       <a href="../../../../package/pip/smiley/" class="md-nav__link">
2052         smiley
2053       </a>
2054     </li>
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064     <li class="md-nav__item">
2065       <a href="../../../../package/pip/sql/" class="md-nav__link">
2066         sql
2067       </a>
2068     </li>
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078     <li class="md-nav__item">
2079       <a href="../../../../package/pip/style/" class="md-nav__link">
2080         style
2081       </a>
2082     </li>
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092     <li class="md-nav__item">
2093       <a href="../../../../package/pip/template/" class="md-nav__link">
2094         template
2095       </a>
2096     </li>
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106     <li class="md-nav__item">
2107       <a href="../../../../package/pip/template-delete/" class="md-nav__link">
2108         templateDelete
2109       </a>
2110     </li>
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120     <li class="md-nav__item">
2121       <a href="../../../../package/pip/template-listener/" class="md-nav__link">
2122         templateListener
2123       </a>
2124     </li>
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134     <li class="md-nav__item">
2135       <a href="../../../../package/pip/user-group-option/" class="md-nav__link">
2136         userGroupOption
2137       </a>
2138     </li>
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148     <li class="md-nav__item">
2149       <a href="../../../../package/pip/user-menu/" class="md-nav__link">
2150         userMenu
2151       </a>
2152     </li>
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162     <li class="md-nav__item">
2163       <a href="../../../../package/pip/user-notification-event/" class="md-nav__link">
2164         userNotificationEvent
2165       </a>
2166     </li>
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176     <li class="md-nav__item">
2177       <a href="../../../../package/pip/user-option/" class="md-nav__link">
2178         userOption
2179       </a>
2180     </li>
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190     <li class="md-nav__item">
2191       <a href="../../../../package/pip/user-profile-menu/" class="md-nav__link">
2192         userProfileMenu
2193       </a>
2194     </li>
2195
2196
2197
2198
2199         </ul>
2200       </nav>
2201     </li>
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211     <li class="md-nav__item">
2212       <a href="../../../../package/database-php-api/" class="md-nav__link">
2213         Database PHP API
2214       </a>
2215     </li>
2216
2217
2218
2219
2220         </ul>
2221       </nav>
2222     </li>
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234     <li class="md-nav__item md-nav__item--nested">
2235
2236
2237
2238
2239       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
2240
2241
2242
2243         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
2244           Migration
2245           <span class="md-nav__icon md-icon"></span>
2246         </label>
2247
2248       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
2249         <label class="md-nav__title" for="__nav_6">
2250           <span class="md-nav__icon md-icon"></span>
2251           Migration
2252         </label>
2253         <ul class="md-nav__list" data-md-scrollfix>
2254
2255
2256
2257
2258
2259
2260
2261     <li class="md-nav__item md-nav__item--nested">
2262
2263
2264
2265
2266       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
2267
2268
2269
2270         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
2271           From WoltLab Suite 5.5
2272           <span class="md-nav__icon md-icon"></span>
2273         </label>
2274
2275       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
2276         <label class="md-nav__title" for="__nav_6_1">
2277           <span class="md-nav__icon md-icon"></span>
2278           From WoltLab Suite 5.5
2279         </label>
2280         <ul class="md-nav__list" data-md-scrollfix>
2281
2282
2283
2284
2285
2286
2287     <li class="md-nav__item">
2288       <a href="../../../../migration/wsc55/php/" class="md-nav__link">
2289         PHP API
2290       </a>
2291     </li>
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301     <li class="md-nav__item">
2302       <a href="../../../../migration/wsc55/javascript/" class="md-nav__link">
2303         TypeScript and JavaScript
2304       </a>
2305     </li>
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315     <li class="md-nav__item">
2316       <a href="../../../../migration/wsc55/templates/" class="md-nav__link">
2317         Templates
2318       </a>
2319     </li>
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329     <li class="md-nav__item">
2330       <a href="../../../../migration/wsc55/icons/" class="md-nav__link">
2331         Icons
2332       </a>
2333     </li>
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343     <li class="md-nav__item">
2344       <a href="../../../../migration/wsc55/dialogs/" class="md-nav__link">
2345         Dialogs
2346       </a>
2347     </li>
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357     <li class="md-nav__item">
2358       <a href="../../../../migration/wsc55/libraries/" class="md-nav__link">
2359         Third Party Libraries
2360       </a>
2361     </li>
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371     <li class="md-nav__item">
2372       <a href="../../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
2373         Deprecations and Removals
2374       </a>
2375     </li>
2376
2377
2378
2379
2380         </ul>
2381       </nav>
2382     </li>
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393     <li class="md-nav__item md-nav__item--nested">
2394
2395
2396
2397
2398       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
2399
2400
2401
2402         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
2403           From WoltLab Suite 5.4
2404           <span class="md-nav__icon md-icon"></span>
2405         </label>
2406
2407       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
2408         <label class="md-nav__title" for="__nav_6_2">
2409           <span class="md-nav__icon md-icon"></span>
2410           From WoltLab Suite 5.4
2411         </label>
2412         <ul class="md-nav__list" data-md-scrollfix>
2413
2414
2415
2416
2417
2418
2419     <li class="md-nav__item">
2420       <a href="../../../../migration/wsc54/php/" class="md-nav__link">
2421         PHP API
2422       </a>
2423     </li>
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433     <li class="md-nav__item">
2434       <a href="../../../../migration/wsc54/javascript/" class="md-nav__link">
2435         TypeScript and JavaScript
2436       </a>
2437     </li>
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447     <li class="md-nav__item">
2448       <a href="../../../../migration/wsc54/templates/" class="md-nav__link">
2449         Templates
2450       </a>
2451     </li>
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461     <li class="md-nav__item">
2462       <a href="../../../../migration/wsc54/libraries/" class="md-nav__link">
2463         Third Party Libraries
2464       </a>
2465     </li>
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475     <li class="md-nav__item">
2476       <a href="../../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2477         Deprecations and Removals
2478       </a>
2479     </li>
2480
2481
2482
2483
2484         </ul>
2485       </nav>
2486     </li>
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497     <li class="md-nav__item md-nav__item--nested">
2498
2499
2500
2501
2502       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2503
2504
2505
2506         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2507           From WoltLab Suite 5.3
2508           <span class="md-nav__icon md-icon"></span>
2509         </label>
2510
2511       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2512         <label class="md-nav__title" for="__nav_6_3">
2513           <span class="md-nav__icon md-icon"></span>
2514           From WoltLab Suite 5.3
2515         </label>
2516         <ul class="md-nav__list" data-md-scrollfix>
2517
2518
2519
2520
2521
2522
2523     <li class="md-nav__item">
2524       <a href="../../../../migration/wsc53/php/" class="md-nav__link">
2525         PHP API
2526       </a>
2527     </li>
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537     <li class="md-nav__item">
2538       <a href="../../../../migration/wsc53/session/" class="md-nav__link">
2539         Session Handling and Authentication
2540       </a>
2541     </li>
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551     <li class="md-nav__item">
2552       <a href="../../../../migration/wsc53/javascript/" class="md-nav__link">
2553         TypeScript and JavaScript
2554       </a>
2555     </li>
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565     <li class="md-nav__item">
2566       <a href="../../../../migration/wsc53/templates/" class="md-nav__link">
2567         Templates
2568       </a>
2569     </li>
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579     <li class="md-nav__item">
2580       <a href="../../../../migration/wsc53/libraries/" class="md-nav__link">
2581         Third Party Libraries
2582       </a>
2583     </li>
2584
2585
2586
2587
2588         </ul>
2589       </nav>
2590     </li>
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601     <li class="md-nav__item md-nav__item--nested">
2602
2603
2604
2605
2606       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2607
2608
2609
2610         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2611           From WoltLab Suite 5.2
2612           <span class="md-nav__icon md-icon"></span>
2613         </label>
2614
2615       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2616         <label class="md-nav__title" for="__nav_6_4">
2617           <span class="md-nav__icon md-icon"></span>
2618           From WoltLab Suite 5.2
2619         </label>
2620         <ul class="md-nav__list" data-md-scrollfix>
2621
2622
2623
2624
2625
2626
2627     <li class="md-nav__item">
2628       <a href="../../../../migration/wsc52/php/" class="md-nav__link">
2629         PHP API
2630       </a>
2631     </li>
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641     <li class="md-nav__item">
2642       <a href="../../../../migration/wsc52/templates/" class="md-nav__link">
2643         Templates and Languages
2644       </a>
2645     </li>
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655     <li class="md-nav__item">
2656       <a href="../../../../migration/wsc52/libraries/" class="md-nav__link">
2657         Third Party Libraries
2658       </a>
2659     </li>
2660
2661
2662
2663
2664         </ul>
2665       </nav>
2666     </li>
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677     <li class="md-nav__item md-nav__item--nested">
2678
2679
2680
2681
2682       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2683
2684
2685
2686         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2687           From WoltLab Suite 3.1
2688           <span class="md-nav__icon md-icon"></span>
2689         </label>
2690
2691       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2692         <label class="md-nav__title" for="__nav_6_5">
2693           <span class="md-nav__icon md-icon"></span>
2694           From WoltLab Suite 3.1
2695         </label>
2696         <ul class="md-nav__list" data-md-scrollfix>
2697
2698
2699
2700
2701
2702
2703     <li class="md-nav__item">
2704       <a href="../../../../migration/wsc31/php/" class="md-nav__link">
2705         PHP API
2706       </a>
2707     </li>
2708
2709
2710
2711
2712         </ul>
2713       </nav>
2714     </li>
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725     <li class="md-nav__item md-nav__item--nested">
2726
2727
2728
2729
2730       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2731
2732
2733
2734         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2735           From WoltLab Suite 3.0
2736           <span class="md-nav__icon md-icon"></span>
2737         </label>
2738
2739       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2740         <label class="md-nav__title" for="__nav_6_6">
2741           <span class="md-nav__icon md-icon"></span>
2742           From WoltLab Suite 3.0
2743         </label>
2744         <ul class="md-nav__list" data-md-scrollfix>
2745
2746
2747
2748
2749
2750
2751     <li class="md-nav__item">
2752       <a href="../../../../migration/wsc30/php/" class="md-nav__link">
2753         PHP API
2754       </a>
2755     </li>
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765     <li class="md-nav__item">
2766       <a href="../../../../migration/wsc30/javascript/" class="md-nav__link">
2767         JavaScript API
2768       </a>
2769     </li>
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779     <li class="md-nav__item">
2780       <a href="../../../../migration/wsc30/templates/" class="md-nav__link">
2781         Templates
2782       </a>
2783     </li>
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793     <li class="md-nav__item">
2794       <a href="../../../../migration/wsc30/css/" class="md-nav__link">
2795         CSS
2796       </a>
2797     </li>
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807     <li class="md-nav__item">
2808       <a href="../../../../migration/wsc30/package/" class="md-nav__link">
2809         Package Components
2810       </a>
2811     </li>
2812
2813
2814
2815
2816         </ul>
2817       </nav>
2818     </li>
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829     <li class="md-nav__item md-nav__item--nested">
2830
2831
2832
2833
2834       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2835
2836
2837
2838         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2839           From WCF 2.1
2840           <span class="md-nav__icon md-icon"></span>
2841         </label>
2842
2843       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2844         <label class="md-nav__title" for="__nav_6_7">
2845           <span class="md-nav__icon md-icon"></span>
2846           From WCF 2.1
2847         </label>
2848         <ul class="md-nav__list" data-md-scrollfix>
2849
2850
2851
2852
2853
2854
2855     <li class="md-nav__item">
2856       <a href="../../../../migration/wcf21/php/" class="md-nav__link">
2857         PHP API
2858       </a>
2859     </li>
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869     <li class="md-nav__item">
2870       <a href="../../../../migration/wcf21/templates/" class="md-nav__link">
2871         Templates
2872       </a>
2873     </li>
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883     <li class="md-nav__item">
2884       <a href="../../../../migration/wcf21/css/" class="md-nav__link">
2885         CSS
2886       </a>
2887     </li>
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897     <li class="md-nav__item">
2898       <a href="../../../../migration/wcf21/package/" class="md-nav__link">
2899         Package Components
2900       </a>
2901     </li>
2902
2903
2904
2905
2906         </ul>
2907       </nav>
2908     </li>
2909
2910
2911
2912
2913         </ul>
2914       </nav>
2915     </li>
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927     <li class="md-nav__item md-nav__item--nested">
2928
2929
2930
2931
2932       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2933
2934
2935
2936         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2937           Tutorials
2938           <span class="md-nav__icon md-icon"></span>
2939         </label>
2940
2941       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2942         <label class="md-nav__title" for="__nav_7">
2943           <span class="md-nav__icon md-icon"></span>
2944           Tutorials
2945         </label>
2946         <ul class="md-nav__list" data-md-scrollfix>
2947
2948
2949
2950
2951
2952
2953
2954     <li class="md-nav__item md-nav__item--nested">
2955
2956
2957
2958
2959       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2960
2961
2962
2963         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2964           Tutorial Series
2965           <span class="md-nav__icon md-icon"></span>
2966         </label>
2967
2968       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2969         <label class="md-nav__title" for="__nav_7_1">
2970           <span class="md-nav__icon md-icon"></span>
2971           Tutorial Series
2972         </label>
2973         <ul class="md-nav__list" data-md-scrollfix>
2974
2975
2976
2977
2978
2979
2980     <li class="md-nav__item">
2981       <a href="../../../../tutorial/series/overview/" class="md-nav__link">
2982         Overview
2983       </a>
2984     </li>
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994     <li class="md-nav__item">
2995       <a href="../../../../tutorial/series/part_1/" class="md-nav__link">
2996         Part 1
2997       </a>
2998     </li>
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008     <li class="md-nav__item">
3009       <a href="../../../../tutorial/series/part_2/" class="md-nav__link">
3010         Part 2
3011       </a>
3012     </li>
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022     <li class="md-nav__item">
3023       <a href="../../../../tutorial/series/part_3/" class="md-nav__link">
3024         Part 3
3025       </a>
3026     </li>
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036     <li class="md-nav__item">
3037       <a href="../../../../tutorial/series/part_4/" class="md-nav__link">
3038         Part 4
3039       </a>
3040     </li>
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050     <li class="md-nav__item">
3051       <a href="../../../../tutorial/series/part_5/" class="md-nav__link">
3052         Part 5
3053       </a>
3054     </li>
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064     <li class="md-nav__item">
3065       <a href="../../../../tutorial/series/part_6/" class="md-nav__link">
3066         Part 6
3067       </a>
3068     </li>
3069
3070
3071
3072
3073         </ul>
3074       </nav>
3075     </li>
3076
3077
3078
3079
3080         </ul>
3081       </nav>
3082     </li>
3083
3084
3085
3086   </ul>
3087 </nav>
3088                   </div>
3089                 </div>
3090               </div>
3091
3092
3093
3094               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
3095                 <div class="md-sidebar__scrollwrap">
3096                   <div class="md-sidebar__inner">
3097
3098
3099 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
3100
3101
3102
3103
3104
3105
3106     <label class="md-nav__title" for="__toc">
3107       <span class="md-nav__icon md-icon"></span>
3108       Table of contents
3109     </label>
3110     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
3111
3112         <li class="md-nav__item">
3113   <a href="#abstract-form-fields" class="md-nav__link">
3114     Abstract Form Fields
3115   </a>
3116
3117     <nav class="md-nav" aria-label="Abstract Form Fields">
3118       <ul class="md-nav__list">
3119
3120           <li class="md-nav__item">
3121   <a href="#abstractformfield" class="md-nav__link">
3122     AbstractFormField
3123   </a>
3124
3125 </li>
3126
3127           <li class="md-nav__item">
3128   <a href="#abstractnumericformfield" class="md-nav__link">
3129     AbstractNumericFormField
3130   </a>
3131
3132 </li>
3133
3134           <li class="md-nav__item">
3135   <a href="#abstractformfielddecorator" class="md-nav__link">
3136     AbstractFormFieldDecorator
3137   </a>
3138
3139 </li>
3140
3141       </ul>
3142     </nav>
3143
3144 </li>
3145
3146         <li class="md-nav__item">
3147   <a href="#general-form-fields" class="md-nav__link">
3148     General Form Fields
3149   </a>
3150
3151     <nav class="md-nav" aria-label="General Form Fields">
3152       <ul class="md-nav__list">
3153
3154           <li class="md-nav__item">
3155   <a href="#booleanformfield" class="md-nav__link">
3156     BooleanFormField
3157   </a>
3158
3159 </li>
3160
3161           <li class="md-nav__item">
3162   <a href="#checkboxformfield" class="md-nav__link">
3163     CheckboxFormField
3164   </a>
3165
3166 </li>
3167
3168           <li class="md-nav__item">
3169   <a href="#classnameformfield" class="md-nav__link">
3170     ClassNameFormField
3171   </a>
3172
3173 </li>
3174
3175           <li class="md-nav__item">
3176   <a href="#dateformfield" class="md-nav__link">
3177     DateFormField
3178   </a>
3179
3180 </li>
3181
3182           <li class="md-nav__item">
3183   <a href="#descriptionformfield" class="md-nav__link">
3184     DescriptionFormField
3185   </a>
3186
3187 </li>
3188
3189           <li class="md-nav__item">
3190   <a href="#emailformfield" class="md-nav__link">
3191     EmailFormField
3192   </a>
3193
3194 </li>
3195
3196           <li class="md-nav__item">
3197   <a href="#floatformfield" class="md-nav__link">
3198     FloatFormField
3199   </a>
3200
3201 </li>
3202
3203           <li class="md-nav__item">
3204   <a href="#hiddenformfield" class="md-nav__link">
3205     HiddenFormField
3206   </a>
3207
3208 </li>
3209
3210           <li class="md-nav__item">
3211   <a href="#iconformfield" class="md-nav__link">
3212     IconFormField
3213   </a>
3214
3215 </li>
3216
3217           <li class="md-nav__item">
3218   <a href="#integerformfield" class="md-nav__link">
3219     IntegerFormField
3220   </a>
3221
3222 </li>
3223
3224           <li class="md-nav__item">
3225   <a href="#isdisabledformfield" class="md-nav__link">
3226     IsDisabledFormField
3227   </a>
3228
3229 </li>
3230
3231           <li class="md-nav__item">
3232   <a href="#itemlistformfield" class="md-nav__link">
3233     ItemListFormField
3234   </a>
3235
3236 </li>
3237
3238           <li class="md-nav__item">
3239   <a href="#multilinetextformfield" class="md-nav__link">
3240     MultilineTextFormField
3241   </a>
3242
3243 </li>
3244
3245           <li class="md-nav__item">
3246   <a href="#multipleselectionformfield" class="md-nav__link">
3247     MultipleSelectionFormField
3248   </a>
3249
3250 </li>
3251
3252           <li class="md-nav__item">
3253   <a href="#radiobuttonformfield" class="md-nav__link">
3254     RadioButtonFormField
3255   </a>
3256
3257 </li>
3258
3259           <li class="md-nav__item">
3260   <a href="#ratingformfield" class="md-nav__link">
3261     RatingFormField
3262   </a>
3263
3264 </li>
3265
3266           <li class="md-nav__item">
3267   <a href="#showorderformfield" class="md-nav__link">
3268     ShowOrderFormField
3269   </a>
3270
3271 </li>
3272
3273           <li class="md-nav__item">
3274   <a href="#singleselectionformfield" class="md-nav__link">
3275     SingleSelectionFormField
3276   </a>
3277
3278 </li>
3279
3280           <li class="md-nav__item">
3281   <a href="#sortorderformfield" class="md-nav__link">
3282     SortOrderFormField
3283   </a>
3284
3285 </li>
3286
3287           <li class="md-nav__item">
3288   <a href="#textformfield" class="md-nav__link">
3289     TextFormField
3290   </a>
3291
3292 </li>
3293
3294           <li class="md-nav__item">
3295   <a href="#titleformfield" class="md-nav__link">
3296     TitleFormField
3297   </a>
3298
3299 </li>
3300
3301           <li class="md-nav__item">
3302   <a href="#urlformfield" class="md-nav__link">
3303     UrlFormField
3304   </a>
3305
3306 </li>
3307
3308       </ul>
3309     </nav>
3310
3311 </li>
3312
3313         <li class="md-nav__item">
3314   <a href="#specific-fields" class="md-nav__link">
3315     Specific Fields
3316   </a>
3317
3318     <nav class="md-nav" aria-label="Specific Fields">
3319       <ul class="md-nav__list">
3320
3321           <li class="md-nav__item">
3322   <a href="#aclformfield" class="md-nav__link">
3323     AclFormField
3324   </a>
3325
3326 </li>
3327
3328           <li class="md-nav__item">
3329   <a href="#buttonformfield" class="md-nav__link">
3330     ButtonFormField
3331   </a>
3332
3333 </li>
3334
3335           <li class="md-nav__item">
3336   <a href="#captchaformfield" class="md-nav__link">
3337     CaptchaFormField
3338   </a>
3339
3340 </li>
3341
3342           <li class="md-nav__item">
3343   <a href="#colorformfield" class="md-nav__link">
3344     ColorFormField
3345   </a>
3346
3347 </li>
3348
3349           <li class="md-nav__item">
3350   <a href="#contentlanguageformfield" class="md-nav__link">
3351     ContentLanguageFormField
3352   </a>
3353
3354 </li>
3355
3356           <li class="md-nav__item">
3357   <a href="#labelformfield" class="md-nav__link">
3358     LabelFormField
3359   </a>
3360
3361 </li>
3362
3363           <li class="md-nav__item">
3364   <a href="#optionformfield" class="md-nav__link">
3365     OptionFormField
3366   </a>
3367
3368 </li>
3369
3370           <li class="md-nav__item">
3371   <a href="#simpleaclformfield" class="md-nav__link">
3372     SimpleAclFormField
3373   </a>
3374
3375 </li>
3376
3377           <li class="md-nav__item">
3378   <a href="#singlemediaselectionformfield" class="md-nav__link">
3379     SingleMediaSelectionFormField
3380   </a>
3381
3382 </li>
3383
3384           <li class="md-nav__item">
3385   <a href="#tagformfield" class="md-nav__link">
3386     TagFormField
3387   </a>
3388
3389 </li>
3390
3391           <li class="md-nav__item">
3392   <a href="#uploadformfield" class="md-nav__link">
3393     UploadFormField
3394   </a>
3395
3396     <nav class="md-nav" aria-label="UploadFormField">
3397       <ul class="md-nav__list">
3398
3399           <li class="md-nav__item">
3400   <a href="#provide-value-from-database-object" class="md-nav__link">
3401     Provide value from database object
3402   </a>
3403
3404 </li>
3405
3406           <li class="md-nav__item">
3407   <a href="#process-files" class="md-nav__link">
3408     Process files
3409   </a>
3410
3411 </li>
3412
3413       </ul>
3414     </nav>
3415
3416 </li>
3417
3418           <li class="md-nav__item">
3419   <a href="#userformfield" class="md-nav__link">
3420     UserFormField
3421   </a>
3422
3423 </li>
3424
3425           <li class="md-nav__item">
3426   <a href="#userpasswordfield" class="md-nav__link">
3427     UserPasswordField
3428   </a>
3429
3430 </li>
3431
3432           <li class="md-nav__item">
3433   <a href="#usergroupoptionformfield" class="md-nav__link">
3434     UserGroupOptionFormField
3435   </a>
3436
3437 </li>
3438
3439           <li class="md-nav__item">
3440   <a href="#usernameformfield" class="md-nav__link">
3441     UsernameFormField
3442   </a>
3443
3444 </li>
3445
3446       </ul>
3447     </nav>
3448
3449 </li>
3450
3451         <li class="md-nav__item">
3452   <a href="#wysiwyg-form-container" class="md-nav__link">
3453     Wysiwyg form container
3454   </a>
3455
3456     <nav class="md-nav" aria-label="Wysiwyg form container">
3457       <ul class="md-nav__list">
3458
3459           <li class="md-nav__item">
3460   <a href="#wysiwygattachmentformfield" class="md-nav__link">
3461     WysiwygAttachmentFormField
3462   </a>
3463
3464 </li>
3465
3466           <li class="md-nav__item">
3467   <a href="#wysiwygpollformcontainer" class="md-nav__link">
3468     WysiwygPollFormContainer
3469   </a>
3470
3471 </li>
3472
3473           <li class="md-nav__item">
3474   <a href="#wysiwygsmileyformcontainer" class="md-nav__link">
3475     WysiwygSmileyFormContainer
3476   </a>
3477
3478     <nav class="md-nav" aria-label="WysiwygSmileyFormContainer">
3479       <ul class="md-nav__list">
3480
3481           <li class="md-nav__item">
3482   <a href="#wysiwygsmileyformnode" class="md-nav__link">
3483     WysiwygSmileyFormNode
3484   </a>
3485
3486 </li>
3487
3488       </ul>
3489     </nav>
3490
3491 </li>
3492
3493           <li class="md-nav__item">
3494   <a href="#example" class="md-nav__link">
3495     Example
3496   </a>
3497
3498 </li>
3499
3500           <li class="md-nav__item">
3501   <a href="#wysiwygformfield" class="md-nav__link">
3502     WysiwygFormField
3503   </a>
3504
3505 </li>
3506
3507           <li class="md-nav__item">
3508   <a href="#twysiwygformnode" class="md-nav__link">
3509     TWysiwygFormNode
3510   </a>
3511
3512 </li>
3513
3514       </ul>
3515     </nav>
3516
3517 </li>
3518
3519         <li class="md-nav__item">
3520   <a href="#application-specific-form-fields" class="md-nav__link">
3521     Application-Specific Form Fields
3522   </a>
3523
3524     <nav class="md-nav" aria-label="Application-Specific Form Fields">
3525       <ul class="md-nav__list">
3526
3527           <li class="md-nav__item">
3528   <a href="#woltlab-suite-forum" class="md-nav__link">
3529     WoltLab Suite Forum
3530   </a>
3531
3532     <nav class="md-nav" aria-label="WoltLab Suite Forum">
3533       <ul class="md-nav__list">
3534
3535           <li class="md-nav__item">
3536   <a href="#multipleboardselectionformfield" class="md-nav__link">
3537     MultipleBoardSelectionFormField
3538   </a>
3539
3540 </li>
3541
3542       </ul>
3543     </nav>
3544
3545 </li>
3546
3547       </ul>
3548     </nav>
3549
3550 </li>
3551
3552         <li class="md-nav__item">
3553   <a href="#single-use-form-fields" class="md-nav__link">
3554     Single-Use Form Fields
3555   </a>
3556
3557     <nav class="md-nav" aria-label="Single-Use Form Fields">
3558       <ul class="md-nav__list">
3559
3560           <li class="md-nav__item">
3561   <a href="#bbcodeattributesformfield" class="md-nav__link">
3562     BBCodeAttributesFormField
3563   </a>
3564
3565 </li>
3566
3567           <li class="md-nav__item">
3568   <a href="#devtoolsprojectexcludedpackagesformfield" class="md-nav__link">
3569     DevtoolsProjectExcludedPackagesFormField
3570   </a>
3571
3572 </li>
3573
3574           <li class="md-nav__item">
3575   <a href="#devtoolsprojectinstructionsformfield" class="md-nav__link">
3576     DevtoolsProjectInstructionsFormField
3577   </a>
3578
3579 </li>
3580
3581           <li class="md-nav__item">
3582   <a href="#devtoolsprojectoptionalpackagesformfield" class="md-nav__link">
3583     DevtoolsProjectOptionalPackagesFormField
3584   </a>
3585
3586 </li>
3587
3588           <li class="md-nav__item">
3589   <a href="#devtoolsprojectrequiredpackagesformfield" class="md-nav__link">
3590     DevtoolsProjectRequiredPackagesFormField
3591   </a>
3592
3593 </li>
3594
3595       </ul>
3596     </nav>
3597
3598 </li>
3599
3600     </ul>
3601
3602 </nav>
3603                   </div>
3604                 </div>
3605               </div>
3606
3607
3608
3609             <div class="md-content" data-md-component="content">
3610               <article class="md-content__inner md-typeset">
3611
3612
3613
3614
3615
3616
3617
3618 <h1 id="form-builder-fields">Form Builder Fields<a class="headerlink" href="#form-builder-fields" title="Permanent link">#</a></h1>
3619 <h2 id="abstract-form-fields">Abstract Form Fields<a class="headerlink" href="#abstract-form-fields" title="Permanent link">#</a></h2>
3620 <p>The following form field classes cannot be instantiated directly because they are abstract, but they can/must be used when creating own form field classes. </p>
3621 <h3 id="abstractformfield"><code>AbstractFormField</code><a class="headerlink" href="#abstractformfield" title="Permanent link">#</a></h3>
3622 <p><code>AbstractFormField</code> is the abstract default implementation of the <code>IFormField</code> interface and it is expected that every implementation of <code>IFormField</code> implements the interface by extending this class.</p>
3623 <h3 id="abstractnumericformfield"><code>AbstractNumericFormField</code><a class="headerlink" href="#abstractnumericformfield" title="Permanent link">#</a></h3>
3624 <p><code>AbstractNumericFormField</code> is the abstract implementation of a form field handling a single numeric value.
3625 The class implements <code>IAttributeFormField</code>, <code>IAutoCompleteFormField</code>, <code>ICssClassFormField</code>, <code>IImmutableFormField</code>, <code>IInputModeFormField</code>, <code>IMaximumFormField</code>, <code>IMinimumFormField</code>, <code>INullableFormField</code>, <code>IPlaceholderFormField</code> and <code>ISuffixedFormField</code>.
3626 If the property <code>$integerValues</code> is <code>true</code>, the form field works with integer values, otherwise it works with floating point numbers.
3627 The methods <code>step($step = null)</code> and <code>getStep()</code> can be used to set and get the step attribute of the <code>input</code> element.
3628 The default step for form fields with integer values is <code>1</code>.
3629 Otherwise, the default step is <code>any</code>.</p>
3630 <h3 id="abstractformfielddecorator"><code>AbstractFormFieldDecorator</code><a class="headerlink" href="#abstractformfielddecorator" title="Permanent link">#</a></h3>
3631 <div class="admonition info">
3632 <p class="admonition-title">Only available since version 5.4.5.</p>
3633 </div>
3634 <p><code>AbstractFormFieldDecorator</code> is a default implementation of a decorator for form fields that forwards calls to all methods defined in <code>IFormField</code> to the respective method of the decorated object.
3635 The class implements <code>IFormfield</code>.
3636 If the implementation of a more specific interface is required then the remaining methods must be implemented in the concrete decorator derived from <code>AbstractFormFieldDecorator</code> and the type of the <code>$field</code> property must be narrowed appropriately.</p>
3637 <h2 id="general-form-fields">General Form Fields<a class="headerlink" href="#general-form-fields" title="Permanent link">#</a></h2>
3638 <p>The following form fields are general reusable fields without any underlying context.</p>
3639 <h3 id="booleanformfield"><code>BooleanFormField</code><a class="headerlink" href="#booleanformfield" title="Permanent link">#</a></h3>
3640 <p><code>BooleanFormField</code> is used for boolean (<code>0</code> or <code>1</code>, <code>yes</code> or <code>no</code>) values.
3641 Objects of this class require a label.
3642 The return value of <code>getSaveValue()</code> is the integer representation of the boolean value, i.e. <code>0</code> or <code>1</code>.
3643 The class implements <code>IAttributeFormField</code>, <code>IAutoFocusFormField</code>, <code>ICssClassFormField</code>, and <code>IImmutableFormField</code>.</p>
3644 <h3 id="checkboxformfield"><code>CheckboxFormField</code><a class="headerlink" href="#checkboxformfield" title="Permanent link">#</a></h3>
3645 <p><code>CheckboxFormField</code> extends <code>BooleanFormField</code> and offers a simple HTML checkbox.</p>
3646 <h3 id="classnameformfield"><code>ClassNameFormField</code><a class="headerlink" href="#classnameformfield" title="Permanent link">#</a></h3>
3647 <p><code>ClassNameFormField</code> is a <a href="#textformfield">text form field</a> that supports additional settings, specific to entering a PHP class name:</p>
3648 <ul>
3649 <li><code>classExists($classExists = true)</code> and <code>getClassExists()</code> can be used to ensure that the entered class currently exists in the installation.
3650   By default, the existance of the entered class is required.</li>
3651 <li><code>implementedInterface($interface)</code> and <code>getImplementedInterface()</code> can be used to ensure that the entered class implements the specified interface.
3652   By default, no interface is required.</li>
3653 <li><code>parentClass($parentClass)</code> and <code>getParentClass()</code> can be used to ensure that the entered class extends the specified class.
3654   By default, no parent class is required.</li>
3655 <li><code>instantiable($instantiable = true)</code> and <code>isInstantiable()</code> can be used to ensure that the entered class is instantiable.
3656   By default, entered classes have to instantiable.</li>
3657 </ul>
3658 <p>Additionally, the default id of a <code>ClassNameFormField</code> object is <code>className</code>, the default label is <code>wcf.form.field.className</code>, and if either an interface or a parent class is required, a default description is set if no description has already been set (<code>wcf.form.field.className.description.interface</code> and <code>wcf.form.field.className.description.parentClass</code>, respectively).</p>
3659 <h3 id="dateformfield"><code>DateFormField</code><a class="headerlink" href="#dateformfield" title="Permanent link">#</a></h3>
3660 <p><code>DateFormField</code> is a form field to enter a date (and optionally a time).
3661 The class implements <code>IAttributeFormField</code>, <code>IAutoFocusFormField</code>, <code>ICssClassFormField</code>, <code>IImmutableFormField</code>, and <code>INullableFormField</code>.
3662 The following methods are specific to this form field class:</p>
3663 <ul>
3664 <li><code>earliestDate($earliestDate)</code> and <code>getEarliestDate()</code> can be used to get and set the earliest selectable/valid date and <code>latestDate($latestDate)</code> and <code>getLatestDate()</code> can be used to get and set the latest selectable/valid date.
3665   The date passed to the setters must have the same format as set via <code>saveValueFormat()</code>.
3666   If a custom format is used, that format has to be set via <code>saveValueFormat()</code> before calling any of the setters.</li>
3667 <li><code>saveValueFormat($saveValueFormat)</code> and <code>getSaveValueFormat()</code> can be used to specify the date format of the value returned by <code>getSaveValue()</code>.
3668   By default, <code>U</code> is used as format.
3669   The <a href="https://secure.php.net/manual/en/function.date.php">PHP manual</a> provides an overview of supported formats.</li>
3670 <li><code>supportTime($supportsTime = true)</code> and <code>supportsTime()</code> can be used to toggle whether, in addition to a date, a time can also be specified.
3671   By default, specifying a time is disabled.</li>
3672 </ul>
3673 <h3 id="descriptionformfield"><code>DescriptionFormField</code><a class="headerlink" href="#descriptionformfield" title="Permanent link">#</a></h3>
3674 <p><code>DescriptionFormField</code> is a <a href="#multilinetextformfield">multi-line text form field</a> with <code>description</code> as the default id and <code>wcf.global.description</code> as the default label.</p>
3675 <h3 id="emailformfield"><code>EmailFormField</code><a class="headerlink" href="#emailformfield" title="Permanent link">#</a></h3>
3676 <p><code>EmailFormField</code> is a form field to enter an email address which is internally validated using <code>UserUtil::isValidEmail()</code>.
3677 The class implements <code>IAttributeFormField</code>, <code>IAutoCompleteFormField</code>, <code>IAutoFocusFormField</code>, <code>ICssClassFormField</code>, <code>II18nFormField</code>, <code>IImmutableFormField</code>, <code>IInputModeFormField</code>, <code>IPatternFormField</code>, and <code>IPlaceholderFormField</code>.</p>
3678 <h3 id="floatformfield"><code>FloatFormField</code><a class="headerlink" href="#floatformfield" title="Permanent link">#</a></h3>
3679 <p><code>FloatFormField</code> is an implementation of <a href="#abstractnumericformfield">AbstractNumericFormField</a> for floating point numbers.</p>
3680 <h3 id="hiddenformfield"><code>HiddenFormField</code><a class="headerlink" href="#hiddenformfield" title="Permanent link">#</a></h3>
3681 <p><code>HiddenFormField</code> is a form field without any user-visible UI.
3682 Even though the form field is invisible to the user, the value can still be modified by the user, e.g. by leveraging the web browsers developer tools.
3683 The <code>HiddenFormField</code> <em>must not</em> be used to transfer sensitive information or information that the user should not be able to modify.</p>
3684 <h3 id="iconformfield"><code>IconFormField</code><a class="headerlink" href="#iconformfield" title="Permanent link">#</a></h3>
3685 <p><code>IconFormField</code> is a form field to select a FontAwesome icon.</p>
3686 <h3 id="integerformfield"><code>IntegerFormField</code><a class="headerlink" href="#integerformfield" title="Permanent link">#</a></h3>
3687 <p><code>IntegerFormField</code> is an implementation of <a href="#abstractnumericformfield">AbstractNumericFormField</a> for integers.</p>
3688 <h3 id="isdisabledformfield"><code>IsDisabledFormField</code><a class="headerlink" href="#isdisabledformfield" title="Permanent link">#</a></h3>
3689 <p><code>IsDisabledFormField</code> is a <a href="#booleanformfield">boolean form field</a> with <code>isDisabled</code> as the default id.</p>
3690 <h3 id="itemlistformfield"><code>ItemListFormField</code><a class="headerlink" href="#itemlistformfield" title="Permanent link">#</a></h3>
3691 <p><code>ItemListFormField</code> is a form field in which multiple values can be entered and returned in different formats as save value.
3692 The class implements <code>IAttributeFormField</code>, <code>IAutoFocusFormField</code>, <code>ICssClassFormField</code>, <code>IImmutableFormField</code>, and <code>IMultipleFormField</code>.
3693 The <code>saveValueType($saveValueType)</code> and <code>getSaveValueType()</code> methods are specific to this form field class and determine the format of the save value.
3694 The following save value types are supported:</p>
3695 <ul>
3696 <li><code>ItemListFormField::SAVE_VALUE_TYPE_ARRAY</code> adds a custom data processor that writes the form field data directly in the parameters array and not in the data sub-array of the parameters array.</li>
3697 <li><code>ItemListFormField::SAVE_VALUE_TYPE_CSV</code> lets the value be returned as a string in which the values are concatenated by commas.</li>
3698 <li><code>ItemListFormField::SAVE_VALUE_TYPE_NSV</code> lets the value be returned as a string in which the values are concatenated by <code>\n</code>.</li>
3699 <li><code>ItemListFormField::SAVE_VALUE_TYPE_SSV</code> lets the value be returned as a string in which the values are concatenated by spaces.</li>
3700 </ul>
3701 <p>By default, <code>ItemListFormField::SAVE_VALUE_TYPE_CSV</code> is used.</p>
3702 <p>If <code>ItemListFormField::SAVE_VALUE_TYPE_ARRAY</code> is used as save value type, <code>ItemListFormField</code> objects register a <a href="../validation_data/#customformfielddataprocessor">custom form field data processor</a> to add the relevant array into the <code>$parameters</code> array directly using the object property as the array key.</p>
3703 <h3 id="multilinetextformfield"><code>MultilineTextFormField</code><a class="headerlink" href="#multilinetextformfield" title="Permanent link">#</a></h3>
3704 <p><code>MultilineTextFormField</code> is a <a href="#textformfield">text form field</a> that supports multiple rows of text.
3705 The methods <code>rows($rows)</code> and <code>getRows()</code> can be used to set and get the number of rows of the <code>textarea</code> elements.
3706 The default number of rows is <code>10</code>.
3707 These methods do <strong>not</strong>, however, restrict the number of text rows that can be entered.</p>
3708 <h3 id="multipleselectionformfield"><code>MultipleSelectionFormField</code><a class="headerlink" href="#multipleselectionformfield" title="Permanent link">#</a></h3>
3709 <p><code>MultipleSelectionFormField</code> is a form fields that allows the selection of multiple options out of a predefined list of available options.
3710 The class implements <code>IAttributeFormField</code>, <code>ICssClassFormField</code>, <code>IFilterableSelectionFormField</code>, and <code>IImmutableFormField</code>.</p>
3711 <h3 id="radiobuttonformfield"><code>RadioButtonFormField</code><a class="headerlink" href="#radiobuttonformfield" title="Permanent link">#</a></h3>
3712 <p><code>RadioButtonFormField</code> is a form fields that allows the selection of a single option out of a predefined list of available options using radiobuttons.
3713 The class implements <code>IAttributeFormField</code>, <code>ICssClassFormField</code>, <code>IImmutableFormField</code>, and <code>ISelectionFormField</code>.</p>
3714 <h3 id="ratingformfield"><code>RatingFormField</code><a class="headerlink" href="#ratingformfield" title="Permanent link">#</a></h3>
3715 <p><code>RatingFormField</code> is a form field to set a rating for an object.
3716 The class implements <code>IImmutableFormField</code>, <code>IMaximumFormField</code>, <code>IMinimumFormField</code>, and <code>INullableFormField</code>.
3717 Form fields of this class have <code>rating</code> as their default id, <code>wcf.form.field.rating</code> as their default label, <code>1</code> as their default minimum, and <code>5</code> as their default maximum.
3718 For this field, the minimum and maximum refer to the minimum and maximum rating an object can get.
3719 When the field is shown, there will be <code>maximum() - minimum() + 1</code> icons be shown with additional CSS classes that can be set and gotten via <code>defaultCssClasses(array $cssClasses)</code> and <code>getDefaultCssClasses()</code>.
3720 If a rating values is set, the first <code>getValue()</code> icons will instead use the classes that can be set and gotten via <code>activeCssClasses(array $cssClasses)</code> and <code>getActiveCssClasses()</code>.
3721 By default, the only default class is <code>fa-star-o</code> and the active classes are <code>fa-star</code> and <code>orange</code>. </p>
3722 <h3 id="showorderformfield"><code>ShowOrderFormField</code><a class="headerlink" href="#showorderformfield" title="Permanent link">#</a></h3>
3723 <p><code>ShowOrderFormField</code> is a <a href="#singleselectionformfield">single selection form field</a> for which the selected value determines the position at which an object is shown.
3724 The show order field provides a list of all siblings and the object will be positioned <strong>after</strong> the selected sibling.
3725 To insert objects at the very beginning, the <code>options()</code> automatically method prepends an additional option for that case so that only the existing siblings need to be passed.
3726 The default id of instances of this class is <code>showOrder</code> and their default label is <code>wcf.form.field.showOrder</code>.</p>
3727 <div class="admonition info">
3728 <p class="admonition-title">It is important that the relevant object property is always kept updated. Whenever a new object is added or an existing object is edited or delete, the values of the other objects have to be adjusted to ensure consecutive numbering.</p>
3729 </div>
3730 <h3 id="singleselectionformfield"><code>SingleSelectionFormField</code><a class="headerlink" href="#singleselectionformfield" title="Permanent link">#</a></h3>
3731 <p><code>SingleSelectionFormField</code> is a form fields that allows the selection of a single option out of a predefined list of available options.
3732 The class implements <code>ICssClassFormField</code>, <code>IFilterableSelectionFormField</code>, <code>IImmutableFormField</code>, and <code>INullableFormField</code>.
3733 If the field is nullable and the current form field value is considered <code>empty</code> by PHP, <code>null</code> is returned as the save value.</p>
3734 <h3 id="sortorderformfield"><code>SortOrderFormField</code><a class="headerlink" href="#sortorderformfield" title="Permanent link">#</a></h3>
3735 <p><code>SingleSelectionFormField</code> is a <a href="#singleselectionformfield">single selection form field</a> with default id <code>sortOrder</code>, default label <code>wcf.global.showOrder</code> and default options <code>ASC: wcf.global.sortOrder.ascending</code> and <code>DESC: wcf.global.sortOrder.descending</code>.</p>
3736 <h3 id="textformfield"><code>TextFormField</code><a class="headerlink" href="#textformfield" title="Permanent link">#</a></h3>
3737 <p><code>TextFormField</code> is a form field that allows entering a single line of text.
3738 The class implements <code>IAttributeFormField</code>, <code>IAutoCompleteFormField</code>, <code>ICssClassFormField</code>, <code>IImmutableFormField</code>, <code>II18nFormField</code>, <code>IInputModeFormField</code>, <code>IMaximumLengthFormField</code>, <code>IMinimumLengthFormField</code>, <code>IPatternFormField</code>, and <code>IPlaceholderFormField</code>.</p>
3739 <h3 id="titleformfield"><code>TitleFormField</code><a class="headerlink" href="#titleformfield" title="Permanent link">#</a></h3>
3740 <p><code>TitleFormField</code> is a <a href="#textformfield">text form field</a> with <code>title</code> as the default id and <code>wcf.global.title</code> as the default label.</p>
3741 <h3 id="urlformfield"><code>UrlFormField</code><a class="headerlink" href="#urlformfield" title="Permanent link">#</a></h3>
3742 <p><code>UrlFormField</code> is a <a href="#textformfield">text form field</a> whose values are checked via <code>Url::is()</code>.</p>
3743 <h2 id="specific-fields">Specific Fields<a class="headerlink" href="#specific-fields" title="Permanent link">#</a></h2>
3744 <p>The following form fields are reusable fields that generally are bound to a certain API or <code>DatabaseObject</code> implementation.</p>
3745 <h3 id="aclformfield"><code>AclFormField</code><a class="headerlink" href="#aclformfield" title="Permanent link">#</a></h3>
3746 <p><code>AclFormField</code> is used for setting up acl values for specific objects.
3747 The class implements <code>IObjectTypeFormField</code> and requires an object type of the object type definition <code>com.woltlab.wcf.acl</code>.
3748 Additionally, the class provides the methods <code>categoryName($categoryName)</code> and <code>getCategoryName()</code> that allow setting a specific name or filter for the acl option categories whose acl options are shown.
3749 A category name of <code>null</code> signals that no category filter is used.</p>
3750 <div class="admonition info">
3751 <p class="admonition-title">Since version 5.5, the category name also supports filtering using a wildcard like <code>user.*</code>, see <a href="https://github.com/WoltLab/WCF/pull/4355">WoltLab/WCF#4355</a>.</p>
3752 </div>
3753 <p><code>AclFormField</code> objects register a <a href="../validation_data/#customformfielddataprocessor">custom form field data processor</a> to add the relevant ACL object type id into the <code>$parameters</code> array directly using <code>{$objectProperty}_aclObjectTypeID</code> as the array key.
3754 The relevant database object action method is expected, based on the given ACL object type id, to save the ACL option values appropriately.</p>
3755 <h3 id="buttonformfield"><code>ButtonFormField</code><a class="headerlink" href="#buttonformfield" title="Permanent link">#</a></h3>
3756 <div class="admonition info">
3757 <p class="admonition-title">Only available since version 5.4.</p>
3758 </div>
3759 <p><code>ButtonFormField</code> shows a submit button as part of the form.
3760 The class implements <code>IAttributeFormField</code> and <code>ICssClassFormField</code>.</p>
3761 <p>Specifically for this form field, there is the <code>IsNotClickedFormFieldDependency</code> dependency with which certain parts of the form will only be processed if the relevent button has not clicked. </p>
3762 <h3 id="captchaformfield"><code>CaptchaFormField</code><a class="headerlink" href="#captchaformfield" title="Permanent link">#</a></h3>
3763 <p><code>CaptchaFormField</code> is used to add captcha protection to the form.</p>
3764 <p>You must specify a captcha object type (<code>com.woltlab.wcf.captcha</code>) using the <code>objectType()</code> method.</p>
3765 <h3 id="colorformfield"><code>ColorFormField</code><a class="headerlink" href="#colorformfield" title="Permanent link">#</a></h3>
3766 <div class="admonition info">
3767 <p class="admonition-title">Only available since version 5.5.</p>
3768 </div>
3769 <p><code>ColorFormField</code> is used to specify RGBA colors using the <code>rgba(r, g, b, a)</code> format.
3770 The class implements <code>IImmutableFormField</code>.</p>
3771 <h3 id="contentlanguageformfield"><code>ContentLanguageFormField</code><a class="headerlink" href="#contentlanguageformfield" title="Permanent link">#</a></h3>
3772 <p><code>ContentLanguageFormField</code> is used to select the content language of an object.
3773 Fields of this class are only available if multilingualism is enabled and if there are content languages.
3774 The class implements <code>IImmutableFormField</code>.</p>
3775 <h3 id="labelformfield"><code>LabelFormField</code><a class="headerlink" href="#labelformfield" title="Permanent link">#</a></h3>
3776 <p><code>LabelFormField</code> is used to select a label from a specific label group.
3777 The class implements <code>IObjectTypeFormNode</code>.</p>
3778 <p>The <code>labelGroup(ViewableLabelGroup $labelGroup)</code> and <code>getLabelGroup()</code> methods are specific to this form field class and can be used to set and get the label group whose labels can be selected.
3779 Additionally, there is the static method <code>createFields($objectType, array $labelGroups, $objectProperty = 'labelIDs)</code> that can be used to create all relevant label form fields for a given list of label groups.
3780 In most cases, <code>LabelFormField::createFields()</code> should be used.</p>
3781 <h3 id="optionformfield"><code>OptionFormField</code><a class="headerlink" href="#optionformfield" title="Permanent link">#</a></h3>
3782 <p><code>OptionFormField</code> is an <a href="#itemlistformfield">item list form field</a> to set a list of options.
3783 The class implements <code>IPackagesFormField</code> and only options of the set packages are considered available.
3784 The default label of instances of this class is <code>wcf.form.field.option</code> and their default id is <code>options</code>.</p>
3785 <h3 id="simpleaclformfield"><code>SimpleAclFormField</code><a class="headerlink" href="#simpleaclformfield" title="Permanent link">#</a></h3>
3786 <p><code>SimpleAclFormField</code> is used for setting up simple acl values (one <code>yes</code>/<code>no</code> option per user and user group) for specific objects.</p>
3787 <p><code>SimpleAclFormField</code> objects register a <a href="../validation_data/#customformfielddataprocessor">custom form field data processor</a> to add the relevant simple ACL data array into the <code>$parameters</code> array directly using the object property as the array key.</p>
3788 <div class="admonition info">
3789 <p class="admonition-title">Since version 5.5, the field also supports inverted permissions, see <a href="https://github.com/WoltLab/WCF/pull/4570">WoltLab/WCF#4570</a>.</p>
3790 </div>
3791 <p>The <code>SimpleAclFormField</code> supports inverted permissions, allowing the administrator to grant access to all non-selected users and groups. If this behavior is desired, it needs to be enabled by calling <code>supportInvertedPermissions</code>. An <code>invertPermissions</code> key containing a boolean value with the users selection will be provided together with the ACL values when saving the field.</p>
3792 <h3 id="singlemediaselectionformfield"><code>SingleMediaSelectionFormField</code><a class="headerlink" href="#singlemediaselectionformfield" title="Permanent link">#</a></h3>
3793 <p><code>SingleMediaSelectionFormField</code> is used to select a specific media file.
3794 The class implements <code>IImmutableFormField</code>.</p>
3795 <p>The following methods are specific to this form field class:</p>
3796 <ul>
3797 <li><code>imageOnly($imageOnly = true)</code> and <code>isImageOnly()</code> can be used to set and check if only images may be selected.</li>
3798 <li><code>getMedia()</code> returns the media file based on the current field value if a field is set.</li>
3799 </ul>
3800 <h3 id="tagformfield"><code>TagFormField</code><a class="headerlink" href="#tagformfield" title="Permanent link">#</a></h3>
3801 <p><code>TagFormField</code> is a form field to enter tags.
3802 The class implements <code>IAttributeFormField</code> and <code>IObjectTypeFormNode</code>.
3803 Arrays passed to <code>TagFormField::values()</code> can contain tag names as strings and <code>Tag</code> objects.
3804 The default label of instances of this class is <code>wcf.tagging.tags</code> and their default description is <code>wcf.tagging.tags.description</code>.</p>
3805 <p><code>TagFormField</code> objects register a <a href="../validation_data/#customformfielddataprocessor">custom form field data processor</a> to add the array with entered tag names into the <code>$parameters</code> array directly using the object property as the array key.</p>
3806 <h3 id="uploadformfield"><code>UploadFormField</code><a class="headerlink" href="#uploadformfield" title="Permanent link">#</a></h3>
3807 <p><code>UploadFormField</code> is a form field that allows uploading files by the user.</p>
3808 <p><code>UploadFormField</code> objects register a <a href="../validation_data/#customformfielddataprocessor">custom form field data processor</a> to add the array of <code>wcf\system\file\upload\UploadFile\UploadFile</code> into the <code>$parameters</code> array directly using the object property as the array key. Also it registers the removed files as an array of <code>wcf\system\file\upload\UploadFile\UploadFile</code> into the <code>$parameters</code> array directly using the object property with the suffix <code>_removedFiles</code> as the array key.  </p>
3809 <p>The field supports additional settings:</p>
3810 <ul>
3811 <li><code>imageOnly($imageOnly = true)</code> and <code>isImageOnly()</code> can be used to ensure that the uploaded files are only images.</li>
3812 <li><code>allowSvgImage($allowSvgImages = true)</code> and <code>svgImageAllowed()</code> can be used to allow SVG images, if the image only mode is enabled (otherwise, the method will throw an exception). By default, SVG images are not allowed.</li>
3813 </ul>
3814 <h4 id="provide-value-from-database-object">Provide value from database object<a class="headerlink" href="#provide-value-from-database-object" title="Permanent link">#</a></h4>
3815 <p>To provide values from a database object, you should implement the method <code>get{$objectProperty}UploadFileLocations()</code> to your database object class. This method must return an array of strings with the locations of the files.</p>
3816 <h4 id="process-files">Process files<a class="headerlink" href="#process-files" title="Permanent link">#</a></h4>
3817 <p>To process files in the database object action class, you must <a href="https://secure.php.net/manual/en/function.rename.php"><code>rename</code></a> the file to the final destination. You get the temporary location, by calling the method <code>getLocation()</code> on the given <code>UploadFile</code> objects. After that, you call <code>setProcessed($location)</code> with <code>$location</code> contains the new file location. This method sets the <code>isProcessed</code> flag to true and saves the new location. For updating files, it is relevant, whether a given file is already processed or not. For this case, the <code>UploadFile</code> object has an method <code>isProcessed()</code> which indicates, whether a file is already processed or new uploaded.</p>
3818 <h3 id="userformfield"><code>UserFormField</code><a class="headerlink" href="#userformfield" title="Permanent link">#</a></h3>
3819 <p><code>UserFormField</code> is a form field to enter existing users.
3820 The class implements <code>IAutoCompleteFormField</code>, <code>IAutoFocusFormField</code>, <code>IImmutableFormField</code>, <code>IMultipleFormField</code>, and <code>INullableFormField</code>.
3821 While the user is presented the names of the specified users in the user interface, the field returns the ids of the users as data.
3822 The relevant <code>UserProfile</code> objects can be accessed via the <code>getUsers()</code> method.</p>
3823 <h3 id="userpasswordfield"><code>UserPasswordField</code><a class="headerlink" href="#userpasswordfield" title="Permanent link">#</a></h3>
3824 <div class="admonition info">
3825 <p class="admonition-title">Only available since version 5.4.</p>
3826 </div>
3827 <p><code>UserPasswordField</code> is a form field for users' to enter their current password.
3828 The class implements <code>IAttributeFormField</code>, <code>IAttributeFormField</code>, <code>IAutoCompleteFormField</code>, <code>IAutoFocusFormField</code>, and <code>IPlaceholderFormField</code></p>
3829 <h3 id="usergroupoptionformfield"><code>UserGroupOptionFormField</code><a class="headerlink" href="#usergroupoptionformfield" title="Permanent link">#</a></h3>
3830 <p><code>UserGroupOptionFormField</code> is an <a href="#itemlistformfield">item list form field</a> to set a list of user group options/permissions.
3831 The class implements <code>IPackagesFormField</code> and only user group options of the set packages are considered available.
3832 The default label of instances of this class is <code>wcf.form.field.userGroupOption</code> and their default id is <code>permissions</code>.</p>
3833 <h3 id="usernameformfield"><code>UsernameFormField</code><a class="headerlink" href="#usernameformfield" title="Permanent link">#</a></h3>
3834 <p><code>UsernameFormField</code> is used for entering one non-existing username.
3835 The class implements <code>IAttributeFormField</code>, <code>IImmutableFormField</code>, <code>IMaximumLengthFormField</code>, <code>IMinimumLengthFormField</code>, <code>INullableFormField</code>, and <code>IPlaceholderFormField</code>.
3836 As usernames have a system-wide restriction of a minimum length of 3 and a maximum length of 100 characters, these values are also used as the default value for the field’s minimum and maximum length.</p>
3837 <h2 id="wysiwyg-form-container">Wysiwyg form container<a class="headerlink" href="#wysiwyg-form-container" title="Permanent link">#</a></h2>
3838 <p>To integrate a wysiwyg editor into a form, you have to create a <code>WysiwygFormContainer</code> object.
3839 This container takes care of creating all necessary form nodes listed below for a wysiwyg editor.</p>
3840 <div class="admonition warning">
3841 <p class="admonition-title">When creating the container object, its id has to be the id of the form field that will manage the actual text.</p>
3842 </div>
3843 <p>The following methods are specific to this form container class:</p>
3844 <ul>
3845 <li><code>addSettingsNode(IFormChildNode $settingsNode)</code> and <code>addSettingsNodes(array $settingsNodes)</code> can be used to add nodes to the settings tab container.</li>
3846 <li><code>attachmentData($objectType, $parentObjectID)</code> can be used to set the data relevant for attachment support.
3847   By default, not attachment data is set, thus attachments are not supported.</li>
3848 <li><code>getAttachmentField()</code>, <code>getPollContainer()</code>, <code>getSettingsContainer()</code>, <code>getSmiliesContainer()</code>, and <code>getWysiwygField()</code> can be used to get the different components of the wysiwyg form container once the form has been built.</li>
3849 <li><code>enablePreviewButton($enablePreviewButton)</code> can be used to set whether the preview button for the message is shown or not.
3850   By default, the preview button is shown.
3851   This method is only relevant before the form is built.
3852   Afterwards, the preview button availability can not be changed.</li>
3853 <li><code>getObjectId()</code> returns the id of the edited object or <code>0</code> if no object is edited.</li>
3854 <li><code>getPreselect()</code>, <code>preselect($preselect)</code> can be used to set the value of the wysiwyg tab menu's <code>data-preselect</code> attribute used to determine which tab is preselected.
3855   By default, the preselect is <code>'true'</code> which is used to pre-select the first tab.</li>
3856 <li><code>messageObjectType($messageObjectType)</code> can be used to set the message object type.</li>
3857 <li><code>pollObjectType($pollObjectType)</code> can be used to set the poll object type.
3858   By default, no poll object type is set, thus the poll form field container is not available.</li>
3859 <li><code>supportMentions($supportMentions)</code> can be used to set if mentions are supported.
3860   By default, mentions are not supported.
3861   This method is only relevant before the form is built.
3862   Afterwards, mention support can only be changed via the wysiwyg form field.</li>
3863 <li><code>supportSmilies($supportSmilies)</code> can be used to set if smilies are supported.
3864   By default, smilies are supported.
3865   This method is only relevant before the form is built.
3866   Afterwards, smiley availability can only be changed via changing the availability of the smilies form container.</li>
3867 </ul>
3868 <h3 id="wysiwygattachmentformfield"><code>WysiwygAttachmentFormField</code><a class="headerlink" href="#wysiwygattachmentformfield" title="Permanent link">#</a></h3>
3869 <p><code>WysiwygAttachmentFormField</code> provides attachment support for a wysiwyg editor via a tab in the menu below the editor.
3870 This class should not be used directly but only via <code>WysiwygFormContainer</code>.
3871 The methods <code>attachmentHandler(AttachmentHandler $attachmentHandler)</code> and <code>getAttachmentHandler()</code> can be used to set and get the <code>AttachmentHandler</code> object that is used for uploaded attachments.</p>
3872 <h3 id="wysiwygpollformcontainer"><code>WysiwygPollFormContainer</code><a class="headerlink" href="#wysiwygpollformcontainer" title="Permanent link">#</a></h3>
3873 <p><code>WysiwygPollFormContainer</code> provides poll support for a wysiwyg editor via a tab in the menu below the editor.
3874 This class should not be used directly but only via <code>WysiwygFormContainer</code>.
3875 <code>WysiwygPollFormContainer</code> contains all form fields that are required to create polls and requires edited objects to implement <code>IPollContainer</code>.</p>
3876 <p>The following methods are specific to this form container class:</p>
3877 <ul>
3878 <li><code>getEndTimeField()</code> returns the form field to set the end time of the poll once the form has been built.</li>
3879 <li><code>getIsChangeableField()</code> returns the form field to set if poll votes can be changed once the form has been built.</li>
3880 <li><code>getIsPublicField()</code> returns the form field to set if poll results are public once the form has been built.</li>
3881 <li><code>getMaxVotesField()</code> returns the form field to set the maximum number of votes once the form has been built.</li>
3882 <li><code>getOptionsField()</code> returns the form field to set the poll options once the form has been built.</li>
3883 <li><code>getQuestionField()</code> returns the form field to set the poll question once the form has been built.</li>
3884 <li><code>getResultsRequireVoteField()</code> returns the form field to set if viewing the poll results requires voting once the form has been built.</li>
3885 <li><code>getSortByVotesField()</code> returns the form field to set if the results are sorted by votes once the form has been built.</li>
3886 </ul>
3887 <h3 id="wysiwygsmileyformcontainer"><code>WysiwygSmileyFormContainer</code><a class="headerlink" href="#wysiwygsmileyformcontainer" title="Permanent link">#</a></h3>
3888 <p><code>WysiwygSmileyFormContainer</code> provides smiley support for a wysiwyg editor via a tab in the menu below the editor.
3889 This class should not be used directly but only via <code>WysiwygFormContainer</code>.
3890 <code>WysiwygSmileyFormContainer</code> creates a sub-tab for each smiley category.</p>
3891 <h4 id="wysiwygsmileyformnode"><code>WysiwygSmileyFormNode</code><a class="headerlink" href="#wysiwygsmileyformnode" title="Permanent link">#</a></h4>
3892 <p><code>WysiwygSmileyFormNode</code> is contains the smilies of a specific category.
3893 This class should not be used directly but only via <code>WysiwygSmileyFormContainer</code>.</p>
3894 <h3 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h3>
3895 <p>The following code creates a WYSIWYG editor component for a <code>message</code> object property.
3896 As smilies are supported by default and an attachment object type is given, the tab menu below the editor has two tabs: “Smilies” and “Attachments”.
3897 Additionally, mentions and quotes are supported.</p>
3898 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3899 <span class="normal">2</span>
3900 <span class="normal">3</span>
3901 <span class="normal">4</span>
3902 <span class="normal">5</span>
3903 <span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nx">WysiwygFormContainer</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;message&#39;</span><span class="p">)</span>
3904     <span class="o">-&gt;</span><span class="na">label</span><span class="p">(</span><span class="s1">&#39;foo.bar.message&#39;</span><span class="p">)</span>
3905     <span class="o">-&gt;</span><span class="na">messageObjectType</span><span class="p">(</span><span class="s1">&#39;com.example.foo.bar&#39;</span><span class="p">)</span>
3906     <span class="o">-&gt;</span><span class="na">attachmentData</span><span class="p">(</span><span class="s1">&#39;com.example.foo.bar&#39;</span><span class="p">)</span>
3907     <span class="o">-&gt;</span><span class="na">supportMentions</span><span class="p">()</span>
3908     <span class="o">-&gt;</span><span class="na">supportQuotes</span><span class="p">()</span>
3909 </code></pre></div></td></tr></table></div>
3910 <h3 id="wysiwygformfield"><code>WysiwygFormField</code><a class="headerlink" href="#wysiwygformfield" title="Permanent link">#</a></h3>
3911 <p><code>WysiwygFormField</code> is used for wysiwyg editor form fields.
3912 This class should, in general, not be used directly but only via <code>WysiwygFormContainer</code>.
3913 The class implements <code>IAttributeFormField</code>, <code>IMaximumLengthFormField</code>, <code>IMinimumLengthFormField</code>, and <code>IObjectTypeFormNode</code> and requires an object type of the object type definition <code>com.woltlab.wcf.message</code>.
3914 The following methods are specific to this form field class:</p>
3915 <ul>
3916 <li><code>autosaveId($autosaveId)</code> and <code>getAutosaveId()</code> can be used enable automatically saving the current editor contents in the browser using the given id.
3917   An empty string signals that autosaving is disabled.</li>
3918 <li><code>lastEditTime($lastEditTime)</code> and <code>getLastEditTime()</code> can be used to set the last time the contents have been edited and saved so that the JavaScript can determine if the contents stored in the browser are older or newer.
3919   <code>0</code> signals that no last edit time has been set.</li>
3920 <li>
3921 <p><code>supportAttachments($supportAttachments)</code> and <code>supportsAttachments()</code> can be used to set and check if the form field supports attachments.</p>
3922 <div class="admonition warning">
3923 <p class="admonition-title">It is not sufficient to simply signal attachment support via these methods for attachments to work. These methods are relevant internally to signal the Javascript code that the editor supports attachments. Actual attachment support is provided by <code>WysiwygAttachmentFormField</code>.</p>
3924 </div>
3925 </li>
3926 <li>
3927 <p><code>supportMentions($supportMentions)</code> and <code>supportsMentions()</code> can be used to set and check if the form field supports mentions of other users.</p>
3928 </li>
3929 </ul>
3930 <p><code>WysiwygFormField</code> objects register a <a href="../validation_data/#customformfielddataprocessor">custom form field data processor</a> to add the relevant simple ACL data array into the <code>$parameters</code> array directly using the object property as the array key.</p>
3931 <h3 id="twysiwygformnode"><code>TWysiwygFormNode</code><a class="headerlink" href="#twysiwygformnode" title="Permanent link">#</a></h3>
3932 <p>All form nodes that need to know the id of the <code>WysiwygFormField</code> field should use <code>TWysiwygFormNode</code>.
3933 This trait provides <code>getWysiwygId()</code> and <code>wysiwygId($wysiwygId)</code> to get and set the relevant wysiwyg editor id.</p>
3934 <h2 id="application-specific-form-fields">Application-Specific Form Fields<a class="headerlink" href="#application-specific-form-fields" title="Permanent link">#</a></h2>
3935 <h3 id="woltlab-suite-forum">WoltLab Suite Forum<a class="headerlink" href="#woltlab-suite-forum" title="Permanent link">#</a></h3>
3936 <h4 id="multipleboardselectionformfield"><code>MultipleBoardSelectionFormField</code><a class="headerlink" href="#multipleboardselectionformfield" title="Permanent link">#</a></h4>
3937 <div class="admonition info">
3938 <p class="admonition-title">Only available since version 5.5.</p>
3939 </div>
3940 <p><code>MultipleBoardSelectionFormField</code> is used to select multiple forums.
3941 The class implements <code>IAttributeFormField</code>, <code>ICssClassFormField</code>, and <code>IImmutableFormField</code>.</p>
3942 <p>The field supports additional settings:</p>
3943 <ul>
3944 <li><code>boardNodeList(BoardNodeList $boardNodeList): self</code> and <code>getBoardNodeList(): BoardNodeList</code> are used to set and get the list of board nodes used to render the board selection.
3945   <code>boardNodeList(BoardNodeList $boardNodeList): self</code> will automatically call <code>readNodeTree()</code> on the given board node list.</li>
3946 <li><code>categoriesSelectable(bool $categoriesSelectable = true): self</code> and <code>areCategoriesSelectable(): bool</code> are used to set and check if the categories in the board node list are selectable.
3947   By default, categories are selectable.
3948   This option is useful if only actual boards, in which threads can be posted, should be selectable but the categories must still be shown so that the overall forum structure is still properly shown.</li>
3949 <li><code>supportExternalLinks(bool $supportExternalLinks): self</code> and <code>supportsExternalLinks(): bool</code> are used to set and check if external links will be shown in the selection list.
3950   By default, external links are shown.
3951   Like in the example given before, in cases where only actual boards, in which threads can be posted, are relevant, this option allows to exclude external links.</li>
3952 </ul>
3953 <h2 id="single-use-form-fields">Single-Use Form Fields<a class="headerlink" href="#single-use-form-fields" title="Permanent link">#</a></h2>
3954 <p>The following form fields are specific for certain forms and hardly reusable in other contexts.</p>
3955 <h3 id="bbcodeattributesformfield"><code>BBCodeAttributesFormField</code><a class="headerlink" href="#bbcodeattributesformfield" title="Permanent link">#</a></h3>
3956 <p><code>DevtoolsProjectExcludedPackagesFormField</code> is a form field for setting the attributes of a BBCode.</p>
3957 <h3 id="devtoolsprojectexcludedpackagesformfield"><code>DevtoolsProjectExcludedPackagesFormField</code><a class="headerlink" href="#devtoolsprojectexcludedpackagesformfield" title="Permanent link">#</a></h3>
3958 <p><code>DevtoolsProjectExcludedPackagesFormField</code> is a form field for setting the excluded packages of a devtools project.</p>
3959 <h3 id="devtoolsprojectinstructionsformfield"><code>DevtoolsProjectInstructionsFormField</code><a class="headerlink" href="#devtoolsprojectinstructionsformfield" title="Permanent link">#</a></h3>
3960 <p><code>DevtoolsProjectExcludedPackagesFormField</code> is a form field for setting the installation and update instructions of a devtools project.</p>
3961 <h3 id="devtoolsprojectoptionalpackagesformfield"><code>DevtoolsProjectOptionalPackagesFormField</code><a class="headerlink" href="#devtoolsprojectoptionalpackagesformfield" title="Permanent link">#</a></h3>
3962 <p><code>DevtoolsProjectExcludedPackagesFormField</code> is a form field for setting the optional packages of a devtools project.</p>
3963 <h3 id="devtoolsprojectrequiredpackagesformfield"><code>DevtoolsProjectRequiredPackagesFormField</code><a class="headerlink" href="#devtoolsprojectrequiredpackagesformfield" title="Permanent link">#</a></h3>
3964 <p><code>DevtoolsProjectExcludedPackagesFormField</code> is a form field for setting the required packages of a devtools project.</p>
3965
3966   <hr>
3967 <div class="md-source-file">
3968   <small>
3969
3970       Last update:
3971       2023-03-06
3972
3973   </small>
3974 </div>
3975
3976
3977
3978
3979
3980
3981               </article>
3982             </div>
3983
3984
3985         </div>
3986
3987       </main>
3988
3989         <footer class="md-footer">
3990
3991   <div class="md-footer-meta md-typeset">
3992     <div class="md-footer-meta__inner md-grid">
3993       <div class="md-copyright">
3994
3995     <div class="md-copyright__highlight">
3996       Copyright © 2020 WoltLab GmbH
3997     </div>
3998
3999
4000     Made with
4001     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
4002       Material for MkDocs
4003     </a>
4004
4005 </div>
4006
4007         <div class="md-copyright">
4008         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
4009         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
4010 </div>
4011
4012     </div>
4013   </div>
4014 </footer>
4015
4016     </div>
4017     <div class="md-dialog" data-md-component="dialog">
4018       <div class="md-dialog__inner md-typeset"></div>
4019     </div>
4020
4021     <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tracking"], "search": "../../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
4022
4023
4024       <script src="../../../../assets/javascripts/bundle.51198bba.min.js"></script>
4025
4026
4027   </body>
4028 </html>