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