6.1/view/templates/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.1/view/templates/">
  12
  13
  14         <link rel="prev" href="../languages/">
  15
  16
  17         <link rel="next" href="../template-modifiers/">
  18
  19
  20       <link rel="icon" href="../../assets/default.favicon.ico">
  21       <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.2">
  22
  23
  24
  25         <title>Templates - WoltLab Suite Documentation</title>
  26
  27
  28
  29       <link rel="stylesheet" href="../../assets/stylesheets/main.d451bc0e.min.css">
  30
  31
  32         <link rel="stylesheet" href="../../assets/stylesheets/palette.a5377069.min.css">
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45       <link rel="stylesheet" href="../../stylesheets/extra.css">
  46
  47     <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>
  48
  49
  50
  51
  52
  53
  54   </head>
  55
  56
  57
  58
  59
  60
  61
  62     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  63
  64
  65
  66     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  67     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  68     <label class="md-overlay" for="__drawer"></label>
  69     <div data-md-component="skip">
  70
  71
  72         <a href="#templates" class="md-skip">
  73           Skip to content
  74         </a>
  75
  76     </div>
  77     <div data-md-component="announce">
  78
  79         <aside class="md-banner">
  80           <div class="md-banner__inner md-grid md-typeset">
  81
  82
  83     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  84
  85           </div>
  86
  87         </aside>
  88
  89     </div>
  90
  91       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  92
  93       </div>
  94
  95
  96
  97
  98
  99
 100 <header class="md-header md-header--shadow" data-md-component="header">
 101   <nav class="md-header__inner md-grid" aria-label="Header">
 102     <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 103
 104   <img src="../../assets/logo.png" alt="logo">
 105
 106     </a>
 107     <label class="md-header__button md-icon" for="__drawer">
 108
 109       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 110     </label>
 111     <div class="md-header__title" data-md-component="header-title">
 112       <div class="md-header__ellipsis">
 113         <div class="md-header__topic">
 114           <span class="md-ellipsis">
 115             WoltLab Suite Documentation
 116           </span>
 117         </div>
 118         <div class="md-header__topic" data-md-component="header-topic">
 119           <span class="md-ellipsis">
 120
 121               Templates
 122
 123           </span>
 124         </div>
 125       </div>
 126     </div>
 127
 128
 129
 130
 131
 132       <label class="md-header__button md-icon" for="__search">
 133
 134         <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>
 135       </label>
 136       <div class="md-search" data-md-component="search" role="dialog">
 137   <label class="md-search__overlay" for="__search"></label>
 138   <div class="md-search__inner" role="search">
 139     <form class="md-search__form" name="search">
 140       <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>
 141       <label class="md-search__icon md-icon" for="__search">
 142
 143         <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>
 144
 145         <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>
 146       </label>
 147       <nav class="md-search__options" aria-label="Search">
 148
 149         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 150
 151           <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>
 152         </button>
 153       </nav>
 154
 155     </form>
 156     <div class="md-search__output">
 157       <div class="md-search__scrollwrap" data-md-scrollfix>
 158         <div class="md-search-result" data-md-component="search-result">
 159           <div class="md-search-result__meta">
 160             Initializing search
 161           </div>
 162           <ol class="md-search-result__list" role="presentation"></ol>
 163         </div>
 164       </div>
 165     </div>
 166   </div>
 167 </div>
 168
 169
 170       <div class="md-header__source">
 171         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 172   <div class="md-source__icon md-icon">
 173
 174     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 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>
 175   </div>
 176   <div class="md-source__repository">
 177     GitHub
 178   </div>
 179 </a>
 180       </div>
 181
 182   </nav>
 183
 184 </header>
 185
 186     <div class="md-container" data-md-component="container">
 187
 188
 189
 190
 191
 192
 193       <main class="md-main" data-md-component="main">
 194         <div class="md-main__inner md-grid">
 195
 196
 197
 198               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 199                 <div class="md-sidebar__scrollwrap">
 200                   <div class="md-sidebar__inner">
 201
 202
 203
 204
 205 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 206   <label class="md-nav__title" for="__drawer">
 207     <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 208
 209   <img src="../../assets/logo.png" alt="logo">
 210
 211     </a>
 212     WoltLab Suite Documentation
 213   </label>
 214
 215     <div class="md-nav__source">
 216       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 217   <div class="md-source__icon md-icon">
 218
 219     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 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>
 220   </div>
 221   <div class="md-source__repository">
 222     GitHub
 223   </div>
 224 </a>
 225     </div>
 226
 227   <ul class="md-nav__list" data-md-scrollfix>
 228
 229
 230
 231
 232
 233
 234     <li class="md-nav__item">
 235       <a href="../../getting-started/" class="md-nav__link">
 236
 237
 238   <span class="md-ellipsis">
 239     Getting Started
 240   </span>
 241
 242
 243       </a>
 244     </li>
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258     <li class="md-nav__item md-nav__item--nested">
 259
 260
 261
 262
 263         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 264
 265
 266           <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 267
 268
 269   <span class="md-ellipsis">
 270     PHP API
 271   </span>
 272
 273
 274             <span class="md-nav__icon md-icon"></span>
 275           </label>
 276
 277         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 278           <label class="md-nav__title" for="__nav_2">
 279             <span class="md-nav__icon md-icon"></span>
 280             PHP API
 281           </label>
 282           <ul class="md-nav__list" data-md-scrollfix>
 283
 284
 285
 286
 287
 288
 289     <li class="md-nav__item">
 290       <a href="../../php/pages/" class="md-nav__link">
 291
 292
 293   <span class="md-ellipsis">
 294     Pages
 295   </span>
 296
 297
 298       </a>
 299     </li>
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309     <li class="md-nav__item">
 310       <a href="../../php/database-objects/" class="md-nav__link">
 311
 312
 313   <span class="md-ellipsis">
 314     Database Objects
 315   </span>
 316
 317
 318       </a>
 319     </li>
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329     <li class="md-nav__item">
 330       <a href="../../php/database-access/" class="md-nav__link">
 331
 332
 333   <span class="md-ellipsis">
 334     Database Access
 335   </span>
 336
 337
 338       </a>
 339     </li>
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349     <li class="md-nav__item">
 350       <a href="../../php/exceptions/" class="md-nav__link">
 351
 352
 353   <span class="md-ellipsis">
 354     Exceptions
 355   </span>
 356
 357
 358       </a>
 359     </li>
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374     <li class="md-nav__item md-nav__item--nested">
 375
 376
 377
 378
 379         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 380
 381
 382           <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 383
 384
 385   <span class="md-ellipsis">
 386     API
 387   </span>
 388
 389
 390             <span class="md-nav__icon md-icon"></span>
 391           </label>
 392
 393         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 394           <label class="md-nav__title" for="__nav_2_5">
 395             <span class="md-nav__icon md-icon"></span>
 396             API
 397           </label>
 398           <ul class="md-nav__list" data-md-scrollfix>
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410     <li class="md-nav__item md-nav__item--nested">
 411
 412
 413
 414
 415         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 416
 417
 418           <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 419
 420
 421   <span class="md-ellipsis">
 422     Caches
 423   </span>
 424
 425
 426             <span class="md-nav__icon md-icon"></span>
 427           </label>
 428
 429         <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 430           <label class="md-nav__title" for="__nav_2_5_1">
 431             <span class="md-nav__icon md-icon"></span>
 432             Caches
 433           </label>
 434           <ul class="md-nav__list" data-md-scrollfix>
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../php/api/caches/" class="md-nav__link">
 443
 444
 445   <span class="md-ellipsis">
 446     Overview
 447   </span>
 448
 449
 450       </a>
 451     </li>
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461     <li class="md-nav__item">
 462       <a href="../../php/api/caches_persistent-caches/" class="md-nav__link">
 463
 464
 465   <span class="md-ellipsis">
 466     Persistent Caches
 467   </span>
 468
 469
 470       </a>
 471     </li>
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481     <li class="md-nav__item">
 482       <a href="../../php/api/caches_runtime-caches/" class="md-nav__link">
 483
 484
 485   <span class="md-ellipsis">
 486     Runtime Caches
 487   </span>
 488
 489
 490       </a>
 491     </li>
 492
 493
 494
 495
 496           </ul>
 497         </nav>
 498
 499     </li>
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509     <li class="md-nav__item">
 510       <a href="../../php/api/comments/" class="md-nav__link">
 511
 512
 513   <span class="md-ellipsis">
 514     Comments
 515   </span>
 516
 517
 518       </a>
 519     </li>
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529     <li class="md-nav__item">
 530       <a href="../../php/api/cronjobs/" class="md-nav__link">
 531
 532
 533   <span class="md-ellipsis">
 534     Cronjobs
 535   </span>
 536
 537
 538       </a>
 539     </li>
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549     <li class="md-nav__item">
 550       <a href="../../php/api/events/" class="md-nav__link">
 551
 552
 553   <span class="md-ellipsis">
 554     Events
 555   </span>
 556
 557
 558       </a>
 559     </li>
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574     <li class="md-nav__item md-nav__item--nested">
 575
 576
 577
 578
 579         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 580
 581
 582           <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 583
 584
 585   <span class="md-ellipsis">
 586     Form Builder
 587   </span>
 588
 589
 590             <span class="md-nav__icon md-icon"></span>
 591           </label>
 592
 593         <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 594           <label class="md-nav__title" for="__nav_2_5_5">
 595             <span class="md-nav__icon md-icon"></span>
 596             Form Builder
 597           </label>
 598           <ul class="md-nav__list" data-md-scrollfix>
 599
 600
 601
 602
 603
 604
 605     <li class="md-nav__item">
 606       <a href="../../php/api/form_builder/overview/" class="md-nav__link">
 607
 608
 609   <span class="md-ellipsis">
 610     Overview
 611   </span>
 612
 613
 614       </a>
 615     </li>
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625     <li class="md-nav__item">
 626       <a href="../../php/api/form_builder/structure/" class="md-nav__link">
 627
 628
 629   <span class="md-ellipsis">
 630     Structure
 631   </span>
 632
 633
 634       </a>
 635     </li>
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645     <li class="md-nav__item">
 646       <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
 647
 648
 649   <span class="md-ellipsis">
 650     Fields
 651   </span>
 652
 653
 654       </a>
 655     </li>
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665     <li class="md-nav__item">
 666       <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
 667
 668
 669   <span class="md-ellipsis">
 670     Validation and Data
 671   </span>
 672
 673
 674       </a>
 675     </li>
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685     <li class="md-nav__item">
 686       <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
 687
 688
 689   <span class="md-ellipsis">
 690     Dependencies
 691   </span>
 692
 693
 694       </a>
 695     </li>
 696
 697
 698
 699
 700           </ul>
 701         </nav>
 702
 703     </li>
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713     <li class="md-nav__item">
 714       <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
 715
 716
 717   <span class="md-ellipsis">
 718     Package Installation Plugins
 719   </span>
 720
 721
 722       </a>
 723     </li>
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733     <li class="md-nav__item">
 734       <a href="../../php/api/user_activity_points/" class="md-nav__link">
 735
 736
 737   <span class="md-ellipsis">
 738     User Activity Points
 739   </span>
 740
 741
 742       </a>
 743     </li>
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753     <li class="md-nav__item">
 754       <a href="../../php/api/user_notifications/" class="md-nav__link">
 755
 756
 757   <span class="md-ellipsis">
 758     User Notifications
 759   </span>
 760
 761
 762       </a>
 763     </li>
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773     <li class="md-nav__item">
 774       <a href="../../php/api/rss_feeds/" class="md-nav__link">
 775
 776
 777   <span class="md-ellipsis">
 778     RSS Feeds
 779   </span>
 780
 781
 782       </a>
 783     </li>
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793     <li class="md-nav__item">
 794       <a href="../../php/api/sitemaps/" class="md-nav__link">
 795
 796
 797   <span class="md-ellipsis">
 798     Sitemaps
 799   </span>
 800
 801
 802       </a>
 803     </li>
 804
 805
 806
 807
 808           </ul>
 809         </nav>
 810
 811     </li>
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821     <li class="md-nav__item">
 822       <a href="../../php/code-style/" class="md-nav__link">
 823
 824
 825   <span class="md-ellipsis">
 826     Code Style
 827   </span>
 828
 829
 830       </a>
 831     </li>
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841     <li class="md-nav__item">
 842       <a href="../../php/apps/" class="md-nav__link">
 843
 844
 845   <span class="md-ellipsis">
 846     Apps
 847   </span>
 848
 849
 850       </a>
 851     </li>
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861     <li class="md-nav__item">
 862       <a href="../../php/gdpr/" class="md-nav__link">
 863
 864
 865   <span class="md-ellipsis">
 866     GDPR
 867   </span>
 868
 869
 870       </a>
 871     </li>
 872
 873
 874
 875
 876           </ul>
 877         </nav>
 878
 879     </li>
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 896
 897
 898
 899
 900         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
 901
 902
 903           <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 904
 905
 906   <span class="md-ellipsis">
 907     Languages, Templates & CSS
 908   </span>
 909
 910
 911             <span class="md-nav__icon md-icon"></span>
 912           </label>
 913
 914         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
 915           <label class="md-nav__title" for="__nav_3">
 916             <span class="md-nav__icon md-icon"></span>
 917             Languages, Templates & CSS
 918           </label>
 919           <ul class="md-nav__list" data-md-scrollfix>
 920
 921
 922
 923
 924
 925
 926     <li class="md-nav__item">
 927       <a href="../languages/" class="md-nav__link">
 928
 929
 930   <span class="md-ellipsis">
 931     Languages
 932   </span>
 933
 934
 935       </a>
 936     </li>
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948     <li class="md-nav__item md-nav__item--active">
 949
 950       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
 951
 952
 953
 954
 955
 956         <label class="md-nav__link md-nav__link--active" for="__toc">
 957
 958
 959   <span class="md-ellipsis">
 960     Templates
 961   </span>
 962
 963
 964           <span class="md-nav__icon md-icon"></span>
 965         </label>
 966
 967       <a href="./" class="md-nav__link md-nav__link--active">
 968
 969
 970   <span class="md-ellipsis">
 971     Templates
 972   </span>
 973
 974
 975       </a>
 976
 977
 978
 979 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 980
 981
 982
 983
 984
 985
 986     <label class="md-nav__title" for="__toc">
 987       <span class="md-nav__icon md-icon"></span>
 988       Table of contents
 989     </label>
 990     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 991
 992         <li class="md-nav__item">
 993   <a href="#template-types-and-conventions" class="md-nav__link">
 994     Template Types and Conventions
 995   </a>
 996
 997 </li>
 998
 999         <li class="md-nav__item">
