3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"shortcut icon" href=
"../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.0.5">
17 <title>Templates - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.77f3fd56.min.css">
24 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.7fa14f5b.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
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">
62 <a href=
"#templates" class=
"md-skip">
67 <div data-md-component=
"announce">
69 <aside class=
"md-announce">
70 <div class=
"md-announce__inner md-grid md-typeset">
72 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
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">
85 <img src=
"../../assets/logo.png" alt=
"logo">
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>
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
98 <div class=
"md-header__topic" data-md-component=
"header-topic">
99 <span class=
"md-ellipsis">
107 <div class=
"md-header__options">
112 <div class=
"md-header__source">
114 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
115 <div class=
"md-source__icon md-icon">
117 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 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>
119 <div class=
"md-source__repository">
128 <div class=
"md-container" data-md-component=
"container">
133 <main class=
"md-main" data-md-component=
"main">
134 <div class=
"md-main__inner md-grid">
138 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
139 <div class=
"md-sidebar__scrollwrap">
140 <div class=
"md-sidebar__inner">
146 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
147 <label class=
"md-nav__title" for=
"__drawer">
148 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
150 <img src=
"../../assets/logo.png" alt=
"logo">
153 WoltLab Suite Documentation
156 <div class=
"md-nav__source">
158 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
159 <div class=
"md-source__icon md-icon">
161 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 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>
163 <div class=
"md-source__repository">
169 <ul class=
"md-nav__list" data-md-scrollfix
>
178 <li class=
"md-nav__item">
179 <a href=
"../../getting-started/" class=
"md-nav__link">
194 <li class=
"md-nav__item md-nav__item--nested">
197 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
199 <label class=
"md-nav__link" for=
"__nav_2">
201 <span class=
"md-nav__icon md-icon"></span>
203 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
204 <label class=
"md-nav__title" for=
"__nav_2">
205 <span class=
"md-nav__icon md-icon"></span>
208 <ul class=
"md-nav__list" data-md-scrollfix
>
214 <li class=
"md-nav__item">
215 <a href=
"../../php/pages/" class=
"md-nav__link">
226 <li class=
"md-nav__item">
227 <a href=
"../../php/database-objects/" class=
"md-nav__link">
238 <li class=
"md-nav__item">
239 <a href=
"../../php/database-access/" class=
"md-nav__link">
250 <li class=
"md-nav__item">
251 <a href=
"../../php/exceptions/" class=
"md-nav__link">
263 <li class=
"md-nav__item md-nav__item--nested">
266 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
268 <label class=
"md-nav__link" for=
"__nav_2_5">
270 <span class=
"md-nav__icon md-icon"></span>
272 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
273 <label class=
"md-nav__title" for=
"__nav_2_5">
274 <span class=
"md-nav__icon md-icon"></span>
277 <ul class=
"md-nav__list" data-md-scrollfix
>
283 <li class=
"md-nav__item">
284 <a href=
"../../php/api/caches/" class=
"md-nav__link">
295 <li class=
"md-nav__item">
296 <a href=
"../../php/api/comments/" class=
"md-nav__link">
307 <li class=
"md-nav__item">
308 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
319 <li class=
"md-nav__item">
320 <a href=
"../../php/api/events/" class=
"md-nav__link">
332 <li class=
"md-nav__item md-nav__item--nested">
335 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
337 <label class=
"md-nav__link" for=
"__nav_2_5_5">
339 <span class=
"md-nav__icon md-icon"></span>
341 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
342 <label class=
"md-nav__title" for=
"__nav_2_5_5">
343 <span class=
"md-nav__icon md-icon"></span>
346 <ul class=
"md-nav__list" data-md-scrollfix
>
352 <li class=
"md-nav__item">
353 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
364 <li class=
"md-nav__item">
365 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
376 <li class=
"md-nav__item">
377 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
388 <li class=
"md-nav__item">
389 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
400 <li class=
"md-nav__item">
401 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
418 <li class=
"md-nav__item">
419 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
420 Package Installation Plugins
430 <li class=
"md-nav__item">
431 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
442 <li class=
"md-nav__item">
443 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
454 <li class=
"md-nav__item">
455 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
472 <li class=
"md-nav__item">
473 <a href=
"../../php/code-style/" class=
"md-nav__link">
484 <li class=
"md-nav__item">
485 <a href=
"../../php/apps/" class=
"md-nav__link">
496 <li class=
"md-nav__item">
497 <a href=
"../../php/gdpr/" class=
"md-nav__link">
520 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
523 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" checked
>
525 <label class=
"md-nav__link" for=
"__nav_3">
526 Languages, Templates & CSS
527 <span class=
"md-nav__icon md-icon"></span>
529 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
530 <label class=
"md-nav__title" for=
"__nav_3">
531 <span class=
"md-nav__icon md-icon"></span>
532 Languages, Templates & CSS
534 <ul class=
"md-nav__list" data-md-scrollfix
>
540 <li class=
"md-nav__item">
541 <a href=
"../languages/" class=
"md-nav__link">
554 <li class=
"md-nav__item md-nav__item--active">
556 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
561 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
563 <span class=
"md-nav__icon md-icon"></span>
566 <a href=
"./" class=
"md-nav__link md-nav__link--active">
571 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
577 <label class=
"md-nav__title" for=
"__toc">
578 <span class=
"md-nav__icon md-icon"></span>
581 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
583 <li class=
"md-nav__item">
584 <a href=
"#template-types-and-conventions" class=
"md-nav__link">
585 Template Types and Conventions
590 <li class=
"md-nav__item">
591 <a href=
"#installing-templates" class=
"md-nav__link">
597 <li class=
"md-nav__item">
598 <a href=
"#base-templates" class=
"md-nav__link">
602 <nav class=
"md-nav" aria-label=
"Base Templates">
603 <ul class=
"md-nav__list">
605 <li class=
"md-nav__item">
606 <a href=
"#frontend" class=
"md-nav__link">
612 <li class=
"md-nav__item">
613 <a href=
"#backend" class=
"md-nav__link">
624 <li class=
"md-nav__item">
625 <a href=
"#common-template-components" class=
"md-nav__link">
626 Common Template Components
629 <nav class=
"md-nav" aria-label=
"Common Template Components">
630 <ul class=
"md-nav__list">
632 <li class=
"md-nav__item">
633 <a href=
"#forms" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"#tab-menus" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"#template-scripting" class=
"md-nav__link">
656 <nav class=
"md-nav" aria-label=
"Template Scripting">
657 <ul class=
"md-nav__list">
659 <li class=
"md-nav__item">
660 <a href=
"#template-variables" class=
"md-nav__link">
664 <nav class=
"md-nav" aria-label=
"Template Variables">
665 <ul class=
"md-nav__list">
667 <li class=
"md-nav__item">
668 <a href=
"#modifiers" class=
"md-nav__link">
674 <li class=
"md-nav__item">
675 <a href=
"#system-template-variable" class=
"md-nav__link">
676 System Template Variable
686 <li class=
"md-nav__item">
687 <a href=
"#comments" class=
"md-nav__link">
693 <li class=
"md-nav__item">
694 <a href=
"#conditions" class=
"md-nav__link">
700 <li class=
"md-nav__item">
701 <a href=
"#foreach-loops" class=
"md-nav__link">
707 <li class=
"md-nav__item">
708 <a href=
"#including-other-templates" class=
"md-nav__link">
709 Including Other Templates
714 <li class=
"md-nav__item">
715 <a href=
"#template-plugins" class=
"md-nav__link">
738 <li class=
"md-nav__item">
739 <a href=
"../css/" class=
"md-nav__link">
760 <li class=
"md-nav__item md-nav__item--nested">
763 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
765 <label class=
"md-nav__link" for=
"__nav_4">
767 <span class=
"md-nav__icon md-icon"></span>
769 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
770 <label class=
"md-nav__title" for=
"__nav_4">
771 <span class=
"md-nav__icon md-icon"></span>
774 <ul class=
"md-nav__list" data-md-scrollfix
>
780 <li class=
"md-nav__item">
781 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
793 <li class=
"md-nav__item md-nav__item--nested">
796 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
798 <label class=
"md-nav__link" for=
"__nav_4_2">
800 <span class=
"md-nav__icon md-icon"></span>
802 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
803 <label class=
"md-nav__title" for=
"__nav_4_2">
804 <span class=
"md-nav__icon md-icon"></span>
807 <ul class=
"md-nav__list" data-md-scrollfix
>
813 <li class=
"md-nav__item">
814 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
825 <li class=
"md-nav__item">
826 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
837 <li class=
"md-nav__item">
838 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
849 <li class=
"md-nav__item">
850 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
861 <li class=
"md-nav__item">
862 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
873 <li class=
"md-nav__item">
874 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
885 <li class=
"md-nav__item">
886 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
897 <li class=
"md-nav__item">
898 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
899 Browser and Screen Sizes
909 <li class=
"md-nav__item">
910 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
927 <li class=
"md-nav__item">
928 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
939 <li class=
"md-nav__item">
940 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
951 <li class=
"md-nav__item">
952 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
973 <li class=
"md-nav__item md-nav__item--nested">
976 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
978 <label class=
"md-nav__link" for=
"__nav_5">
980 <span class=
"md-nav__icon md-icon"></span>
982 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
983 <label class=
"md-nav__title" for=
"__nav_5">
984 <span class=
"md-nav__icon md-icon"></span>
987 <ul class=
"md-nav__list" data-md-scrollfix
>
993 <li class=
"md-nav__item">
994 <a href=
"../../package/package-xml/" class=
"md-nav__link">
1006 <li class=
"md-nav__item md-nav__item--nested">
1009 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1011 <label class=
"md-nav__link" for=
"__nav_5_2">
1013 <span class=
"md-nav__icon md-icon"></span>
1015 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1016 <label class=
"md-nav__title" for=
"__nav_5_2">
1017 <span class=
"md-nav__icon md-icon"></span>
1020 <ul class=
"md-nav__list" data-md-scrollfix
>
1026 <li class=
"md-nav__item">
1027 <a href=
"../../package/pip/" class=
"md-nav__link">
1038 <li class=
"md-nav__item">
1039 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1050 <li class=
"md-nav__item">
1051 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1062 <li class=
"md-nav__item">
1063 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1074 <li class=
"md-nav__item">
1075 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1086 <li class=
"md-nav__item">
1087 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1098 <li class=
"md-nav__item">
1099 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1110 <li class=
"md-nav__item">
1111 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1122 <li class=
"md-nav__item">
1123 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1134 <li class=
"md-nav__item">
1135 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1146 <li class=
"md-nav__item">
1147 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1158 <li class=
"md-nav__item">
1159 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1170 <li class=
"md-nav__item">
1171 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1182 <li class=
"md-nav__item">
1183 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1194 <li class=
"md-nav__item">
1195 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1206 <li class=
"md-nav__item">
1207 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1218 <li class=
"md-nav__item">
1219 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1230 <li class=
"md-nav__item">
1231 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1232 objectTypeDefinition
1242 <li class=
"md-nav__item">
1243 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1254 <li class=
"md-nav__item">
1255 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1266 <li class=
"md-nav__item">
1267 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1278 <li class=
"md-nav__item">
1279 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1290 <li class=
"md-nav__item">
1291 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1302 <li class=
"md-nav__item">
1303 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1314 <li class=
"md-nav__item">
1315 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1326 <li class=
"md-nav__item">
1327 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1338 <li class=
"md-nav__item">
1339 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1350 <li class=
"md-nav__item">
1351 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1362 <li class=
"md-nav__item">
1363 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1374 <li class=
"md-nav__item">
1375 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1376 userNotificationEvent
1386 <li class=
"md-nav__item">
1387 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1398 <li class=
"md-nav__item">
1399 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1416 <li class=
"md-nav__item">
1417 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1438 <li class=
"md-nav__item md-nav__item--nested">
1441 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1443 <label class=
"md-nav__link" for=
"__nav_6">
1445 <span class=
"md-nav__icon md-icon"></span>
1447 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1448 <label class=
"md-nav__title" for=
"__nav_6">
1449 <span class=
"md-nav__icon md-icon"></span>
1452 <ul class=
"md-nav__list" data-md-scrollfix
>
1459 <li class=
"md-nav__item md-nav__item--nested">
1462 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1464 <label class=
"md-nav__link" for=
"__nav_6_1">
1465 Migrating from WSC
5.3
1466 <span class=
"md-nav__icon md-icon"></span>
1468 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1469 <label class=
"md-nav__title" for=
"__nav_6_1">
1470 <span class=
"md-nav__icon md-icon"></span>
1471 Migrating from WSC
5.3
1473 <ul class=
"md-nav__list" data-md-scrollfix
>
1479 <li class=
"md-nav__item">
1480 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1491 <li class=
"md-nav__item">
1492 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1493 Session Handling and Authentication
1503 <li class=
"md-nav__item">
1504 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1515 <li class=
"md-nav__item">
1516 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1527 <li class=
"md-nav__item">
1528 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1529 Third Party Libraries
1546 <li class=
"md-nav__item md-nav__item--nested">
1549 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1551 <label class=
"md-nav__link" for=
"__nav_6_2">
1552 Migrating from WSC
5.2
1553 <span class=
"md-nav__icon md-icon"></span>
1555 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1556 <label class=
"md-nav__title" for=
"__nav_6_2">
1557 <span class=
"md-nav__icon md-icon"></span>
1558 Migrating from WSC
5.2
1560 <ul class=
"md-nav__list" data-md-scrollfix
>
1566 <li class=
"md-nav__item">
1567 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1578 <li class=
"md-nav__item">
1579 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1580 Templates and Languages
1590 <li class=
"md-nav__item">
1591 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1592 Third Party Libraries
1609 <li class=
"md-nav__item md-nav__item--nested">
1612 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1614 <label class=
"md-nav__link" for=
"__nav_6_3">
1615 Migrating from WSC
3.1
1616 <span class=
"md-nav__icon md-icon"></span>
1618 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1619 <label class=
"md-nav__title" for=
"__nav_6_3">
1620 <span class=
"md-nav__icon md-icon"></span>
1621 Migrating from WSC
3.1
1623 <ul class=
"md-nav__list" data-md-scrollfix
>
1629 <li class=
"md-nav__item">
1630 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1648 <li class=
"md-nav__item md-nav__item--nested">
1651 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1653 <label class=
"md-nav__link" for=
"__nav_6_4">
1654 Migrating from WSC
3.0
1655 <span class=
"md-nav__icon md-icon"></span>
1657 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1658 <label class=
"md-nav__title" for=
"__nav_6_4">
1659 <span class=
"md-nav__icon md-icon"></span>
1660 Migrating from WSC
3.0
1662 <ul class=
"md-nav__list" data-md-scrollfix
>
1668 <li class=
"md-nav__item">
1669 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1680 <li class=
"md-nav__item">
1681 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1692 <li class=
"md-nav__item">
1693 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1704 <li class=
"md-nav__item">
1705 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1716 <li class=
"md-nav__item">
1717 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1735 <li class=
"md-nav__item md-nav__item--nested">
1738 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1740 <label class=
"md-nav__link" for=
"__nav_6_5">
1741 Migrating from WCF
2.1
1742 <span class=
"md-nav__icon md-icon"></span>
1744 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1745 <label class=
"md-nav__title" for=
"__nav_6_5">
1746 <span class=
"md-nav__icon md-icon"></span>
1747 Migrating from WCF
2.1
1749 <ul class=
"md-nav__list" data-md-scrollfix
>
1755 <li class=
"md-nav__item">
1756 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1767 <li class=
"md-nav__item">
1768 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1779 <li class=
"md-nav__item">
1780 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1791 <li class=
"md-nav__item">
1792 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1819 <li class=
"md-nav__item md-nav__item--nested">
1822 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1824 <label class=
"md-nav__link" for=
"__nav_7">
1826 <span class=
"md-nav__icon md-icon"></span>
1828 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1829 <label class=
"md-nav__title" for=
"__nav_7">
1830 <span class=
"md-nav__icon md-icon"></span>
1833 <ul class=
"md-nav__list" data-md-scrollfix
>
1840 <li class=
"md-nav__item md-nav__item--nested">
1843 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1845 <label class=
"md-nav__link" for=
"__nav_7_1">
1847 <span class=
"md-nav__icon md-icon"></span>
1849 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1850 <label class=
"md-nav__title" for=
"__nav_7_1">
1851 <span class=
"md-nav__icon md-icon"></span>
1854 <ul class=
"md-nav__list" data-md-scrollfix
>
1860 <li class=
"md-nav__item">
1861 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1872 <li class=
"md-nav__item">
1873 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1884 <li class=
"md-nav__item">
1885 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1896 <li class=
"md-nav__item">
1897 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1924 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1925 <div class=
"md-sidebar__scrollwrap">
1926 <div class=
"md-sidebar__inner">
1928 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1934 <label class=
"md-nav__title" for=
"__toc">
1935 <span class=
"md-nav__icon md-icon"></span>
1938 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1940 <li class=
"md-nav__item">
1941 <a href=
"#template-types-and-conventions" class=
"md-nav__link">
1942 Template Types and Conventions
1947 <li class=
"md-nav__item">
1948 <a href=
"#installing-templates" class=
"md-nav__link">
1949 Installing Templates
1954 <li class=
"md-nav__item">
1955 <a href=
"#base-templates" class=
"md-nav__link">
1959 <nav class=
"md-nav" aria-label=
"Base Templates">
1960 <ul class=
"md-nav__list">
1962 <li class=
"md-nav__item">
1963 <a href=
"#frontend" class=
"md-nav__link">
1969 <li class=
"md-nav__item">
1970 <a href=
"#backend" class=
"md-nav__link">
1981 <li class=
"md-nav__item">
1982 <a href=
"#common-template-components" class=
"md-nav__link">
1983 Common Template Components
1986 <nav class=
"md-nav" aria-label=
"Common Template Components">
1987 <ul class=
"md-nav__list">
1989 <li class=
"md-nav__item">
1990 <a href=
"#forms" class=
"md-nav__link">
1996 <li class=
"md-nav__item">
1997 <a href=
"#tab-menus" class=
"md-nav__link">
2008 <li class=
"md-nav__item">
2009 <a href=
"#template-scripting" class=
"md-nav__link">
2013 <nav class=
"md-nav" aria-label=
"Template Scripting">
2014 <ul class=
"md-nav__list">
2016 <li class=
"md-nav__item">
2017 <a href=
"#template-variables" class=
"md-nav__link">
2021 <nav class=
"md-nav" aria-label=
"Template Variables">
2022 <ul class=
"md-nav__list">
2024 <li class=
"md-nav__item">
2025 <a href=
"#modifiers" class=
"md-nav__link">
2031 <li class=
"md-nav__item">
2032 <a href=
"#system-template-variable" class=
"md-nav__link">
2033 System Template Variable
2043 <li class=
"md-nav__item">
2044 <a href=
"#comments" class=
"md-nav__link">
2050 <li class=
"md-nav__item">
2051 <a href=
"#conditions" class=
"md-nav__link">
2057 <li class=
"md-nav__item">
2058 <a href=
"#foreach-loops" class=
"md-nav__link">
2064 <li class=
"md-nav__item">
2065 <a href=
"#including-other-templates" class=
"md-nav__link">
2066 Including Other Templates
2071 <li class=
"md-nav__item">
2072 <a href=
"#template-plugins" class=
"md-nav__link">
2091 <div class=
"md-content" data-md-component=
"content">
2092 <article class=
"md-content__inner md-typeset">
2095 <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">
2096 <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>
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>
2111 <li><code>RegisterForm.class.php
</code> →
<code>register.tpl
</code></li>
2112 <li><code>UserPage.class.php
</code> →
<code>user.tpl
</code></li>
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>
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">'header
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2126 <span class=
"cp">{
</span><span class=
"c">* content *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2128 <span class=
"cp">{
</span><span class=
"nf">include
</span> <span class=
"na">file
</span><span class=
"o">=
</span><span class=
"s1">'footer
'</span><span class=
"cp">}
</span><span class=
"x"></span>
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">'header
'</span> <span class=
"na">pageTitle
</span><span class=
"o">=
</span><span class=
"s1">'foo.bar.baz
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2133 <span class=
"x"><header class=
"contentHeader
"></span>
2134 <span class=
"x"> <div class=
"contentHeaderTitle
"></span>
2135 <span class=
"x"> <h1 class=
"contentTitle
">Title
</h1
></span>
2136 <span class=
"x"> </div
></span>
2138 <span class=
"x"> <nav class=
"contentHeaderNavigation
"></span>
2139 <span class=
"x"> <ul
></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>
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">'contentHeaderNavigation
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2143 <span class=
"x"> </ul
></span>
2144 <span class=
"x"> </nav
></span>
2145 <span class=
"x"></header
></span>
2147 <span class=
"cp">{
</span><span class=
"c">* content *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2149 <span class=
"cp">{
</span><span class=
"nf">include
</span> <span class=
"na">file
</span><span class=
"o">=
</span><span class=
"s1">'footer
'</span><span class=
"cp">}
</span><span class=
"x"></span>
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>
2157 <div class=
"highlight"><pre><span></span><code><span class=
"x"><form method=
"post
" action=
"</span><span class=
"cp">{
</span><span class=
"nf">link
</span> <span class=
"na">controller
</span><span class=
"o">=
</span><span class=
"s1">'FooBar
'</span><span class=
"cp">}{
</span><span class=
"nf">/link
</span><span class=
"cp">}
</span><span class=
"x">"></span>
2158 <span class=
"x"> <div class=
"section
"></span>
2159 <span class=
"x"> <dl
</span><span class=
"cp">{
</span><span class=
"nf">if
</span> <span class=
"nv">$errorField
</span> <span class=
"o">==
</span> <span class=
"s1">'baz
'</span><span class=
"cp">}
</span><span class=
"x"> class=
"formError
"</span><span class=
"cp">{
</span><span class=
"nf">/if
</span><span class=
"cp">}
</span><span class=
"x">></span>
2160 <span class=
"x"> <dt
><label for=
"baz
"></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"></label
></dt
></span>
2161 <span class=
"x"> <dd
></span>
2162 <span class=
"x"> <input type=
"text
" id=
"baz
" name=
"baz
" value=
"</span><span class=
"cp">{
</span><span class=
"nv">$baz
</span><span class=
"cp">}
</span><span class=
"x">" class=
"long
" required autofocus
></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">'baz
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2164 <span class=
"x"> <small class=
"innerError
"></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">'empty
'</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"> </small
></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"> </dd
></span>
2173 <span class=
"x"> </dl
></span>
2175 <span class=
"x"> <dl
></span>
2176 <span class=
"x"> <dt
><label for=
"bar
"></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"></label
></dt
></span>
2177 <span class=
"x"> <dd
></span>
2178 <span class=
"x"> <textarea name=
"bar
" id=
"bar
" cols=
"40" rows=
"10"></span><span class=
"cp">{
</span><span class=
"nv">$bar
</span><span class=
"cp">}
</span><span class=
"x"></textarea
></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">'bar
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2180 <span class=
"x"> <small class=
"innerError
"></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"></small
></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"> </dd
></span>
2183 <span class=
"x"> </dl
></span>
2185 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* other fields *
</span><span class=
"cp">}
</span><span class=
"x"></span>
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">'dataFields
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2188 <span class=
"x"> </div
></span>
2190 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* other sections *
</span><span class=
"cp">}
</span><span class=
"x"></span>
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">'sections
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2194 <span class=
"x"> <div class=
"formSubmit
"></span>
2195 <span class=
"x"> <input type=
"submit
" value=
"</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">" accesskey=
"s
"></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"> </div
></span>
2198 <span class=
"x"></form
></span>
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"><div class=
"section tabMenuContainer
"></span>
2202 <span class=
"x"> <nav class=
"tabMenu
"></span>
2203 <span class=
"x"> <ul
></span>
2204 <span class=
"x"> <li
><a href=
"</span><span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$__wcf
</span><span class=
"o">-
></span><span class=
"na">getAnchor
</span><span class=
"o">(
</span><span class=
"s1">'tab1
'</span><span class=
"o">)
</span><span class=
"cp">}
</span><span class=
"x">">Tab
1</a
></li
></span>
2205 <span class=
"x"> <li
><a href=
"</span><span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$__wcf
</span><span class=
"o">-
></span><span class=
"na">getAnchor
</span><span class=
"o">(
</span><span class=
"s1">'tab2
'</span><span class=
"o">)
</span><span class=
"cp">}
</span><span class=
"x">">Tab
2</a
></li
></span>
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">'tabMenuTabs
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2208 <span class=
"x"> </ul
></span>
2209 <span class=
"x"> </nav
></span>
2211 <span class=
"x"> <div id=
"tab1
" class=
"tabMenuContent
"></span>
2212 <span class=
"x"> <div class=
"section
"></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"> </div
></span>
2215 <span class=
"x"> </div
></span>
2217 <span class=
"x"> <div id=
"tab2
" class=
"tabMenuContainer tabMenuContent
"></span>
2218 <span class=
"x"> <nav class=
"menu
"></span>
2219 <span class=
"x"> <ul
></span>
2220 <span class=
"x"> <li
><a href=
"</span><span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$__wcf
</span><span class=
"o">-
></span><span class=
"na">getAnchor
</span><span class=
"o">(
</span><span class=
"s1">'tab2A
'</span><span class=
"o">)
</span><span class=
"cp">}
</span><span class=
"x">">Tab
2A
</a
></li
></span>
2221 <span class=
"x"> <li
><a href=
"</span><span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$__wcf
</span><span class=
"o">-
></span><span class=
"na">getAnchor
</span><span class=
"o">(
</span><span class=
"s1">'tab2B
'</span><span class=
"o">)
</span><span class=
"cp">}
</span><span class=
"x">">Tab
2B
</a
></li
></span>
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">'tabMenuTab2Subtabs
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2224 <span class=
"x"> </ul
></span>
2225 <span class=
"x"> </nav
></span>
2227 <span class=
"x"> <div id=
"tab2A
" class=
"tabMenuContent
"></span>
2228 <span class=
"x"> <div class=
"section
"></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"> </div
></span>
2231 <span class=
"x"> </div
></span>
2233 <span class=
"x"> <div id=
"tab2B
" class=
"tabMenuContent
"></span>
2234 <span class=
"x"> <div class=
"section
"></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"> </div
></span>
2237 <span class=
"x"> </div
></span>
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">'tabMenuTab2Contents
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2240 <span class=
"x"> </div
></span>
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">'tabMenuContents
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2243 <span class=
"x"></div
></span>
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()-
>assign('foo', 'bar')
</code> and accessed in templates via
<code>$foo
</code>:
</p>
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>
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">-
></span><span class=
"na">assign
</span><span class=
"p">([
</span>
2257 <span class=
"s1">'foo
'</span> <span class=
"o">=
></span> <span class=
"s1">'bar
'</span><span class=
"p">,
</span>
2258 <span class=
"s1">'baz
'</span> <span class=
"o">=
></span> <span class=
"k">false
</span>
2259 <span class=
"p">]);
</span>
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>
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>
2274 <p>Furthermore, the following template variables are also automatically assigned:
</p>
2276 <li><code>$__wcf
</code> contains the
<code>WCF
</code> object (or
<code>WCFACP
</code> object in the backend).
</li>
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>
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>
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">'bar
'</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">'baz
'</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>
2296 <p>The supported operators in conditions are
<code>===
</code>,
<code>!==
</code>,
<code>==
</code>,
<code>!=
</code>,
<code><=
</code>,
<code><</code>,
<code>>=
</code>,
<code>></code>,
<code>||
</code>,
<code>&&</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>
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">></span> <span class=
"m">3</span> <span class=
"o">&&</span> <span class=
"nv">$bar
</span><span class=
"o">|
</span><span class=
"na">count
</span> <span class=
"o"><</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>
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"><ul
></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"> <li
></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"></li
></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"></ul
></span>
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"><ul
></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>
2320 <span class=
"x"> <li
>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"></li
></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"></ul
></span>
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>
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">'foo
'</span><span class=
"cp">}
</span><span class=
"x"></span>
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">'foo
'</span> <span class=
"na">application
</span><span class=
"o">=
</span><span class=
"s1">'app
'</span><span class=
"cp">}
</span><span class=
"x"></span>
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">'foo
'</span> <span class=
"na">application
</span><span class=
"o">=
</span><span class=
"s1">'app
'</span> <span class=
"na">var1
</span><span class=
"o">=
</span><span class=
"s1">'foo1
'</span> <span class=
"na">var2
</span><span class=
"o">=
</span><span class=
"s1">'foo2
'</span><span class=
"cp">}
</span><span class=
"x"></span>
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>
2348 <div class=
"md-source-date">
2351 Last update:
2021-
01-
15
2369 <footer class=
"md-footer">
2371 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2373 <a href=
"../languages/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2374 <div class=
"md-footer__button md-icon">
2375 <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>
2377 <div class=
"md-footer__title">
2378 <div class=
"md-ellipsis">
2379 <span class=
"md-footer__direction">
2388 <a href=
"../css/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2389 <div class=
"md-footer__title">
2390 <div class=
"md-ellipsis">
2391 <span class=
"md-footer__direction">
2397 <div class=
"md-footer__button md-icon">
2398 <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>
2404 <div class=
"md-footer-meta md-typeset">
2405 <div class=
"md-footer-meta__inner md-grid">
2406 <div class=
"md-footer-copyright">
2408 <div class=
"md-footer-copyright__highlight">
2409 Copyright ©
2020 WoltLab GmbH
2413 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2418 <div class=
"md-footer-copyright">
2419 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2420 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2427 <div class=
"md-dialog" data-md-component=
"dialog">
2428 <div class=
"md-dialog__inner md-typeset"></div>
2430 <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>
2433 <script src=
"../../assets/javascripts/bundle.5cf3e710.min.js"></script>