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