1000   <a href="#installing-templates" class="md-nav__link">
1001     Installing Templates
1002   </a>
1003
1004 </li>
1005
1006         <li class="md-nav__item">
1007   <a href="#base-templates" class="md-nav__link">
1008     Base Templates
1009   </a>
1010
1011     <nav class="md-nav" aria-label="Base Templates">
1012       <ul class="md-nav__list">
1013
1014           <li class="md-nav__item">
1015   <a href="#frontend" class="md-nav__link">
1016     Frontend
1017   </a>
1018
1019 </li>
1020
1021           <li class="md-nav__item">
1022   <a href="#backend" class="md-nav__link">
1023     Backend
1024   </a>
1025
1026 </li>
1027
1028       </ul>
1029     </nav>
1030
1031 </li>
1032
1033         <li class="md-nav__item">
1034   <a href="#common-template-components" class="md-nav__link">
1035     Common Template Components
1036   </a>
1037
1038     <nav class="md-nav" aria-label="Common Template Components">
1039       <ul class="md-nav__list">
1040
1041           <li class="md-nav__item">
1042   <a href="#forms" class="md-nav__link">
1043     Forms
1044   </a>
1045
1046 </li>
1047
1048           <li class="md-nav__item">
1049   <a href="#tab-menus" class="md-nav__link">
1050     Tab Menus
1051   </a>
1052
1053 </li>
1054
1055       </ul>
1056     </nav>
1057
1058 </li>
1059
1060         <li class="md-nav__item">
1061   <a href="#template-scripting" class="md-nav__link">
1062     Template Scripting
1063   </a>
1064
1065     <nav class="md-nav" aria-label="Template Scripting">
1066       <ul class="md-nav__list">
1067
1068           <li class="md-nav__item">
1069   <a href="#template-variables" class="md-nav__link">
1070     Template Variables
1071   </a>
1072
1073     <nav class="md-nav" aria-label="Template Variables">
1074       <ul class="md-nav__list">
1075
1076           <li class="md-nav__item">
1077   <a href="#modifiers" class="md-nav__link">
1078     Modifiers
1079   </a>
1080
1081 </li>
1082
1083           <li class="md-nav__item">
1084   <a href="#system-template-variable" class="md-nav__link">
1085     System Template Variable
1086   </a>
1087
1088 </li>
1089
1090       </ul>
1091     </nav>
1092
1093 </li>
1094
1095           <li class="md-nav__item">
1096   <a href="#comments" class="md-nav__link">
1097     Comments
1098   </a>
1099
1100 </li>
1101
1102           <li class="md-nav__item">
1103   <a href="#conditions" class="md-nav__link">
1104     Conditions
1105   </a>
1106
1107 </li>
1108
1109           <li class="md-nav__item">
1110   <a href="#foreach-loops" class="md-nav__link">
1111     Foreach Loops
1112   </a>
1113
1114 </li>
1115
1116           <li class="md-nav__item">
1117   <a href="#including-other-templates" class="md-nav__link">
1118     Including Other Templates
1119   </a>
1120
1121 </li>
1122
1123           <li class="md-nav__item">
1124   <a href="#template-plugins" class="md-nav__link">
1125     Template Plugins
1126   </a>
1127
1128 </li>
1129
1130       </ul>
1131     </nav>
1132
1133 </li>
1134
1135     </ul>
1136
1137 </nav>
1138
1139     </li>
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149     <li class="md-nav__item">
1150       <a href="../template-modifiers/" class="md-nav__link">
1151
1152
1153   <span class="md-ellipsis">
1154     Template Modifiers
1155   </span>
1156
1157
1158       </a>
1159     </li>
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169     <li class="md-nav__item">
1170       <a href="../template-plugins/" class="md-nav__link">
1171
1172
1173   <span class="md-ellipsis">
1174     Template Plugins
1175   </span>
1176
1177
1178       </a>
1179     </li>
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189     <li class="md-nav__item">
1190       <a href="../css/" class="md-nav__link">
1191
1192
1193   <span class="md-ellipsis">
1194     CSS
1195   </span>
1196
1197
1198       </a>
1199     </li>
1200
1201
1202
1203
1204           </ul>
1205         </nav>
1206
1207     </li>
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221     <li class="md-nav__item md-nav__item--nested">
1222
1223
1224
1225
1226         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
1227
1228
1229           <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
1230
1231
1232   <span class="md-ellipsis">
1233     TypeScript and JavaScript API
1234   </span>
1235
1236
1237             <span class="md-nav__icon md-icon"></span>
1238           </label>
1239
1240         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
1241           <label class="md-nav__title" for="__nav_4">
1242             <span class="md-nav__icon md-icon"></span>
1243             TypeScript and JavaScript API
1244           </label>
1245           <ul class="md-nav__list" data-md-scrollfix>
1246
1247
1248
1249
1250
1251
1252     <li class="md-nav__item">
1253       <a href="../../javascript/general-usage/" class="md-nav__link">
1254
1255
1256   <span class="md-ellipsis">
1257     General Usage
1258   </span>
1259
1260
1261       </a>
1262     </li>
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272     <li class="md-nav__item">
1273       <a href="../../javascript/typescript/" class="md-nav__link">
1274
1275
1276   <span class="md-ellipsis">
1277     TypeScript
1278   </span>
1279
1280
1281       </a>
1282     </li>
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297     <li class="md-nav__item md-nav__item--nested">
1298
1299
1300
1301
1302         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
1303
1304
1305           <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
1306
1307
1308   <span class="md-ellipsis">
1309     Components
1310   </span>
1311
1312
1313             <span class="md-nav__icon md-icon"></span>
1314           </label>
1315
1316         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
1317           <label class="md-nav__title" for="__nav_4_3">
1318             <span class="md-nav__icon md-icon"></span>
1319             Components
1320           </label>
1321           <ul class="md-nav__list" data-md-scrollfix>
1322
1323
1324
1325
1326
1327
1328     <li class="md-nav__item">
1329       <a href="../../javascript/components_ckeditor5/" class="md-nav__link">
1330
1331
1332   <span class="md-ellipsis">
1333     CKEditor 5
1334   </span>
1335
1336
1337       </a>
1338     </li>
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348     <li class="md-nav__item">
1349       <a href="../../javascript/components_confirmation/" class="md-nav__link">
1350
1351
1352   <span class="md-ellipsis">
1353     Confirmation
1354   </span>
1355
1356
1357       </a>
1358     </li>
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368     <li class="md-nav__item">
1369       <a href="../../javascript/components_dialog/" class="md-nav__link">
1370
1371
1372   <span class="md-ellipsis">
1373     Dialog
1374   </span>
1375
1376
1377       </a>
1378     </li>
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388     <li class="md-nav__item">
1389       <a href="../../javascript/components_google_maps/" class="md-nav__link">
1390
1391
1392   <span class="md-ellipsis">
1393     Google Maps
1394   </span>
1395
1396
1397       </a>
1398     </li>
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408     <li class="md-nav__item">
1409       <a href="../../javascript/components_pagination/" class="md-nav__link">
1410
1411
1412   <span class="md-ellipsis">
1413     Pagination
1414   </span>
1415
1416
1417       </a>
1418     </li>
1419
1420
1421
1422
1423           </ul>
1424         </nav>
1425
1426     </li>
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441     <li class="md-nav__item md-nav__item--nested">
1442
1443
1444
1445
1446         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
1447
1448
1449           <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
1450
1451
1452   <span class="md-ellipsis">
1453     New API
1454   </span>
1455
1456
1457             <span class="md-nav__icon md-icon"></span>
1458           </label>
1459
1460         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
1461           <label class="md-nav__title" for="__nav_4_4">
1462             <span class="md-nav__icon md-icon"></span>
1463             New API
1464           </label>
1465           <ul class="md-nav__list" data-md-scrollfix>
1466
1467
1468
1469
1470
1471
1472     <li class="md-nav__item">
1473       <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
1474
1475
1476   <span class="md-ellipsis">
1477     Writing a module
1478   </span>
1479
1480
1481       </a>
1482     </li>
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492     <li class="md-nav__item">
1493       <a href="../../javascript/new-api_core/" class="md-nav__link">
1494
1495
1496   <span class="md-ellipsis">
1497     Core Functions
1498   </span>
1499
1500
1501       </a>
1502     </li>
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512     <li class="md-nav__item">
1513       <a href="../../javascript/new-api_dom/" class="md-nav__link">
1514
1515
1516   <span class="md-ellipsis">
1517     DOM
1518   </span>
1519
1520
1521       </a>
1522     </li>
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532     <li class="md-nav__item">
1533       <a href="../../javascript/new-api_events/" class="md-nav__link">
1534
1535
1536   <span class="md-ellipsis">
1537     Event Handling
1538   </span>
1539
1540
1541       </a>
1542     </li>
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552     <li class="md-nav__item">
1553       <a href="../../javascript/new-api_ajax/" class="md-nav__link">
1554
1555
1556   <span class="md-ellipsis">
1557     Ajax
1558   </span>
1559
1560
1561       </a>
1562     </li>
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572     <li class="md-nav__item">
1573       <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
1574
1575
1576   <span class="md-ellipsis">
1577     Dialogs
1578   </span>
1579
1580
1581       </a>
1582     </li>
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592     <li class="md-nav__item">
1593       <a href="../../javascript/new-api_browser/" class="md-nav__link">
1594
1595
1596   <span class="md-ellipsis">
1597     Browser and Screen Sizes
1598   </span>
1599
1600
1601       </a>
1602     </li>
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612     <li class="md-nav__item">
1613       <a href="../../javascript/new-api_ui/" class="md-nav__link">
1614
1615
1616   <span class="md-ellipsis">
1617     User Interface
1618   </span>
1619
1620
1621       </a>
1622     </li>
1623
1624
1625
1626
1627           </ul>
1628         </nav>
1629
1630     </li>
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640     <li class="md-nav__item">
1641       <a href="../../javascript/legacy-api/" class="md-nav__link">
1642
1643
1644   <span class="md-ellipsis">
1645     Legacy API
1646   </span>
1647
1648
1649       </a>
1650     </li>
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660     <li class="md-nav__item">
1661       <a href="../../javascript/code-snippets/" class="md-nav__link">
1662
1663
1664   <span class="md-ellipsis">
1665     Code Snippets
1666   </span>
1667
1668
1669       </a>
1670     </li>
1671
1672
1673
1674
1675           </ul>
1676         </nav>
1677
1678     </li>
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692     <li class="md-nav__item md-nav__item--nested">
1693
1694
1695
1696
1697         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1698
1699
1700           <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1701
1702
1703   <span class="md-ellipsis">
1704     Package Components
1705   </span>
1706
1707
1708             <span class="md-nav__icon md-icon"></span>
1709           </label>
1710
1711         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1712           <label class="md-nav__title" for="__nav_5">
1713             <span class="md-nav__icon md-icon"></span>
1714             Package Components
1715           </label>
1716           <ul class="md-nav__list" data-md-scrollfix>
1717
1718
1719
1720
1721
1722
1723     <li class="md-nav__item">
1724       <a href="../../package/package-xml/" class="md-nav__link">
1725
1726
1727   <span class="md-ellipsis">
1728     package.xml
1729   </span>
1730
1731
1732       </a>
1733     </li>
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748     <li class="md-nav__item md-nav__item--nested">
1749
1750
1751
1752
1753         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1754
1755
1756           <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1757
1758
1759   <span class="md-ellipsis">
1760     PIPs
1761   </span>
1762
1763
1764             <span class="md-nav__icon md-icon"></span>
1765           </label>
1766
1767         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1768           <label class="md-nav__title" for="__nav_5_2">
1769             <span class="md-nav__icon md-icon"></span>
1770             PIPs
1771           </label>
1772           <ul class="md-nav__list" data-md-scrollfix>
1773
1774
1775
1776
1777
1778
1779     <li class="md-nav__item">
1780       <a href="../../package/pip/" class="md-nav__link">
1781
1782
1783   <span class="md-ellipsis">
1784     Overview
1785   </span>
1786
1787
1788       </a>
1789     </li>
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799     <li class="md-nav__item">
1800       <a href="../../package/pip/acl-option/" class="md-nav__link">
1801
1802
1803   <span class="md-ellipsis">
1804     aclOption
1805   </span>
1806
1807
1808       </a>
1809     </li>
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819     <li class="md-nav__item">
1820       <a href="../../package/pip/acp-menu/" class="md-nav__link">
1821
1822
1823   <span class="md-ellipsis">
1824     acpMenu
1825   </span>
1826
1827
1828       </a>
1829     </li>
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839     <li class="md-nav__item">
1840       <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1841
1842
1843   <span class="md-ellipsis">
1844     acpSearchProvider
1845   </span>
1846
1847
1848       </a>
1849     </li>
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859     <li class="md-nav__item">
1860       <a href="../../package/pip/acp-template/" class="md-nav__link">
1861
1862
1863   <span class="md-ellipsis">
1864     acpTemplate
1865   </span>
1866
1867
1868       </a>
1869     </li>
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879     <li class="md-nav__item">
1880       <a href="../../package/pip/acp-template-delete/" class="md-nav__link">
1881
1882
1883   <span class="md-ellipsis">
1884     acpTemplateDelete
1885   </span>
1886
1887
1888       </a>
1889     </li>
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899     <li class="md-nav__item">
1900       <a href="../../package/pip/bbcode/" class="md-nav__link">
1901
1902
1903   <span class="md-ellipsis">
1904     bbcode
1905   </span>
1906
1907
1908       </a>
1909     </li>
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919     <li class="md-nav__item">
1920       <a href="../../package/pip/box/" class="md-nav__link">
1921
1922
1923   <span class="md-ellipsis">
1924     box
1925   </span>
1926
1927
1928       </a>
1929     </li>
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939     <li class="md-nav__item">
1940       <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1941
1942
1943   <span class="md-ellipsis">
1944     clipboardAction
1945   </span>
1946
1947
1948       </a>
1949     </li>
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959     <li class="md-nav__item">
1960       <a href="../../package/pip/core-object/" class="md-nav__link">
1961
1962
1963   <span class="md-ellipsis">
1964     coreObject
1965   </span>
1966
1967
1968       </a>
1969     </li>
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979     <li class="md-nav__item">
1980       <a href="../../package/pip/cronjob/" class="md-nav__link">
1981
1982
1983   <span class="md-ellipsis">
1984     cronjob
1985   </span>
1986
1987
1988       </a>
1989     </li>
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999     <li class="md-nav__item">
2000       <a href="../../package/pip/database/" class="md-nav__link">
2001
2002
2003   <span class="md-ellipsis">
2004     database
2005   </span>
2006
2007
2008       </a>
2009     </li>
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019     <li class="md-nav__item">
2020       <a href="../../package/pip/event-listener/" class="md-nav__link">
2021
2022
2023   <span class="md-ellipsis">
2024     eventListener
2025   </span>
2026
2027
2028       </a>
2029     </li>
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039     <li class="md-nav__item">
2040       <a href="../../package/pip/file/" class="md-nav__link">
2041
2042
2043   <span class="md-ellipsis">
2044     file
2045   </span>
2046
2047
2048       </a>
2049     </li>
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059     <li class="md-nav__item">
2060       <a href="../../package/pip/file-delete/" class="md-nav__link">
2061
2062
2063   <span class="md-ellipsis">
2064     fileDelete
2065   </span>
2066
2067
2068       </a>
2069     </li>
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079     <li class="md-nav__item">
2080       <a href="../../package/pip/language/" class="md-nav__link">
2081
2082
2083   <span class="md-ellipsis">
2084     language
2085   </span>
2086
2087
2088       </a>
2089     </li>
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099     <li class="md-nav__item">
2100       <a href="../../package/pip/media-provider/" class="md-nav__link">
2101
2102
2103   <span class="md-ellipsis">
2104     mediaProvider
2105   </span>
2106
2107
2108       </a>
2109     </li>
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119     <li class="md-nav__item">
2120       <a href="../../package/pip/menu/" class="md-nav__link">
2121
2122
2123   <span class="md-ellipsis">
2124     menu
2125   </span>
2126
2127
2128       </a>
2129     </li>
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139     <li class="md-nav__item">
2140       <a href="../../package/pip/menu-item/" class="md-nav__link">
2141
2142
2143   <span class="md-ellipsis">
2144     menuItem
2145   </span>
2146
2147
2148       </a>
2149     </li>
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159     <li class="md-nav__item">
2160       <a href="../../package/pip/object-type/" class="md-nav__link">
2161
2162
2163   <span class="md-ellipsis">
2164     objectType
2165   </span>
2166
2167
2168       </a>
2169     </li>
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179     <li class="md-nav__item">
2180       <a href="../../package/pip/object-type-definition/" class="md-nav__link">
2181
2182
2183   <span class="md-ellipsis">
2184     objectTypeDefinition
2185   </span>
2186
2187
2188       </a>
2189     </li>
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199     <li class="md-nav__item">
2200       <a href="../../package/pip/option/" class="md-nav__link">
2201
2202
2203   <span class="md-ellipsis">
2204     option
2205   </span>
2206
2207
2208       </a>
2209     </li>
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219     <li class="md-nav__item">
2220       <a href="../../package/pip/page/" class="md-nav__link">
2221
2222
2223   <span class="md-ellipsis">
2224     page
2225   </span>
2226
2227
2228       </a>
2229     </li>
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239     <li class="md-nav__item">
2240       <a href="../../package/pip/pip/" class="md-nav__link">
2241
2242
2243   <span class="md-ellipsis">
2244     pip
2245   </span>
2246
2247
2248       </a>
2249     </li>
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259     <li class="md-nav__item">
2260       <a href="../../package/pip/script/" class="md-nav__link">
2261
2262
2263   <span class="md-ellipsis">
2264     script
2265   </span>
2266
2267
2268       </a>
2269     </li>
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279     <li class="md-nav__item">
2280       <a href="../../package/pip/smiley/" class="md-nav__link">
2281
2282
2283   <span class="md-ellipsis">
2284     smiley
2285   </span>
2286
2287
2288       </a>
2289     </li>
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299     <li class="md-nav__item">
2300       <a href="../../package/pip/sql/" class="md-nav__link">
2301
2302
2303   <span class="md-ellipsis">
2304     sql
2305   </span>
2306
2307
2308       </a>
2309     </li>
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319     <li class="md-nav__item">
2320       <a href="../../package/pip/style/" class="md-nav__link">
2321
2322
2323   <span class="md-ellipsis">
2324     style
2325   </span>
2326
2327
2328       </a>
2329     </li>
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339     <li class="md-nav__item">
2340       <a href="../../package/pip/template/" class="md-nav__link">
2341
2342
2343   <span class="md-ellipsis">
2344     template
2345   </span>
2346
2347
2348       </a>
2349     </li>
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359     <li class="md-nav__item">
2360       <a href="../../package/pip/template-delete/" class="md-nav__link">
2361
2362
2363   <span class="md-ellipsis">
2364     templateDelete
2365   </span>
2366
2367
2368       </a>
2369     </li>
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379     <li class="md-nav__item">
2380       <a href="../../package/pip/template-listener/" class="md-nav__link">
2381
2382
2383   <span class="md-ellipsis">
2384     templateListener
2385   </span>
2386
2387
2388       </a>
2389     </li>
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399     <li class="md-nav__item">
2400       <a href="../../package/pip/user-group-option/" class="md-nav__link">
2401
2402
2403   <span class="md-ellipsis">
2404     userGroupOption
2405   </span>
2406
2407
2408       </a>
2409     </li>
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419     <li class="md-nav__item">
2420       <a href="../../package/pip/user-menu/" class="md-nav__link">
2421
2422
2423   <span class="md-ellipsis">
2424     userMenu
2425   </span>
2426
2427
2428       </a>
2429     </li>
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439     <li class="md-nav__item">
2440       <a href="../../package/pip/user-notification-event/" class="md-nav__link">
2441
2442
2443   <span class="md-ellipsis">
2444     userNotificationEvent
2445   </span>
2446
2447
2448       </a>
2449     </li>
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459     <li class="md-nav__item">
2460       <a href="../../package/pip/user-option/" class="md-nav__link">
2461
2462
2463   <span class="md-ellipsis">
2464     userOption
2465   </span>
2466
2467
2468       </a>
2469     </li>
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479     <li class="md-nav__item">
2480       <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
2481
2482
2483   <span class="md-ellipsis">
2484     userProfileMenu
2485   </span>
2486
2487
2488       </a>
2489     </li>
2490
2491
2492
2493
2494           </ul>
2495         </nav>
2496
2497     </li>
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507     <li class="md-nav__item">
2508       <a href="../../package/database-php-api/" class="md-nav__link">
2509
2510
2511   <span class="md-ellipsis">
2512     Database PHP API
2513   </span>
2514
2515
2516       </a>
2517     </li>
2518
2519
2520
2521
2522           </ul>
2523         </nav>
2524
2525     </li>
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539     <li class="md-nav__item md-nav__item--nested">
2540
2541
2542
2543
2544         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
2545
2546
2547           <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
2548
2549
2550   <span class="md-ellipsis">
2551     Migration
2552   </span>
2553
2554
2555             <span class="md-nav__icon md-icon"></span>
2556           </label>
2557
2558         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
2559           <label class="md-nav__title" for="__nav_6">
2560             <span class="md-nav__icon md-icon"></span>
2561             Migration
2562           </label>
2563           <ul class="md-nav__list" data-md-scrollfix>
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575     <li class="md-nav__item md-nav__item--nested">
2576
2577
2578
2579
2580         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
2581
2582
2583           <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
2584
2585
2586   <span class="md-ellipsis">
2587     From WoltLab Suite 6.0
2588   </span>
2589
2590
2591             <span class="md-nav__icon md-icon"></span>
2592           </label>
2593
2594         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
2595           <label class="md-nav__title" for="__nav_6_1">
2596             <span class="md-nav__icon md-icon"></span>
2597             From WoltLab Suite 6.0
2598           </label>
2599           <ul class="md-nav__list" data-md-scrollfix>
2600
2601
2602
2603
2604
2605
2606     <li class="md-nav__item">
2607       <a href="../../migration/wsc60/php/" class="md-nav__link">
2608
2609
2610   <span class="md-ellipsis">
2611     PHP API
2612   </span>
2613
2614
2615       </a>
2616     </li>
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626     <li class="md-nav__item">
2627       <a href="../../migration/wsc60/templates/" class="md-nav__link">
2628
2629
2630   <span class="md-ellipsis">
2631     Templates
2632   </span>
2633
2634
2635       </a>
2636     </li>
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646     <li class="md-nav__item">
2647       <a href="../../migration/wsc60/deprecations_removals/" class="md-nav__link">
2648
2649
2650   <span class="md-ellipsis">
2651     Deprecations and Removals
2652   </span>
2653
2654
2655       </a>
2656     </li>
2657
2658
2659
2660
2661           </ul>
2662         </nav>
2663
2664     </li>
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679     <li class="md-nav__item md-nav__item--nested">
2680
2681
2682
2683
2684         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
2685
2686
2687           <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
2688
2689
2690   <span class="md-ellipsis">
2691     From WoltLab Suite 5.5
2692   </span>
2693
2694
2695             <span class="md-nav__icon md-icon"></span>
2696           </label>
2697
2698         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
2699           <label class="md-nav__title" for="__nav_6_2">
2700             <span class="md-nav__icon md-icon"></span>
2701             From WoltLab Suite 5.5
2702           </label>
2703           <ul class="md-nav__list" data-md-scrollfix>
2704
2705
2706
2707
2708
2709
2710     <li class="md-nav__item">
2711       <a href="../../migration/wsc55/php/" class="md-nav__link">
2712
2713
2714   <span class="md-ellipsis">
2715     PHP API
2716   </span>
2717
2718
2719       </a>
2720     </li>
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730     <li class="md-nav__item">
2731       <a href="../../migration/wsc55/javascript/" class="md-nav__link">
2732
2733
2734   <span class="md-ellipsis">
2735     TypeScript and JavaScript
2736   </span>
2737
2738
2739       </a>
2740     </li>
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750     <li class="md-nav__item">
2751       <a href="../../migration/wsc55/templates/" class="md-nav__link">
2752
2753
2754   <span class="md-ellipsis">
2755     Templates
2756   </span>
2757
2758
2759       </a>
2760     </li>
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770     <li class="md-nav__item">
2771       <a href="../../migration/wsc55/icons/" class="md-nav__link">
2772
2773
2774   <span class="md-ellipsis">
2775     Icons
2776   </span>
2777
2778
2779       </a>
2780     </li>
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790     <li class="md-nav__item">
2791       <a href="../../migration/wsc55/dialogs/" class="md-nav__link">
2792
2793
2794   <span class="md-ellipsis">
2795     Dialogs
2796   </span>
2797
2798
2799       </a>
2800     </li>
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810     <li class="md-nav__item">
2811       <a href="../../migration/wsc55/libraries/" class="md-nav__link">
2812
2813
2814   <span class="md-ellipsis">
2815     Third Party Libraries
2816   </span>
2817
2818
2819       </a>
2820     </li>
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830     <li class="md-nav__item">
2831       <a href="../../migration/wsc55/deprecations_removals/" class="md-nav__link">
2832
2833
2834   <span class="md-ellipsis">
2835     Deprecations and Removals
2836   </span>
2837
2838
2839       </a>
2840     </li>
2841
2842
2843
2844
2845           </ul>
2846         </nav>
2847
2848     </li>
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863     <li class="md-nav__item md-nav__item--nested">
2864
2865
2866
2867
2868         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2869
2870
2871           <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2872
2873
2874   <span class="md-ellipsis">
2875     From WoltLab Suite 5.4
2876   </span>
2877
2878
2879             <span class="md-nav__icon md-icon"></span>
2880           </label>
2881
2882         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2883           <label class="md-nav__title" for="__nav_6_3">
2884             <span class="md-nav__icon md-icon"></span>
2885             From WoltLab Suite 5.4
2886           </label>
2887           <ul class="md-nav__list" data-md-scrollfix>
2888
2889
2890
2891
2892
2893
2894     <li class="md-nav__item">
2895       <a href="../../migration/wsc54/php/" class="md-nav__link">
2896
2897
2898   <span class="md-ellipsis">
2899     PHP API
2900   </span>
2901
2902
2903       </a>
2904     </li>
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914     <li class="md-nav__item">
2915       <a href="../../migration/wsc54/javascript/" class="md-nav__link">
2916
2917
2918   <span class="md-ellipsis">
2919     TypeScript and JavaScript
2920   </span>
2921
2922
2923       </a>
2924     </li>
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934     <li class="md-nav__item">
2935       <a href="../../migration/wsc54/templates/" class="md-nav__link">
2936
2937
2938   <span class="md-ellipsis">
2939     Templates
2940   </span>
2941
2942
2943       </a>
2944     </li>
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954     <li class="md-nav__item">
2955       <a href="../../migration/wsc54/libraries/" class="md-nav__link">
2956
2957
2958   <span class="md-ellipsis">
2959     Third Party Libraries
2960   </span>
2961
2962
2963       </a>
2964     </li>
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974     <li class="md-nav__item">
2975       <a href="../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2976
2977
2978   <span class="md-ellipsis">
2979     Deprecations and Removals
2980   </span>
2981
2982
2983       </a>
2984     </li>
2985
2986
2987
2988
2989           </ul>
2990         </nav>
2991
2992     </li>
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007     <li class="md-nav__item md-nav__item--nested">
3008
3009
3010
3011
3012         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
3013
3014
3015           <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
3016
3017
3018   <span class="md-ellipsis">
3019     From WoltLab Suite 5.3
3020   </span>
3021
3022
3023             <span class="md-nav__icon md-icon"></span>
3024           </label>
3025
3026         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
3027           <label class="md-nav__title" for="__nav_6_4">
3028             <span class="md-nav__icon md-icon"></span>
3029             From WoltLab Suite 5.3
3030           </label>
3031           <ul class="md-nav__list" data-md-scrollfix>
3032
3033
3034
3035
3036
3037
3038     <li class="md-nav__item">
3039       <a href="../../migration/wsc53/php/" class="md-nav__link">
3040
3041
3042   <span class="md-ellipsis">
3043     PHP API
3044   </span>
3045
3046
3047       </a>
3048     </li>
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058     <li class="md-nav__item">
3059       <a href="../../migration/wsc53/session/" class="md-nav__link">
3060
3061
3062   <span class="md-ellipsis">
3063     Session Handling and Authentication
3064   </span>
3065
3066
3067       </a>
3068     </li>
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078     <li class="md-nav__item">
3079       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
3080
3081
3082   <span class="md-ellipsis">
3083     TypeScript and JavaScript
3084   </span>
3085
3086
3087       </a>
3088     </li>
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098     <li class="md-nav__item">
3099       <a href="../../migration/wsc53/templates/" class="md-nav__link">
3100
3101
3102   <span class="md-ellipsis">
3103     Templates
3104   </span>
3105
3106
3107       </a>
3108     </li>
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118     <li class="md-nav__item">
3119       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
3120
3121
3122   <span class="md-ellipsis">
3123     Third Party Libraries
3124   </span>
3125
3126
3127       </a>
3128     </li>
3129
3130
3131
3132
3133           </ul>
3134         </nav>
3135
3136     </li>
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151     <li class="md-nav__item md-nav__item--nested">
3152
3153
3154
3155
3156         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
3157
3158
3159           <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
3160
3161
3162   <span class="md-ellipsis">
3163     From WoltLab Suite 5.2
3164   </span>
3165
3166
3167             <span class="md-nav__icon md-icon"></span>
3168           </label>
3169
3170         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
3171           <label class="md-nav__title" for="__nav_6_5">
3172             <span class="md-nav__icon md-icon"></span>
3173             From WoltLab Suite 5.2
3174           </label>
3175           <ul class="md-nav__list" data-md-scrollfix>
3176
3177
3178
3179
3180
3181
3182     <li class="md-nav__item">
3183       <a href="../../migration/wsc52/php/" class="md-nav__link">
3184
3185
3186   <span class="md-ellipsis">
3187     PHP API
3188   </span>
3189
3190
3191       </a>
3192     </li>
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202     <li class="md-nav__item">
3203       <a href="../../migration/wsc52/templates/" class="md-nav__link">
3204
3205
3206   <span class="md-ellipsis">
3207     Templates and Languages
3208   </span>
3209
3210
3211       </a>
3212     </li>
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222     <li class="md-nav__item">
3223       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
3224
3225
3226   <span class="md-ellipsis">
3227     Third Party Libraries
3228   </span>
3229
3230
3231       </a>
3232     </li>
3233
3234
3235
3236
3237           </ul>
3238         </nav>
3239
3240     </li>
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255     <li class="md-nav__item md-nav__item--nested">
3256
3257
3258
3259
3260         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
3261
3262
3263           <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
3264
3265
3266   <span class="md-ellipsis">
3267     From WoltLab Suite 3.1
3268   </span>
3269
3270
3271             <span class="md-nav__icon md-icon"></span>
3272           </label>
3273
3274         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
3275           <label class="md-nav__title" for="__nav_6_6">
3276             <span class="md-nav__icon md-icon"></span>
3277             From WoltLab Suite 3.1
3278           </label>
3279           <ul class="md-nav__list" data-md-scrollfix>
3280
3281
3282
3283
3284
3285
3286     <li class="md-nav__item">
3287       <a href="../../migration/wsc31/php/" class="md-nav__link">
3288
3289
3290   <span class="md-ellipsis">
3291     PHP API
3292   </span>
3293
3294
3295       </a>
3296     </li>
3297
3298
3299
3300
3301           </ul>
3302         </nav>
3303
3304     </li>
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319     <li class="md-nav__item md-nav__item--nested">
3320
3321
3322
3323
3324         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
3325
3326
3327           <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
3328
3329
3330   <span class="md-ellipsis">
3331     From WoltLab Suite 3.0
3332   </span>
3333
3334
3335             <span class="md-nav__icon md-icon"></span>
3336           </label>
3337
3338         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
3339           <label class="md-nav__title" for="__nav_6_7">
3340             <span class="md-nav__icon md-icon"></span>
3341             From WoltLab Suite 3.0
3342           </label>
3343           <ul class="md-nav__list" data-md-scrollfix>
3344
3345
3346
3347
3348
3349
3350     <li class="md-nav__item">
3351       <a href="../../migration/wsc30/php/" class="md-nav__link">
3352
3353
3354   <span class="md-ellipsis">
3355     PHP API
3356   </span>
3357
3358
3359       </a>
3360     </li>
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370     <li class="md-nav__item">
3371       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
3372
3373
3374   <span class="md-ellipsis">
3375     JavaScript API
3376   </span>
3377
3378
3379       </a>
3380     </li>
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390     <li class="md-nav__item">
3391       <a href="../../migration/wsc30/templates/" class="md-nav__link">
3392
3393
3394   <span class="md-ellipsis">
3395     Templates
3396   </span>
3397
3398
3399       </a>
3400     </li>
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410     <li class="md-nav__item">
3411       <a href="../../migration/wsc30/css/" class="md-nav__link">
3412
3413
3414   <span class="md-ellipsis">
3415     CSS
3416   </span>
3417
3418
3419       </a>
3420     </li>
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430     <li class="md-nav__item">
3431       <a href="../../migration/wsc30/package/" class="md-nav__link">
3432
3433
3434   <span class="md-ellipsis">
3435     Package Components
3436   </span>
3437
3438
3439       </a>
3440     </li>
3441
3442
3443
3444
3445           </ul>
3446         </nav>
3447
3448     </li>
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463     <li class="md-nav__item md-nav__item--nested">
3464
3465
3466
3467
3468         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_8" >
3469
3470
3471           <label class="md-nav__link" for="__nav_6_8" id="__nav_6_8_label" tabindex="0">
3472
3473
3474   <span class="md-ellipsis">
3475     From WCF 2.1
3476   </span>
3477
3478
3479             <span class="md-nav__icon md-icon"></span>
3480           </label>
3481
3482         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_8_label" aria-expanded="false">
3483           <label class="md-nav__title" for="__nav_6_8">
3484             <span class="md-nav__icon md-icon"></span>
3485             From WCF 2.1
3486           </label>
3487           <ul class="md-nav__list" data-md-scrollfix>
3488
3489
3490
3491
3492
3493
3494     <li class="md-nav__item">
3495       <a href="../../migration/wcf21/php/" class="md-nav__link">
3496
3497
3498   <span class="md-ellipsis">
3499     PHP API
3500   </span>
3501
3502
3503       </a>
3504     </li>
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514     <li class="md-nav__item">
3515       <a href="../../migration/wcf21/templates/" class="md-nav__link">
3516
3517
3518   <span class="md-ellipsis">
3519     Templates
3520   </span>
3521
3522
3523       </a>
3524     </li>
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534     <li class="md-nav__item">
3535       <a href="../../migration/wcf21/css/" class="md-nav__link">
3536
3537
3538   <span class="md-ellipsis">
3539     CSS
3540   </span>
3541
3542
3543       </a>
3544     </li>
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554     <li class="md-nav__item">
3555       <a href="../../migration/wcf21/package/" class="md-nav__link">
3556
3557
3558   <span class="md-ellipsis">
3559     Package Components
3560   </span>
3561
3562
3563       </a>
3564     </li>
3565
3566
3567
3568
3569           </ul>
3570         </nav>
3571
3572     </li>
3573
3574
3575
3576
3577           </ul>
3578         </nav>
3579
3580     </li>
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594     <li class="md-nav__item md-nav__item--nested">
3595
3596
3597
3598
3599         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
3600
3601
3602           <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
3603
3604
3605   <span class="md-ellipsis">
3606     Tutorials
3607   </span>
3608
3609
3610             <span class="md-nav__icon md-icon"></span>
3611           </label>
3612
3613         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
3614           <label class="md-nav__title" for="__nav_7">
3615             <span class="md-nav__icon md-icon"></span>
3616             Tutorials
3617           </label>
3618           <ul class="md-nav__list" data-md-scrollfix>
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630     <li class="md-nav__item md-nav__item--nested">
3631
3632
3633
3634
3635         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
3636
3637
3638           <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
3639
3640
3641   <span class="md-ellipsis">
3642     Tutorial Series
3643   </span>
3644
3645
3646             <span class="md-nav__icon md-icon"></span>
3647           </label>
3648
3649         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
3650           <label class="md-nav__title" for="__nav_7_1">
3651             <span class="md-nav__icon md-icon"></span>
3652             Tutorial Series
3653           </label>
3654           <ul class="md-nav__list" data-md-scrollfix>
3655
3656
3657
3658
3659
3660
3661     <li class="md-nav__item">
3662       <a href="../../tutorial/series/overview/" class="md-nav__link">
3663
3664
3665   <span class="md-ellipsis">
3666     Overview
3667   </span>
3668
3669
3670       </a>
3671     </li>
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681     <li class="md-nav__item">
3682       <a href="../../tutorial/series/part_1/" class="md-nav__link">
3683
3684
3685   <span class="md-ellipsis">
3686     Part 1
3687   </span>
3688
3689
3690       </a>
3691     </li>
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701     <li class="md-nav__item">
3702       <a href="../../tutorial/series/part_2/" class="md-nav__link">
3703
3704
3705   <span class="md-ellipsis">
3706     Part 2
3707   </span>
3708
3709
3710       </a>
3711     </li>
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721     <li class="md-nav__item">
3722       <a href="../../tutorial/series/part_3/" class="md-nav__link">
3723
3724
3725   <span class="md-ellipsis">
3726     Part 3
3727   </span>
3728
3729
3730       </a>
3731     </li>
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741     <li class="md-nav__item">
3742       <a href="../../tutorial/series/part_4/" class="md-nav__link">
3743
3744
3745   <span class="md-ellipsis">
3746     Part 4
3747   </span>
3748
3749
3750       </a>
3751     </li>
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761     <li class="md-nav__item">
3762       <a href="../../tutorial/series/part_5/" class="md-nav__link">
3763
3764
3765   <span class="md-ellipsis">
3766     Part 5
3767   </span>
3768
3769
3770       </a>
3771     </li>
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781     <li class="md-nav__item">
3782       <a href="../../tutorial/series/part_6/" class="md-nav__link">
3783
3784
3785   <span class="md-ellipsis">
3786     Part 6
3787   </span>
3788
3789
3790       </a>
3791     </li>
3792
3793
3794
3795
3796           </ul>
3797         </nav>
3798
3799     </li>
3800
3801
3802
3803
3804           </ul>
3805         </nav>
3806
3807     </li>
3808
3809
3810
3811   </ul>
3812 </nav>
3813                   </div>
3814                 </div>
3815               </div>
3816
3817
3818
3819               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
3820                 <div class="md-sidebar__scrollwrap">
3821                   <div class="md-sidebar__inner">
3822
3823
3824 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
3825
3826
3827
3828
3829
3830
3831     <label class="md-nav__title" for="__toc">
3832       <span class="md-nav__icon md-icon"></span>
3833       Table of contents
3834     </label>
3835     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
3836
3837         <li class="md-nav__item">
3838   <a href="#template-types-and-conventions" class="md-nav__link">
3839     Template Types and Conventions
3840   </a>
3841
3842 </li>
3843
3844         <li class="md-nav__item">
3845   <a href="#installing-templates" class="md-nav__link">
3846     Installing Templates
3847   </a>
3848
3849 </li>
3850
3851         <li class="md-nav__item">
3852   <a href="#base-templates" class="md-nav__link">
3853     Base Templates
3854   </a>
3855
3856     <nav class="md-nav" aria-label="Base Templates">
3857       <ul class="md-nav__list">
3858
3859           <li class="md-nav__item">
3860   <a href="#frontend" class="md-nav__link">
3861     Frontend
3862   </a>
3863
3864 </li>
3865
3866           <li class="md-nav__item">
3867   <a href="#backend" class="md-nav__link">
3868     Backend
3869   </a>
3870
3871 </li>
3872
3873       </ul>
3874     </nav>
3875
3876 </li>
3877
3878         <li class="md-nav__item">
3879   <a href="#common-template-components" class="md-nav__link">
3880     Common Template Components
3881   </a>
3882
3883     <nav class="md-nav" aria-label="Common Template Components">
3884       <ul class="md-nav__list">
3885
3886           <li class="md-nav__item">
3887   <a href="#forms" class="md-nav__link">
3888     Forms
3889   </a>
3890
3891 </li>
3892
3893           <li class="md-nav__item">
3894   <a href="#tab-menus" class="md-nav__link">
3895     Tab Menus
3896   </a>
3897
3898 </li>
3899
3900       </ul>
3901     </nav>
3902
3903 </li>
3904
3905         <li class="md-nav__item">
3906   <a href="#template-scripting" class="md-nav__link">
3907     Template Scripting
3908   </a>
3909
3910     <nav class="md-nav" aria-label="Template Scripting">
3911       <ul class="md-nav__list">
3912
3913           <li class="md-nav__item">
3914   <a href="#template-variables" class="md-nav__link">
3915     Template Variables
3916   </a>
3917
3918     <nav class="md-nav" aria-label="Template Variables">
3919       <ul class="md-nav__list">
3920
3921           <li class="md-nav__item">
3922   <a href="#modifiers" class="md-nav__link">
3923     Modifiers
3924   </a>
3925
3926 </li>
3927
3928           <li class="md-nav__item">
3929   <a href="#system-template-variable" class="md-nav__link">
3930     System Template Variable
3931   </a>
3932
3933 </li>
3934
3935       </ul>
3936     </nav>
3937
3938 </li>
3939
3940           <li class="md-nav__item">
3941   <a href="#comments" class="md-nav__link">
3942     Comments
3943   </a>
3944
3945 </li>
3946
3947           <li class="md-nav__item">
3948   <a href="#conditions" class="md-nav__link">
3949     Conditions
3950   </a>
3951
3952 </li>
3953
3954           <li class="md-nav__item">
3955   <a href="#foreach-loops" class="md-nav__link">
3956     Foreach Loops
3957   </a>
3958
3959 </li>
3960
3961           <li class="md-nav__item">
3962   <a href="#including-other-templates" class="md-nav__link">
3963     Including Other Templates
3964   </a>
3965
3966 </li>
3967
3968           <li class="md-nav__item">
3969   <a href="#template-plugins" class="md-nav__link">
3970     Template Plugins
3971   </a>
3972
3973 </li>
3974
3975       </ul>
3976     </nav>
3977
3978 </li>
3979
3980     </ul>
3981
3982 </nav>
3983                   </div>
3984                 </div>
3985               </div>
3986
3987
3988
3989             <div class="md-content" data-md-component="content">
3990               <article class="md-content__inner md-typeset">
3991
3992
3993
3994
3995
3996
3997
3998 <h1 id="templates">Templates<a class="headerlink" href="#templates" title="Permanent link">#</a></h1>
3999 <p>Templates are responsible for the output a user sees when requesting a page (while the PHP code is responsible for providing the data that will be shown).
4000 Templates are text files with <code>.tpl</code> as the file extension.
4001 WoltLab Suite Core compiles the template files once into a PHP file that is executed when a user requests the page.
4002 In subsequent request, as the PHP file containing the compiled template already exists, compiling the template is not necessary anymore.</p>
4003 <h2 id="template-types-and-conventions">Template Types and Conventions<a class="headerlink" href="#template-types-and-conventions" title="Permanent link">#</a></h2>
4004 <p>WoltLab Suite Core supports two types of templates:
4005 frontend templates (or simply <em>templates</em>) and backend templates (<em>ACP templates</em>).
4006 Each type of template is only available in its respective domain, thus frontend templates cannot be included or used in the ACP and vice versa.</p>
4007 <p>For pages and forms, the name of the template matches the unqualified name of the PHP class except for the <code>Page</code> or <code>Form</code> suffix:</p>
4008 <ul>
4009 <li><code>RegisterForm.class.php</code> → <code>register.tpl</code></li>
4010 <li><code>UserPage.class.php</code> → <code>user.tpl</code></li>
4011 </ul>
4012 <p>If you follow this convention, WoltLab Suite Core will automatically determine the template name so that you do not have to explicitly set it.</p>
4013 <div class="admonition info">
4014 <p class="admonition-title">For forms that handle creating and editing objects, in general, there are two form classes: <code>FooAddForm</code> and <code>FooEditForm</code>. WoltLab Suite Core, however, generally only uses one template <code>fooAdd.tpl</code> and the template variable <code>$action</code> to distinguish between creating a new object (<code>$action = 'add'</code>) and editing an existing object (<code>$action = 'edit'</code>) as the differences between templates for adding and editing an object are minimal.</p>
4015 </div>
4016 <h2 id="installing-templates">Installing Templates<a class="headerlink" href="#installing-templates" title="Permanent link">#</a></h2>
4017 <p>Templates and ACP templates are installed by two different package installation plugins:
4018 the <a href="../../package/pip/template/">template PIP</a> and the <a href="../../package/pip/acp-template/">ACP template PIP</a>.
4019 More information about installing templates can be found on those pages. </p>
4020 <h2 id="base-templates">Base Templates<a class="headerlink" href="#base-templates" title="Permanent link">#</a></h2>
4021 <h3 id="frontend">Frontend<a class="headerlink" href="#frontend" title="Permanent link">#</a></h3>
4022 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
4023 <span class="normal">2</span>
4024 <span class="normal">3</span>
4025 <span class="normal">4</span>
4026 <span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;header&#39;</span><span class="cp">}</span>
4027
4028 <span class="cp">{</span><span class="c">* content *</span><span class="cp">}</span>
4029
4030 <span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;footer&#39;</span><span class="cp">}</span>
4031 </code></pre></div></td></tr></table></div>
4032 <h3 id="backend">Backend<a class="headerlink" href="#backend" title="Permanent link">#</a></h3>
4033 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
4034 <span class="normal"> 2</span>
4035 <span class="normal"> 3</span>
4036 <span class="normal"> 4</span>
4037 <span class="normal"> 5</span>
4038 <span class="normal"> 6</span>
4039 <span class="normal"> 7</span>
4040 <span class="normal"> 8</span>
4041 <span class="normal"> 9</span>
4042 <span class="normal">10</span>
4043 <span class="normal">11</span>
4044 <span class="normal">12</span>
4045 <span class="normal">13</span>
4046 <span class="normal">14</span>
4047 <span class="normal">15</span>
4048 <span class="normal">16</span>
4049 <span class="normal">17</span>
4050 <span class="normal">18</span>
4051 <span class="normal">19</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;header&#39;</span> <span class="na">pageTitle</span><span class="o">=</span><span class="s1">&#39;foo.bar.baz&#39;</span><span class="cp">}</span>
4052
4053 <span class="x">&lt;header class=&quot;contentHeader&quot;&gt;</span>
4054 <span class="x">    &lt;div class=&quot;contentHeaderTitle&quot;&gt;</span>
4055 <span class="x">        &lt;h1 class=&quot;contentTitle&quot;&gt;Title&lt;/h1&gt;</span>
4056 <span class="x">    &lt;/div&gt;</span>
4057
4058 <span class="x">    &lt;nav class=&quot;contentHeaderNavigation&quot;&gt;</span>
4059 <span class="x">        &lt;ul&gt;</span>
4060 <span class="x">            </span><span class="cp">{</span><span class="c">* your default content header navigation buttons *</span><span class="cp">}</span>
4061
4062 <span class="x">            </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;contentHeaderNavigation&#39;</span><span class="cp">}</span>
4063 <span class="x">        &lt;/ul&gt;</span>
4064 <span class="x">    &lt;/nav&gt;</span>
4065 <span class="x">&lt;/header&gt;</span>
4066
4067 <span class="cp">{</span><span class="c">* content *</span><span class="cp">}</span>
4068
4069 <span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;footer&#39;</span><span class="cp">}</span>
4070 </code></pre></div></td></tr></table></div>
4071 <p><code>foo.bar.baz</code> is the language item that contains the title of the page.</p>
4072 <h2 id="common-template-components">Common Template Components<a class="headerlink" href="#common-template-components" title="Permanent link">#</a></h2>
4073 <h3 id="forms">Forms<a class="headerlink" href="#forms" title="Permanent link">#</a></h3>
4074 <div class="admonition info">
4075 <p class="admonition-title">For new forms, use the <a href="../../php/api/form_builder/overview/">form builder API</a>.</p>
4076 </div>
4077 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
4078 <span class="normal"> 2</span>
4079 <span class="normal"> 3</span>
4080 <span class="normal"> 4</span>
4081 <span class="normal"> 5</span>
4082 <span class="normal"> 6</span>
4083 <span class="normal"> 7</span>
4084 <span class="normal"> 8</span>
4085 <span class="normal"> 9</span>
4086 <span class="normal">10</span>
4087 <span class="normal">11</span>
4088 <span class="normal">12</span>
4089 <span class="normal">13</span>
4090 <span class="normal">14</span>
4091 <span class="normal">15</span>
4092 <span class="normal">16</span>
4093 <span class="normal">17</span>
4094 <span class="normal">18</span>
4095 <span class="normal">19</span>
4096 <span class="normal">20</span>
4097 <span class="normal">21</span>
4098 <span class="normal">22</span>
4099 <span class="normal">23</span>
4100 <span class="normal">24</span>
4101 <span class="normal">25</span>
4102 <span class="normal">26</span>
4103 <span class="normal">27</span>
4104 <span class="normal">28</span>
4105 <span class="normal">29</span>
4106 <span class="normal">30</span>
4107 <span class="normal">31</span>
4108 <span class="normal">32</span>
4109 <span class="normal">33</span>
4110 <span class="normal">34</span>
4111 <span class="normal">35</span>
4112 <span class="normal">36</span>
4113 <span class="normal">37</span>
4114 <span class="normal">38</span>
4115 <span class="normal">39</span>
4116 <span class="normal">40</span>
4117 <span class="normal">41</span>
4118 <span class="normal">42</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="x">&lt;form method=&quot;post&quot; action=&quot;</span><span class="cp">{</span><span class="nf">link</span> <span class="na">controller</span><span class="o">=</span><span class="s1">&#39;FooBar&#39;</span><span class="cp">}{</span><span class="nf">/link</span><span class="cp">}</span><span class="x">&quot;&gt;</span>
4119 <span class="x">    &lt;div class=&quot;section&quot;&gt;</span>
4120 <span class="x">        &lt;dl</span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$errorField</span> <span class="o">==</span> <span class="s1">&#39;baz&#39;</span><span class="cp">}</span><span class="x"> class=&quot;formError&quot;</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x">&gt;</span>
4121 <span class="x">            &lt;dt&gt;&lt;label for=&quot;baz&quot;&gt;</span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.baz</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x">&lt;/label&gt;&lt;/dt&gt;</span>
4122 <span class="x">            &lt;dd&gt;</span>
4123 <span class="x">                &lt;input type=&quot;text&quot; id=&quot;baz&quot; name=&quot;baz&quot; value=&quot;</span><span class="cp">{</span><span class="nv">$baz</span><span class="cp">}</span><span class="x">&quot; class=&quot;long&quot; required autofocus&gt;</span>
4124 <span class="x">                </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$errorField</span> <span class="o">==</span> <span class="s1">&#39;baz&#39;</span><span class="cp">}</span>
4125 <span class="x">                    &lt;small class=&quot;innerError&quot;&gt;</span>
4126 <span class="x">                        </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$errorType</span> <span class="o">==</span> <span class="s1">&#39;empty&#39;</span><span class="cp">}</span>
4127 <span class="x">                            </span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.global.form.error.empty</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span>
4128 <span class="x">                        </span><span class="cp">{</span><span class="nf">else</span><span class="cp">}</span>
4129 <span class="x">                            </span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.baz.error.</span><span class="cp">{</span><span class="o">@</span><span class="nv">$errorType</span><span class="cp">}{</span><span class="nf">/lang</span><span class="cp">}</span>
4130 <span class="x">                        </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span>
4131 <span class="x">                    &lt;/small&gt;</span>
4132 <span class="x">                </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span>
4133 <span class="x">            &lt;/dd&gt;</span>
4134 <span class="x">        &lt;/dl&gt;</span>
4135
4136 <span class="x">        &lt;dl&gt;</span>
4137 <span class="x">            &lt;dt&gt;&lt;label for=&quot;bar&quot;&gt;</span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.bar</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x">&lt;/label&gt;&lt;/dt&gt;</span>
4138 <span class="x">            &lt;dd&gt;</span>
4139 <span class="x">                &lt;textarea name=&quot;bar&quot; id=&quot;bar&quot; cols=&quot;40&quot; rows=&quot;10&quot;&gt;</span><span class="cp">{</span><span class="nv">$bar</span><span class="cp">}</span><span class="x">&lt;/textarea&gt;</span>
4140 <span class="x">                </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$errorField</span> <span class="o">==</span> <span class="s1">&#39;bar&#39;</span><span class="cp">}</span>
4141 <span class="x">                    &lt;small class=&quot;innerError&quot;&gt;</span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.bar.error.</span><span class="cp">{</span><span class="o">@</span><span class="nv">$errorType</span><span class="cp">}{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x">&lt;/small&gt;</span>
4142 <span class="x">                </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span>
4143 <span class="x">            &lt;/dd&gt;</span>
4144 <span class="x">        &lt;/dl&gt;</span>
4145
4146 <span class="x">        </span><span class="cp">{</span><span class="c">* other fields *</span><span class="cp">}</span>
4147
4148 <span class="x">        </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;dataFields&#39;</span><span class="cp">}</span>
4149 <span class="x">    &lt;/div&gt;</span>
4150
4151 <span class="x">    </span><span class="cp">{</span><span class="c">* other sections *</span><span class="cp">}</span>
4152
4153 <span class="x">    </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;sections&#39;</span><span class="cp">}</span>
4154
4155 <span class="x">    &lt;div class=&quot;formSubmit&quot;&gt;</span>
4156 <span class="x">        &lt;input type=&quot;submit&quot; value=&quot;</span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.global.button.submit</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x">&quot; accesskey=&quot;s&quot;&gt;</span>
4157 <span class="x">        </span><span class="cp">{</span><span class="nf">csrfToken</span><span class="cp">}</span>
4158 <span class="x">    &lt;/div&gt;</span>
4159 <span class="x">&lt;/form&gt;</span>
4160 </code></pre></div></td></tr></table></div>
4161 <h3 id="tab-menus">Tab Menus<a class="headerlink" href="#tab-menus" title="Permanent link">#</a></h3>
4162 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
4163 <span class="normal"> 2</span>
4164 <span class="normal"> 3</span>
4165 <span class="normal"> 4</span>
4166 <span class="normal"> 5</span>
4167 <span class="normal"> 6</span>
4168 <span class="normal"> 7</span>
4169 <span class="normal"> 8</span>
4170 <span class="normal"> 9</span>
4171 <span class="normal">10</span>
4172 <span class="normal">11</span>
4173 <span class="normal">12</span>
4174 <span class="normal">13</span>
4175 <span class="normal">14</span>
4176 <span class="normal">15</span>
4177 <span class="normal">16</span>
4178 <span class="normal">17</span>
4179 <span class="normal">18</span>
4180 <span class="normal">19</span>
4181 <span class="normal">20</span>
4182 <span class="normal">21</span>
4183 <span class="normal">22</span>
4184 <span class="normal">23</span>
4185 <span class="normal">24</span>
4186 <span class="normal">25</span>
4187 <span class="normal">26</span>
4188 <span class="normal">27</span>
4189 <span class="normal">28</span>
4190 <span class="normal">29</span>
4191 <span class="normal">30</span>
4192 <span class="normal">31</span>
4193 <span class="normal">32</span>
4194 <span class="normal">33</span>
4195 <span class="normal">34</span>
4196 <span class="normal">35</span>
4197 <span class="normal">36</span>
4198 <span class="normal">37</span>
4199 <span class="normal">38</span>
4200 <span class="normal">39</span>
4201 <span class="normal">40</span>
4202 <span class="normal">41</span>
4203 <span class="normal">42</span>
4204 <span class="normal">43</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="x">&lt;div class=&quot;section tabMenuContainer&quot;&gt;</span>
4205 <span class="x">    &lt;nav class=&quot;tabMenu&quot;&gt;</span>
4206 <span class="x">        &lt;ul&gt;</span>
4207 <span class="x">            &lt;li&gt;&lt;a href=&quot;#tab1&quot;&gt;Tab 1&lt;/a&gt;&lt;/li&gt;</span>
4208 <span class="x">            &lt;li&gt;&lt;a href=&quot;#tab2&quot;&gt;Tab 2&lt;/a&gt;&lt;/li&gt;</span>
4209
4210 <span class="x">            </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;tabMenuTabs&#39;</span><span class="cp">}</span>
4211 <span class="x">        &lt;/ul&gt;</span>
4212 <span class="x">    &lt;/nav&gt;</span>
4213
4214 <span class="x">    &lt;div id=&quot;tab1&quot; class=&quot;tabMenuContent&quot;&gt;</span>
4215 <span class="x">        &lt;div class=&quot;section&quot;&gt;</span>
4216 <span class="x">            </span><span class="cp">{</span><span class="c">* contents of first tab *</span><span class="cp">}</span>
4217 <span class="x">        &lt;/div&gt;</span>
4218 <span class="x">    &lt;/div&gt;</span>
4219
4220 <span class="x">    &lt;div id=&quot;tab2&quot; class=&quot;tabMenuContainer tabMenuContent&quot;&gt;</span>
4221 <span class="x">        &lt;nav class=&quot;menu&quot;&gt;</span>
4222 <span class="x">            &lt;ul&gt;</span>
4223 <span class="x">                &lt;li&gt;&lt;a href=&quot;#tab2A&quot;&gt;Tab 2A&lt;/a&gt;&lt;/li&gt;</span>
4224 <span class="x">                &lt;li&gt;&lt;a href=&quot;#tab2B&quot;&gt;Tab 2B&lt;/a&gt;&lt;/li&gt;</span>
4225
4226 <span class="x">                </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;tabMenuTab2Subtabs&#39;</span><span class="cp">}</span>
4227 <span class="x">            &lt;/ul&gt;</span>
4228 <span class="x">        &lt;/nav&gt;</span>
4229
4230 <span class="x">        &lt;div id=&quot;tab2A&quot; class=&quot;tabMenuContent&quot;&gt;</span>
4231 <span class="x">            &lt;div class=&quot;section&quot;&gt;</span>
4232 <span class="x">                </span><span class="cp">{</span><span class="c">* contents of first subtab for second tab *</span><span class="cp">}</span>
4233 <span class="x">            &lt;/div&gt;</span>
4234 <span class="x">        &lt;/div&gt;</span>
4235
4236 <span class="x">        &lt;div id=&quot;tab2B&quot; class=&quot;tabMenuContent&quot;&gt;</span>
4237 <span class="x">            &lt;div class=&quot;section&quot;&gt;</span>
4238 <span class="x">                </span><span class="cp">{</span><span class="c">* contents of second subtab for second tab *</span><span class="cp">}</span>
4239 <span class="x">            &lt;/div&gt;</span>
4240 <span class="x">        &lt;/div&gt;</span>
4241
4242 <span class="x">        </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;tabMenuTab2Contents&#39;</span><span class="cp">}</span>
4243 <span class="x">    &lt;/div&gt;</span>
4244
4245 <span class="x">    </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;tabMenuContents&#39;</span><span class="cp">}</span>
4246 <span class="x">&lt;/div&gt;</span>
4247 </code></pre></div></td></tr></table></div>
4248 <h2 id="template-scripting">Template Scripting<a class="headerlink" href="#template-scripting" title="Permanent link">#</a></h2>
4249 <h3 id="template-variables">Template Variables<a class="headerlink" href="#template-variables" title="Permanent link">#</a></h3>
4250 <p>Template variables can be assigned via <code>WCF::getTPL()-&gt;assign('foo', 'bar')</code> and accessed in templates via <code>$foo</code>:</p>
4251 <ul>
4252 <li><code>{$foo}</code> will result in the contents of <code>$foo</code> to be passed to <code>StringUtil::encodeHTML()</code> before being printed.</li>
4253 <li><code>{#$foo}</code> will result in the contents of <code>$foo</code> to be passed to <code>StringUtil::formatNumeric()</code> before being printed.
4254   Thus, this method is relevant when printing numbers and having them formatted correctly according the the user’s language.</li>
4255 <li><code>{@$foo}</code> will result in the contents of <code>$foo</code> to be printed directly.
4256   In general, this method should not be used for user-generated input.</li>
4257 </ul>
4258 <p>Multiple template variables can be assigned by passing an array:</p>
4259 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
4260 <span class="normal">2</span>
4261 <span class="normal">3</span>
4262 <span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nx">WCF</span><span class="o">::</span><span class="na">getTPL</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">assign</span><span class="p">([</span>
4263     <span class="s1">&#39;foo&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;bar&#39;</span><span class="p">,</span>
4264     <span class="s1">&#39;baz&#39;</span> <span class="o">=&gt;</span> <span class="k">false</span>
4265 <span class="p">]);</span>
4266 </code></pre></div></td></tr></table></div>
4267 <h4 id="modifiers">Modifiers<a class="headerlink" href="#modifiers" title="Permanent link">#</a></h4>
4268 <p>Variable modifiers are used to modify the output of variables within templates.
4269 These modifiers allow you to perform various operations on the variables before displaying them.
4270 The general syntax for applying a variable modifier is <code>{$variable|modifier}</code>.</p>
4271 <p>Modifiers can be chained together to perform multiple operations on a variable. In such cases, the modifiers are applied from left to right. For example:
4272 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="nv">$variable</span><span class="o">|</span><span class="na">modifier1</span><span class="o">|</span><span class="na">modifier2</span><span class="o">|</span><span class="na">modifier3</span><span class="cp">}</span>
4273 </code></pre></div></td></tr></table></div></p>
4274 <p>A modifier may accept additional parameters that affect its behavior. These parameters follow the modifier name and are separated by a <code>:</code>. For example:
4275 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="nv">$variable</span><span class="o">|</span><span class="na">modifier</span><span class="o">:</span><span class="s1">&#39;param1&#39;</span><span class="o">:</span><span class="s1">&#39;param2&#39;</span><span class="cp">}</span>
4276 </code></pre></div></td></tr></table></div></p>
4277 <p>An <a href="../template-modifiers/">overview of all available modifiers</a> is available on a <a href="../template-modifiers/">dedicated page</a>.</p>
4278 <h4 id="system-template-variable">System Template Variable<a class="headerlink" href="#system-template-variable" title="Permanent link">#</a></h4>
4279 <ul>
4280 <li><code>$__wcf</code> contains the <code>WCF</code> object (or <code>WCFACP</code> object in the backend).</li>
4281 </ul>
4282 <h3 id="comments">Comments<a class="headerlink" href="#comments" title="Permanent link">#</a></h3>
4283 <p>Comments are wrapped in <code>{*</code> and <code>*}</code> and can span multiple lines:</p>
4284 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
4285 <span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="c">* some</span>
4286 <span class="c">   comment *</span><span class="cp">}</span>
4287 </code></pre></div></td></tr></table></div>
4288 <div class="admonition info">
4289 <p class="admonition-title">The template compiler discards the comments, so that they not included in the compiled template.</p>
4290 </div>
4291 <h3 id="conditions">Conditions<a class="headerlink" href="#conditions" title="Permanent link">#</a></h3>
4292 <p>Conditions follow a similar syntax to PHP code:</p>
4293 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
4294 <span class="normal">2</span>
4295 <span class="normal">3</span>
4296 <span class="normal">4</span>
4297 <span class="normal">5</span>
4298 <span class="normal">6</span>
4299 <span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">&#39;bar&#39;</span><span class="cp">}</span>
4300 <span class="x">    foo is bar</span>
4301 <span class="cp">{</span><span class="nf">elseif</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">&#39;baz&#39;</span><span class="cp">}</span>
4302 <span class="x">    foo is baz</span>
4303 <span class="cp">{</span><span class="nf">else</span><span class="cp">}</span>
4304 <span class="x">    foo is neither bar nor baz</span>
4305 <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span>
4306 </code></pre></div></td></tr></table></div>
4307 <p>The supported operators in conditions are <code>===</code>, <code>!==</code>, <code>==</code>, <code>!=</code>, <code>&lt;=</code>, <code>&lt;</code>, <code>&gt;=</code>, <code>&gt;</code>, <code>||</code>, <code>&amp;&amp;</code>, <code>!</code>, and <code>=</code>.</p>
4308 <p>More examples:</p>
4309 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
4310 <span class="normal">2</span>
4311 <span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="nf">if</span> <span class="nv">$bar</span><span class="o">|</span><span class="na">isset</span><span class="cp">}</span><span class="x">…</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span>
4312
4313 <span class="cp">{</span><span class="nf">if</span> <span class="nv">$bar</span><span class="o">|</span><span class="na">count</span> <span class="o">&gt;</span> <span class="m">3</span> <span class="o">&amp;&amp;</span> <span class="nv">$bar</span><span class="o">|</span><span class="na">count</span> <span class="o">&lt;</span> <span class="m">100</span><span class="cp">}</span><span class="x">…</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span>
4314 </code></pre></div></td></tr></table></div>
4315 <h3 id="foreach-loops">Foreach Loops<a class="headerlink" href="#foreach-loops" title="Permanent link">#</a></h3>
4316 <p>Foreach loops allow to iterate over arrays or iterable objects:</p>
4317 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
4318 <span class="normal">2</span>
4319 <span class="normal">3</span>
4320 <span class="normal">4</span>
4321 <span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="x">&lt;ul&gt;</span>
4322 <span class="x">    </span><span class="cp">{</span><span class="nf">foreach</span> <span class="na">from</span><span class="o">=</span><span class="nv">$array</span> <span class="na">key</span><span class="o">=</span><span class="na">key</span> <span class="na">item</span><span class="o">=</span><span class="na">value</span><span class="cp">}</span>
4323 <span class="x">        &lt;li&gt;</span><span class="cp">{</span><span class="nv">$key</span><span class="cp">}</span><span class="x">: </span><span class="cp">{</span><span class="nv">$value</span><span class="cp">}</span><span class="x">&lt;/li&gt;</span>
4324 <span class="x">    </span><span class="cp">{</span><span class="nf">/foreach</span><span class="cp">}</span>
4325 <span class="x">&lt;/ul&gt;</span>
4326 </code></pre></div></td></tr></table></div>
4327 <p>While the <code>from</code> attribute containing the iterated structure and the <code>item</code> attribute containg the current value are mandatory, the <code>key</code> attribute is optional.
4328 If the foreach loop has a name assigned to it via the <code>name</code> attribute, the <code>$tpl</code> template variable provides additional data about the loop:</p>
4329 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
4330 <span class="normal"> 2</span>
4331 <span class="normal"> 3</span>
4332 <span class="normal"> 4</span>
4333 <span class="normal"> 5</span>
4334 <span class="normal"> 6</span>
4335 <span class="normal"> 7</span>
4336 <span class="normal"> 8</span>
4337 <span class="normal"> 9</span>
4338 <span class="normal">10</span>
4339 <span class="normal">11</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="x">&lt;ul&gt;</span>
4340 <span class="x">    </span><span class="cp">{</span><span class="nf">foreach</span> <span class="na">from</span><span class="o">=</span><span class="nv">$array</span> <span class="na">key</span><span class="o">=</span><span class="na">key</span> <span class="na">item</span><span class="o">=</span><span class="na">value</span> <span class="na">name</span><span class="o">=</span><span class="na">foo</span><span class="cp">}</span>
4341 <span class="x">        </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$tpl</span><span class="o">[</span><span class="na">foreach</span><span class="o">][</span><span class="na">foo</span><span class="o">][</span><span class="na">first</span><span class="o">]</span><span class="cp">}</span>
4342 <span class="x">            something special for the first iteration</span>
4343 <span class="x">        </span><span class="cp">{</span><span class="nf">elseif</span> <span class="nv">$tpl</span><span class="o">[</span><span class="na">foreach</span><span class="o">][</span><span class="na">foo</span><span class="o">][</span><span class="na">last</span><span class="o">]</span><span class="cp">}</span>
4344 <span class="x">            something special for the last iteration</span>
4345 <span class="x">        </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span>
4346
4347 <span class="x">        &lt;li&gt;iteration </span><span class="cp">{</span><span class="err">#</span><span class="nv">$tpl</span><span class="o">[</span><span class="na">foreach</span><span class="o">][</span><span class="na">foo</span><span class="o">][</span><span class="na">iteration</span><span class="o">]+</span><span class="m">1</span><span class="cp">}</span><span class="x"> out of </span><span class="cp">{</span><span class="err">#</span><span class="nv">$tpl</span><span class="o">[</span><span class="na">foreach</span><span class="o">][</span><span class="na">foo</span><span class="o">][</span><span class="na">total</span><span class="o">]</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="nv">$key</span><span class="cp">}</span><span class="x">: </span><span class="cp">{</span><span class="nv">$value</span><span class="cp">}</span><span class="x">&lt;/li&gt;</span>
4348 <span class="x">    </span><span class="cp">{</span><span class="nf">/foreach</span><span class="cp">}</span>
4349 <span class="x">&lt;/ul&gt;</span>
4350 </code></pre></div></td></tr></table></div>
4351 <p>In contrast to PHP’s foreach loop, templates also support <code>foreachelse</code>:</p>
4352 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
4353 <span class="normal">2</span>
4354 <span class="normal">3</span>
4355 <span class="normal">4</span>
4356 <span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="nf">foreach</span> <span class="na">from</span><span class="o">=</span><span class="nv">$array</span> <span class="na">item</span><span class="o">=</span><span class="na">value</span><span class="cp">}</span>
4357 <span class="x">    …</span>
4358 <span class="cp">{</span><span class="nf">foreachelse</span><span class="cp">}</span>
4359 <span class="x">    there is nothing to iterate over</span>
4360 <span class="cp">{</span><span class="nf">/foreach</span><span class="cp">}</span>
4361 </code></pre></div></td></tr></table></div>
4362 <h3 id="including-other-templates">Including Other Templates<a class="headerlink" href="#including-other-templates" title="Permanent link">#</a></h3>
4363 <p>To include template named <code>foo</code> from the same domain (frontend/backend), you can use</p>
4364 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;foo&#39;</span><span class="cp">}</span>
4365 </code></pre></div></td></tr></table></div>
4366 <p>If the template belongs to an application, you have to specify that application using the <code>application</code> attribute:</p>
4367 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;foo&#39;</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;app&#39;</span><span class="cp">}</span>
4368 </code></pre></div></td></tr></table></div>
4369 <p>Additional template variables can be passed to the included template as additional attributes:</p>
4370 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;foo&#39;</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;app&#39;</span> <span class="na">var1</span><span class="o">=</span><span class="s1">&#39;foo1&#39;</span> <span class="na">var2</span><span class="o">=</span><span class="s1">&#39;foo2&#39;</span><span class="cp">}</span>
4371 </code></pre></div></td></tr></table></div>
4372 <h3 id="template-plugins">Template Plugins<a class="headerlink" href="#template-plugins" title="Permanent link">#</a></h3>
4373 <p>An overview of all available template plugins can be found <a href="../template-plugins/">here</a>.</p>
4374
4375   <hr>
4376 <div class="md-source-file">
4377   <small>
4378
4379       Last update:
4380       2023-07-05
4381
4382   </small>
4383 </div>
4384
4385
4386
4387
4388
4389
4390               </article>
4391             </div>
4392
4393
4394         </div>
4395
4396       </main>
4397
4398         <footer class="md-footer">
4399
4400   <div class="md-footer-meta md-typeset">
4401     <div class="md-footer-meta__inner md-grid">
4402       <div class="md-copyright">
4403
4404     <div class="md-copyright__highlight">
4405       Copyright © 2020 WoltLab GmbH
4406     </div>
4407
4408
4409     Made with
4410     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
4411       Material for MkDocs
4412     </a>
4413
4414 </div>
4415
4416         <div class="md-copyright">
4417         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
4418         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
4419 </div>
4420
4421     </div>
4422   </div>
4423 </footer>
4424
4425     </div>
4426     <div class="md-dialog" data-md-component="dialog">
4427       <div class="md-dialog__inner md-typeset"></div>
4428     </div>
4429
4430     <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tracking"], "search": "../../assets/javascripts/workers/search.a264c092.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>
4431
4432
4433       <script src="../../assets/javascripts/bundle.726fbb30.min.js"></script>
4434
4435
4436   </body>
4437 </html>