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