3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>Template Plugins - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.ef6f36e2.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=
"">
55 <script>function __prefix(e){return new URL(
"../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
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">
63 <a href=
"#template-plugins" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
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">
84 <img src=
"../../assets/logo.png" alt=
"logo">
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>
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
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
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>
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>
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>
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">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
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">
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>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
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">
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">
176 <img src=
"../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
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">
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>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
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>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
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>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
310 <li class=
"md-nav__item md-nav__item--nested">
313 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
315 <label class=
"md-nav__link" for=
"__nav_2_5_1">
317 <span class=
"md-nav__icon md-icon"></span>
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>
324 <ul class=
"md-nav__list" data-md-scrollfix
>
330 <li class=
"md-nav__item">
331 <a href=
"../../php/api/caches/" class=
"md-nav__link">
342 <li class=
"md-nav__item">
343 <a href=
"../../php/api/caches_persistent-caches/" class=
"md-nav__link">
354 <li class=
"md-nav__item">
355 <a href=
"../../php/api/caches_runtime-caches/" class=
"md-nav__link">
372 <li class=
"md-nav__item">
373 <a href=
"../../php/api/comments/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../php/api/events/" class=
"md-nav__link">
409 <li class=
"md-nav__item md-nav__item--nested">
412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
414 <label class=
"md-nav__link" for=
"__nav_2_5_5">
416 <span class=
"md-nav__icon md-icon"></span>
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>
423 <ul class=
"md-nav__list" data-md-scrollfix
>
429 <li class=
"md-nav__item">
430 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
453 <li class=
"md-nav__item">
454 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
465 <li class=
"md-nav__item">
466 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
495 <li class=
"md-nav__item">
496 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
497 Package Installation Plugins
507 <li class=
"md-nav__item">
508 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
549 <li class=
"md-nav__item">
550 <a href=
"../../php/code-style/" class=
"md-nav__link">
561 <li class=
"md-nav__item">
562 <a href=
"../../php/apps/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../php/gdpr/" class=
"md-nav__link">
597 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
600 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" checked
>
602 <label class=
"md-nav__link" for=
"__nav_3">
603 Languages, Templates & CSS
604 <span class=
"md-nav__icon md-icon"></span>
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
611 <ul class=
"md-nav__list" data-md-scrollfix
>
617 <li class=
"md-nav__item">
618 <a href=
"../languages/" class=
"md-nav__link">
629 <li class=
"md-nav__item">
630 <a href=
"../templates/" class=
"md-nav__link">
643 <li class=
"md-nav__item md-nav__item--active">
645 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
650 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
652 <span class=
"md-nav__icon md-icon"></span>
655 <a href=
"./" class=
"md-nav__link md-nav__link--active">
660 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
666 <label class=
"md-nav__title" for=
"__toc">
667 <span class=
"md-nav__icon md-icon"></span>
670 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
672 <li class=
"md-nav__item">
673 <a href=
"#53-anchor" class=
"md-nav__link">
679 <li class=
"md-nav__item">
680 <a href=
"#53-anchorattributes" class=
"md-nav__link">
681 5.3+ anchorAttributes
686 <li class=
"md-nav__item">
687 <a href=
"#append" class=
"md-nav__link">
693 <li class=
"md-nav__item">
694 <a href=
"#assign" class=
"md-nav__link">
700 <li class=
"md-nav__item">
701 <a href=
"#capture" class=
"md-nav__link">
707 <li class=
"md-nav__item">
708 <a href=
"#concat" class=
"md-nav__link">
714 <li class=
"md-nav__item">
715 <a href=
"#counter" class=
"md-nav__link">
721 <li class=
"md-nav__item">
722 <a href=
"#54-csrftoken" class=
"md-nav__link">
728 <li class=
"md-nav__item">
729 <a href=
"#currency" class=
"md-nav__link">
735 <li class=
"md-nav__item">
736 <a href=
"#cycle" class=
"md-nav__link">
742 <li class=
"md-nav__item">
743 <a href=
"#date" class=
"md-nav__link">
749 <li class=
"md-nav__item">
750 <a href=
"#31-dateinterval" class=
"md-nav__link">
756 <li class=
"md-nav__item">
757 <a href=
"#encodejs" class=
"md-nav__link">
763 <li class=
"md-nav__item">
764 <a href=
"#encodejson" class=
"md-nav__link">
770 <li class=
"md-nav__item">
771 <a href=
"#escapecdata" class=
"md-nav__link">
777 <li class=
"md-nav__item">
778 <a href=
"#event" class=
"md-nav__link">
784 <li class=
"md-nav__item">
785 <a href=
"#fetch" class=
"md-nav__link">
791 <li class=
"md-nav__item">
792 <a href=
"#filesizebinary" class=
"md-nav__link">
798 <li class=
"md-nav__item">
799 <a href=
"#filesize" class=
"md-nav__link">
805 <li class=
"md-nav__item">
806 <a href=
"#hascontent" class=
"md-nav__link">
812 <li class=
"md-nav__item">
813 <a href=
"#htmlcheckboxes" class=
"md-nav__link">
819 <li class=
"md-nav__item">
820 <a href=
"#htmloptions" class=
"md-nav__link">
826 <li class=
"md-nav__item">
827 <a href=
"#implode" class=
"md-nav__link">
833 <li class=
"md-nav__item">
834 <a href=
"#52-ipsearch" class=
"md-nav__link">
840 <li class=
"md-nav__item">
841 <a href=
"#30-js" class=
"md-nav__link">
847 <li class=
"md-nav__item">
848 <a href=
"#53-jslang" class=
"md-nav__link">
854 <li class=
"md-nav__item">
855 <a href=
"#lang" class=
"md-nav__link">
861 <li class=
"md-nav__item">
862 <a href=
"#language" class=
"md-nav__link">
868 <li class=
"md-nav__item">
869 <a href=
"#link" class=
"md-nav__link">
875 <li class=
"md-nav__item">
876 <a href=
"#newlinetobreak" class=
"md-nav__link">
882 <li class=
"md-nav__item">
883 <a href=
"#30-page" class=
"md-nav__link">
889 <li class=
"md-nav__item">
890 <a href=
"#pages" class=
"md-nav__link">
896 <li class=
"md-nav__item">
897 <a href=
"#plaintime" class=
"md-nav__link">
903 <li class=
"md-nav__item">
904 <a href=
"#53-plural" class=
"md-nav__link">
910 <li class=
"md-nav__item">
911 <a href=
"#prepend" class=
"md-nav__link">
917 <li class=
"md-nav__item">
918 <a href=
"#shortunit" class=
"md-nav__link">
924 <li class=
"md-nav__item">
925 <a href=
"#smallpages" class=
"md-nav__link">
931 <li class=
"md-nav__item">
932 <a href=
"#tablewordwrap" class=
"md-nav__link">
938 <li class=
"md-nav__item">
939 <a href=
"#time" class=
"md-nav__link">
945 <li class=
"md-nav__item">
946 <a href=
"#truncate" class=
"md-nav__link">
952 <li class=
"md-nav__item">
953 <a href=
"#53-user" class=
"md-nav__link">
971 <li class=
"md-nav__item">
972 <a href=
"../css/" class=
"md-nav__link">
993 <li class=
"md-nav__item md-nav__item--nested">
996 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
998 <label class=
"md-nav__link" for=
"__nav_4">
999 TypeScript and JavaScript API
1000 <span class=
"md-nav__icon md-icon"></span>
1002 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
1003 <label class=
"md-nav__title" for=
"__nav_4">
1004 <span class=
"md-nav__icon md-icon"></span>
1005 TypeScript and JavaScript API
1007 <ul class=
"md-nav__list" data-md-scrollfix
>
1013 <li class=
"md-nav__item">
1014 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
1025 <li class=
"md-nav__item">
1026 <a href=
"../../javascript/typescript/" class=
"md-nav__link">
1038 <li class=
"md-nav__item md-nav__item--nested">
1041 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
1043 <label class=
"md-nav__link" for=
"__nav_4_3">
1045 <span class=
"md-nav__icon md-icon"></span>
1047 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
1048 <label class=
"md-nav__title" for=
"__nav_4_3">
1049 <span class=
"md-nav__icon md-icon"></span>
1052 <ul class=
"md-nav__list" data-md-scrollfix
>
1058 <li class=
"md-nav__item">
1059 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
1070 <li class=
"md-nav__item">
1071 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
1082 <li class=
"md-nav__item">
1083 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
1094 <li class=
"md-nav__item">
1095 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
1106 <li class=
"md-nav__item">
1107 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
1118 <li class=
"md-nav__item">
1119 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
1130 <li class=
"md-nav__item">
1131 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
1142 <li class=
"md-nav__item">
1143 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
1144 Browser and Screen Sizes
1154 <li class=
"md-nav__item">
1155 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
1172 <li class=
"md-nav__item">
1173 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
1184 <li class=
"md-nav__item">
1185 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
1196 <li class=
"md-nav__item">
1197 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
1218 <li class=
"md-nav__item md-nav__item--nested">
1221 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1223 <label class=
"md-nav__link" for=
"__nav_5">
1225 <span class=
"md-nav__icon md-icon"></span>
1227 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1228 <label class=
"md-nav__title" for=
"__nav_5">
1229 <span class=
"md-nav__icon md-icon"></span>
1232 <ul class=
"md-nav__list" data-md-scrollfix
>
1238 <li class=
"md-nav__item">
1239 <a href=
"../../package/package-xml/" class=
"md-nav__link">
1251 <li class=
"md-nav__item md-nav__item--nested">
1254 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1256 <label class=
"md-nav__link" for=
"__nav_5_2">
1258 <span class=
"md-nav__icon md-icon"></span>
1260 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1261 <label class=
"md-nav__title" for=
"__nav_5_2">
1262 <span class=
"md-nav__icon md-icon"></span>
1265 <ul class=
"md-nav__list" data-md-scrollfix
>
1271 <li class=
"md-nav__item">
1272 <a href=
"../../package/pip/" class=
"md-nav__link">
1283 <li class=
"md-nav__item">
1284 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1295 <li class=
"md-nav__item">
1296 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1307 <li class=
"md-nav__item">
1308 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1319 <li class=
"md-nav__item">
1320 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1331 <li class=
"md-nav__item">
1332 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1343 <li class=
"md-nav__item">
1344 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1355 <li class=
"md-nav__item">
1356 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1367 <li class=
"md-nav__item">
1368 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1379 <li class=
"md-nav__item">
1380 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1391 <li class=
"md-nav__item">
1392 <a href=
"../../package/pip/database/" class=
"md-nav__link">
1403 <li class=
"md-nav__item">
1404 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1415 <li class=
"md-nav__item">
1416 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1427 <li class=
"md-nav__item">
1428 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1439 <li class=
"md-nav__item">
1440 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1451 <li class=
"md-nav__item">
1452 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1463 <li class=
"md-nav__item">
1464 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1475 <li class=
"md-nav__item">
1476 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1487 <li class=
"md-nav__item">
1488 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1489 objectTypeDefinition
1499 <li class=
"md-nav__item">
1500 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1511 <li class=
"md-nav__item">
1512 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1523 <li class=
"md-nav__item">
1524 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1535 <li class=
"md-nav__item">
1536 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1547 <li class=
"md-nav__item">
1548 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1559 <li class=
"md-nav__item">
1560 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1571 <li class=
"md-nav__item">
1572 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1583 <li class=
"md-nav__item">
1584 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1595 <li class=
"md-nav__item">
1596 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1607 <li class=
"md-nav__item">
1608 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1619 <li class=
"md-nav__item">
1620 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1631 <li class=
"md-nav__item">
1632 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1633 userNotificationEvent
1643 <li class=
"md-nav__item">
1644 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1655 <li class=
"md-nav__item">
1656 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1673 <li class=
"md-nav__item">
1674 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1695 <li class=
"md-nav__item md-nav__item--nested">
1698 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1700 <label class=
"md-nav__link" for=
"__nav_6">
1702 <span class=
"md-nav__icon md-icon"></span>
1704 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1705 <label class=
"md-nav__title" for=
"__nav_6">
1706 <span class=
"md-nav__icon md-icon"></span>
1709 <ul class=
"md-nav__list" data-md-scrollfix
>
1716 <li class=
"md-nav__item md-nav__item--nested">
1719 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1721 <label class=
"md-nav__link" for=
"__nav_6_1">
1722 Migrating from WSC
5.3
1723 <span class=
"md-nav__icon md-icon"></span>
1725 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1726 <label class=
"md-nav__title" for=
"__nav_6_1">
1727 <span class=
"md-nav__icon md-icon"></span>
1728 Migrating from WSC
5.3
1730 <ul class=
"md-nav__list" data-md-scrollfix
>
1736 <li class=
"md-nav__item">
1737 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1748 <li class=
"md-nav__item">
1749 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1750 Session Handling and Authentication
1760 <li class=
"md-nav__item">
1761 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1762 TypeScript and JavaScript
1772 <li class=
"md-nav__item">
1773 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1784 <li class=
"md-nav__item">
1785 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1786 Third Party Libraries
1803 <li class=
"md-nav__item md-nav__item--nested">
1806 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1808 <label class=
"md-nav__link" for=
"__nav_6_2">
1809 Migrating from WSC
5.2
1810 <span class=
"md-nav__icon md-icon"></span>
1812 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1813 <label class=
"md-nav__title" for=
"__nav_6_2">
1814 <span class=
"md-nav__icon md-icon"></span>
1815 Migrating from WSC
5.2
1817 <ul class=
"md-nav__list" data-md-scrollfix
>
1823 <li class=
"md-nav__item">
1824 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1835 <li class=
"md-nav__item">
1836 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1837 Templates and Languages
1847 <li class=
"md-nav__item">
1848 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1849 Third Party Libraries
1866 <li class=
"md-nav__item md-nav__item--nested">
1869 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1871 <label class=
"md-nav__link" for=
"__nav_6_3">
1872 Migrating from WSC
3.1
1873 <span class=
"md-nav__icon md-icon"></span>
1875 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1876 <label class=
"md-nav__title" for=
"__nav_6_3">
1877 <span class=
"md-nav__icon md-icon"></span>
1878 Migrating from WSC
3.1
1880 <ul class=
"md-nav__list" data-md-scrollfix
>
1886 <li class=
"md-nav__item">
1887 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1905 <li class=
"md-nav__item md-nav__item--nested">
1908 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1910 <label class=
"md-nav__link" for=
"__nav_6_4">
1911 Migrating from WSC
3.0
1912 <span class=
"md-nav__icon md-icon"></span>
1914 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1915 <label class=
"md-nav__title" for=
"__nav_6_4">
1916 <span class=
"md-nav__icon md-icon"></span>
1917 Migrating from WSC
3.0
1919 <ul class=
"md-nav__list" data-md-scrollfix
>
1925 <li class=
"md-nav__item">
1926 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1937 <li class=
"md-nav__item">
1938 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1949 <li class=
"md-nav__item">
1950 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1961 <li class=
"md-nav__item">
1962 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1973 <li class=
"md-nav__item">
1974 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1992 <li class=
"md-nav__item md-nav__item--nested">
1995 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1997 <label class=
"md-nav__link" for=
"__nav_6_5">
1998 Migrating from WCF
2.1
1999 <span class=
"md-nav__icon md-icon"></span>
2001 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
2002 <label class=
"md-nav__title" for=
"__nav_6_5">
2003 <span class=
"md-nav__icon md-icon"></span>
2004 Migrating from WCF
2.1
2006 <ul class=
"md-nav__list" data-md-scrollfix
>
2012 <li class=
"md-nav__item">
2013 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
2024 <li class=
"md-nav__item">
2025 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
2036 <li class=
"md-nav__item">
2037 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
2048 <li class=
"md-nav__item">
2049 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
2076 <li class=
"md-nav__item md-nav__item--nested">
2079 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
2081 <label class=
"md-nav__link" for=
"__nav_7">
2083 <span class=
"md-nav__icon md-icon"></span>
2085 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
2086 <label class=
"md-nav__title" for=
"__nav_7">
2087 <span class=
"md-nav__icon md-icon"></span>
2090 <ul class=
"md-nav__list" data-md-scrollfix
>
2097 <li class=
"md-nav__item md-nav__item--nested">
2100 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
2102 <label class=
"md-nav__link" for=
"__nav_7_1">
2104 <span class=
"md-nav__icon md-icon"></span>
2106 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
2107 <label class=
"md-nav__title" for=
"__nav_7_1">
2108 <span class=
"md-nav__icon md-icon"></span>
2111 <ul class=
"md-nav__list" data-md-scrollfix
>
2117 <li class=
"md-nav__item">
2118 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
2129 <li class=
"md-nav__item">
2130 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
2141 <li class=
"md-nav__item">
2142 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
2153 <li class=
"md-nav__item">
2154 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
2181 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2182 <div class=
"md-sidebar__scrollwrap">
2183 <div class=
"md-sidebar__inner">
2185 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2191 <label class=
"md-nav__title" for=
"__toc">
2192 <span class=
"md-nav__icon md-icon"></span>
2195 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2197 <li class=
"md-nav__item">
2198 <a href=
"#53-anchor" class=
"md-nav__link">
2204 <li class=
"md-nav__item">
2205 <a href=
"#53-anchorattributes" class=
"md-nav__link">
2206 5.3+ anchorAttributes
2211 <li class=
"md-nav__item">
2212 <a href=
"#append" class=
"md-nav__link">
2218 <li class=
"md-nav__item">
2219 <a href=
"#assign" class=
"md-nav__link">
2225 <li class=
"md-nav__item">
2226 <a href=
"#capture" class=
"md-nav__link">
2232 <li class=
"md-nav__item">
2233 <a href=
"#concat" class=
"md-nav__link">
2239 <li class=
"md-nav__item">
2240 <a href=
"#counter" class=
"md-nav__link">
2246 <li class=
"md-nav__item">
2247 <a href=
"#54-csrftoken" class=
"md-nav__link">
2253 <li class=
"md-nav__item">
2254 <a href=
"#currency" class=
"md-nav__link">
2260 <li class=
"md-nav__item">
2261 <a href=
"#cycle" class=
"md-nav__link">
2267 <li class=
"md-nav__item">
2268 <a href=
"#date" class=
"md-nav__link">
2274 <li class=
"md-nav__item">
2275 <a href=
"#31-dateinterval" class=
"md-nav__link">
2281 <li class=
"md-nav__item">
2282 <a href=
"#encodejs" class=
"md-nav__link">
2288 <li class=
"md-nav__item">
2289 <a href=
"#encodejson" class=
"md-nav__link">
2295 <li class=
"md-nav__item">
2296 <a href=
"#escapecdata" class=
"md-nav__link">
2302 <li class=
"md-nav__item">
2303 <a href=
"#event" class=
"md-nav__link">
2309 <li class=
"md-nav__item">
2310 <a href=
"#fetch" class=
"md-nav__link">
2316 <li class=
"md-nav__item">
2317 <a href=
"#filesizebinary" class=
"md-nav__link">
2323 <li class=
"md-nav__item">
2324 <a href=
"#filesize" class=
"md-nav__link">
2330 <li class=
"md-nav__item">
2331 <a href=
"#hascontent" class=
"md-nav__link">
2337 <li class=
"md-nav__item">
2338 <a href=
"#htmlcheckboxes" class=
"md-nav__link">
2344 <li class=
"md-nav__item">
2345 <a href=
"#htmloptions" class=
"md-nav__link">
2351 <li class=
"md-nav__item">
2352 <a href=
"#implode" class=
"md-nav__link">
2358 <li class=
"md-nav__item">
2359 <a href=
"#52-ipsearch" class=
"md-nav__link">
2365 <li class=
"md-nav__item">
2366 <a href=
"#30-js" class=
"md-nav__link">
2372 <li class=
"md-nav__item">
2373 <a href=
"#53-jslang" class=
"md-nav__link">
2379 <li class=
"md-nav__item">
2380 <a href=
"#lang" class=
"md-nav__link">
2386 <li class=
"md-nav__item">
2387 <a href=
"#language" class=
"md-nav__link">
2393 <li class=
"md-nav__item">
2394 <a href=
"#link" class=
"md-nav__link">
2400 <li class=
"md-nav__item">
2401 <a href=
"#newlinetobreak" class=
"md-nav__link">
2407 <li class=
"md-nav__item">
2408 <a href=
"#30-page" class=
"md-nav__link">
2414 <li class=
"md-nav__item">
2415 <a href=
"#pages" class=
"md-nav__link">
2421 <li class=
"md-nav__item">
2422 <a href=
"#plaintime" class=
"md-nav__link">
2428 <li class=
"md-nav__item">
2429 <a href=
"#53-plural" class=
"md-nav__link">
2435 <li class=
"md-nav__item">
2436 <a href=
"#prepend" class=
"md-nav__link">
2442 <li class=
"md-nav__item">
2443 <a href=
"#shortunit" class=
"md-nav__link">
2449 <li class=
"md-nav__item">
2450 <a href=
"#smallpages" class=
"md-nav__link">
2456 <li class=
"md-nav__item">
2457 <a href=
"#tablewordwrap" class=
"md-nav__link">
2463 <li class=
"md-nav__item">
2464 <a href=
"#time" class=
"md-nav__link">
2470 <li class=
"md-nav__item">
2471 <a href=
"#truncate" class=
"md-nav__link">
2477 <li class=
"md-nav__item">
2478 <a href=
"#53-user" class=
"md-nav__link">
2492 <div class=
"md-content" data-md-component=
"content">
2493 <article class=
"md-content__inner md-typeset">
2496 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/view/template-plugins.md" title=
"Edit this page" class=
"md-content__button md-icon">
2497 <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>
2501 <h1 id=
"template-plugins">Template Plugins
<a class=
"headerlink" href=
"#template-plugins" title=
"Permanent link">#
</a></h1>
2502 <h2 id=
"53-anchor"><span class=
"label label-info">5.3+
</span> <code>anchor
</code><a class=
"headerlink" href=
"#53-anchor" title=
"Permanent link">#
</a></h2>
2503 <p>The
<code>anchor
</code> template plugin creates
<code>a
</code> HTML elements.
2504 The easiest way to use the template plugin is to pass it an instance of
<code>ITitledLinkObject
</code>:
</p>
2505 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">anchor
</span> <span class=
"na">object
</span><span class=
"o">=
</span><span class=
"nv">$object
</span><span class=
"cp">}
</span><span class=
"x"></span>
2507 <p>generates the same output as
</p>
2508 <div class=
"highlight"><pre><span></span><code><span class=
"x"><a href=
"</span><span class=
"cp">{
</span><span class=
"nv">$object
</span><span class=
"o">-
></span><span class=
"na">getLink
</span><span class=
"o">()
</span><span class=
"cp">}
</span><span class=
"x">"></span><span class=
"cp">{
</span><span class=
"nv">$object
</span><span class=
"o">-
></span><span class=
"na">getTitle
</span><span class=
"o">()
</span><span class=
"cp">}
</span><span class=
"x"></a
></span>
2510 <p>Instead of an
<code>object
</code> parameter, a
<code>link
</code> and
<code>content
</code> parameter can be used:
</p>
2511 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">anchor
</span> <span class=
"na">link
</span><span class=
"o">=
</span><span class=
"nv">$linkObject
</span> <span class=
"na">content
</span><span class=
"o">=
</span><span class=
"nv">$content
</span><span class=
"cp">}
</span><span class=
"x"></span>
2513 <p>where
<code>$linkObject
</code> implements
<code>ILinkableObject
</code> and
<code>$content
</code> is either an object implementing
<code>ITitledObject
</code> or having a
<code>__toString()
</code> method or
<code>$content
</code> is a string or a number.
</p>
2514 <p>The last special attribute is
<code>append
</code> whose contents are appended to the
<code>href
</code> attribute of the generated anchor element.
</p>
2515 <p>All of the other attributes matching
<code>~^[a-z]+([A-z]+)+$~
</code>, expect for
<code>href
</code> which is disallowed, are added as attributes to the anchor element.
</p>
2516 <p>If an
<code>object
</code> attribute is present, the object also implements
<code>IPopoverObject
</code> and if the return value of
<code>IPopoverObject::getPopoverLinkClass()
</code> is included in the
<code>class
</code> attribute of the
<code>anchor
</code> tag,
<code>data-object-id
</code> is automatically added.
2517 This functionality makes it easy to generate links with popover support.
2519 <div class=
"highlight"><pre><span></span><code><span class=
"x"><a href=
"</span><span class=
"cp">{
</span><span class=
"nv">$entry
</span><span class=
"o">-
></span><span class=
"na">getLink
</span><span class=
"o">()
</span><span class=
"cp">}
</span><span class=
"x">" class=
"blogEntryLink
" data-object-id=
"</span><span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$entry
</span><span class=
"o">-
></span><span class=
"na">entryID
</span><span class=
"cp">}
</span><span class=
"x">"></span><span class=
"cp">{
</span><span class=
"nv">$entry
</span><span class=
"o">-
></span><span class=
"na">subject
</span><span class=
"cp">}
</span><span class=
"x"></a
></span>
2522 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">anchor
</span> <span class=
"na">object
</span><span class=
"o">=
</span><span class=
"nv">$entry
</span> <span class=
"na">class
</span><span class=
"o">=
</span><span class=
"s1">'blogEntryLink
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2524 <p>is sufficient if
<code>Entry::getPopoverLinkClass()
</code> returns
<code>blogEntryLink
</code>.
</p>
2525 <h2 id=
"53-anchorattributes"><span class=
"label label-info">5.3+
</span> <code>anchorAttributes
</code><a class=
"headerlink" href=
"#53-anchorattributes" title=
"Permanent link">#
</a></h2>
2526 <p><code>anchorAttributes
</code> compliments the
<code>StringUtil::getAnchorTagAttributes(string, bool): string
</code> method.
2527 It allows to easily generate the necessary attributes for an anchor tag based off the destination URL.
</p>
2528 <div class=
"highlight"><pre><span></span><code><span class=
"x"><a href=
"https://www.example.com
" </span><span class=
"cp">{
</span><span class=
"nf">anchorAttributes
</span> <span class=
"na">url
</span><span class=
"o">=
</span><span class=
"s1">'https://www.example.com
'</span> <span class=
"na">appendHref
</span><span class=
"o">=
</span><span class=
"kc">false
</span> <span class=
"na">appendClassname
</span><span class=
"o">=
</span><span class=
"kc">true
</span> <span class=
"na">isUgc
</span><span class=
"o">=
</span><span class=
"kc">true
</span><span class=
"cp">}
</span><span class=
"x">></span>
2534 <th>Description
</th>
2539 <td><code>url
</code></td>
2540 <td>destination URL
</td>
2543 <td><code>appendHref
</code></td>
2544 <td>whether the
<code>href
</code> attribute should be generated;
<code>true
</code> by default
</td>
2547 <td><code>isUgc
</code></td>
2548 <td>whether the
<code>rel=
"ugc"</code> attribute should be generated;
<code>false
</code> by default
</td>
2551 <td><code>appendClassname
</code></td>
2552 <td>whether the
<code>class=
"externalURL"</code> attribute should be generated;
<code>true
</code> by default
</td>
2556 <h2 id=
"append"><code>append
</code><a class=
"headerlink" href=
"#append" title=
"Permanent link">#
</a></h2>
2557 <p>If a string should be appended to the value of a variable,
<code>append
</code> can be used:
</p>
2558 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">assign
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">templateVariable
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"s1">'newValue
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2560 <span class=
"cp">{
</span><span class=
"nv">$templateVariable
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
'newValue *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2562 <span class=
"cp">{
</span><span class=
"nf">append
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">templateVariable
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"s1">'2'</span><span class=
"cp">}
</span><span class=
"x"></span>
2564 <span class=
"cp">{
</span><span class=
"nv">$templateVariable
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* now prints
'newValue2 *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2566 <p>If the variables does not exist yet,
<code>append
</code> creates a new one with the given value.
2567 If
<code>append
</code> is used on an array as the variable, the value is appended to all elements of the array.
</p>
2568 <h2 id=
"assign"><code>assign
</code><a class=
"headerlink" href=
"#assign" title=
"Permanent link">#
</a></h2>
2569 <p>New template variables can be declared and new values can be assigned to existing template variables using
<code>assign
</code>:
</p>
2570 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">assign
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">templateVariable
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"s1">'newValue
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2572 <span class=
"cp">{
</span><span class=
"nv">$templateVariable
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
'newValue *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2574 <h2 id=
"capture"><code>capture
</code><a class=
"headerlink" href=
"#capture" title=
"Permanent link">#
</a></h2>
2575 <p>In some situations,
<code>assign
</code> is not sufficient to assign values to variables in templates if the value is complex.
2576 Instead,
<code>capture
</code> can be used:
</p>
2577 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">capture
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">templateVariable
</span><span class=
"cp">}
</span><span class=
"x"></span>
2578 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">if
</span> <span class=
"nv">$foo
</span><span class=
"cp">}
</span><span class=
"x"></span>
2579 <span class=
"x"> <p
></span><span class=
"cp">{
</span><span class=
"nv">$bar
</span><span class=
"cp">}
</span><span class=
"x"></p
></span>
2580 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">else
</span><span class=
"cp">}
</span><span class=
"x"></span>
2581 <span class=
"x"> <small
></span><span class=
"cp">{
</span><span class=
"nv">$baz
</span><span class=
"cp">}
</span><span class=
"x"></small
></span>
2582 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">/if
</span><span class=
"cp">}
</span><span class=
"x"></span>
2583 <span class=
"cp">{
</span><span class=
"nf">/capture
</span><span class=
"cp">}
</span><span class=
"x"></span>
2585 <h2 id=
"concat"><code>concat
</code><a class=
"headerlink" href=
"#concat" title=
"Permanent link">#
</a></h2>
2586 <p><code>concat
</code> is a modifier used to concatenate multiple strings:
</p>
2587 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">assign
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">foo
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"s1">'foo
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2589 <span class=
"cp">{
</span><span class=
"nf">assign
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">templateVariable
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"s1">'bar
'</span><span class=
"o">|
</span><span class=
"na">concat
</span><span class=
"o">:
</span><span class=
"nv">$foo
</span><span class=
"cp">}
</span><span class=
"x"></span>
2591 <span class=
"cp">{
</span><span class=
"nv">$templateVariable
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
'foobar *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2593 <h2 id=
"counter"><code>counter
</code><a class=
"headerlink" href=
"#counter" title=
"Permanent link">#
</a></h2>
2594 <p><code>counter
</code> can be used to generate and optionally print a counter:
</p>
2595 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">counter
</span> <span class=
"na">name
</span><span class=
"o">=
</span><span class=
"na">fooCounter
</span> <span class=
"na">print
</span><span class=
"o">=
</span><span class=
"kc">true
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
'1' *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2597 <span class=
"cp">{
</span><span class=
"nf">counter
</span> <span class=
"na">name
</span><span class=
"o">=
</span><span class=
"na">fooCounter
</span> <span class=
"na">print
</span><span class=
"o">=
</span><span class=
"kc">true
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
'2' now *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2599 <span class=
"cp">{
</span><span class=
"nf">counter
</span> <span class=
"na">name
</span><span class=
"o">=
</span><span class=
"na">fooCounter
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints nothing, but counter value is
'3' now internally *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2601 <span class=
"cp">{
</span><span class=
"nf">counter
</span> <span class=
"na">name
</span><span class=
"o">=
</span><span class=
"na">fooCounter
</span> <span class=
"na">print
</span><span class=
"o">=
</span><span class=
"kc">true
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
'4' *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2603 <p>Counter supports the following attributes:
</p>
2608 <th>Description
</th>
2613 <td><code>assign
</code></td>
2614 <td>optional name of the template variable the current counter value is assigned to
</td>
2617 <td><code>direction
</code></td>
2618 <td>counting direction, either
<code>up
</code> or
<code>down
</code>;
<code>up
</code> by default
</td>
2621 <td><code>name
</code></td>
2622 <td>name of the counter, relevant if multiple counters are used simultaneously
</td>
2625 <td><code>print
</code></td>
2626 <td>if
<code>true
</code>, the current counter value is printed;
<code>false
</code> by default
</td>
2629 <td><code>skip
</code></td>
2630 <td>positive counting increment;
<code>1</code> by default
</td>
2633 <td><code>start
</code></td>
2634 <td>start counter value;
<code>1</code> by default
</td>
2638 <h2 id=
"54-csrftoken"><span class=
"label label-info">5.4+
</span> <code>csrfToken
</code><a class=
"headerlink" href=
"#54-csrftoken" title=
"Permanent link">#
</a></h2>
2639 <p><code>{csrfToken}
</code> prints out the session's CSRF token (“Security Token”).
</p>
2640 <div class=
"highlight"><pre><span></span><code><span class=
"x"><form action=
"</span><span class=
"cp">{
</span><span class=
"nf">link
</span> <span class=
"na">controller
</span><span class=
"o">=
</span><span class=
"s2">"Foo
"</span><span class=
"cp">}{
</span><span class=
"nf">/link
</span><span class=
"cp">}
</span><span class=
"x">" method=
"post
"></span>
2641 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* snip *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2643 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">csrfToken
</span><span class=
"cp">}
</span><span class=
"x"></span>
2644 <span class=
"x"></form
></span>
2646 <p>The
<code>{csrfToken}
</code> template plugin supports a
<code>type
</code> parameter.
2647 Specifying this parameter might be required in rare situations.
2648 Please
<a href=
"https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/template/plugin/CsrfTokenFunctionTemplatePlugin.class.php">check the implementation
</a> for details.
</p>
2649 <h2 id=
"currency"><code>currency
</code><a class=
"headerlink" href=
"#currency" title=
"Permanent link">#
</a></h2>
2650 <p><code>currency
</code> is a modifier used to format currency values with two decimals using language dependent thousands separators and decimal point:
</p>
2651 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">assign
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">currencyValue
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"m">12.345</span><span class=
"cp">}
</span><span class=
"x"></span>
2653 <span class=
"cp">{
</span><span class=
"nv">$currencyValue
</span><span class=
"o">|
</span><span class=
"na">currency
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
'12.34' *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2655 <h2 id=
"cycle"><code>cycle
</code><a class=
"headerlink" href=
"#cycle" title=
"Permanent link">#
</a></h2>
2656 <p><code>cycle
</code> can be used to cycle between different values:
</p>
2657 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">cycle
</span> <span class=
"na">name
</span><span class=
"o">=
</span><span class=
"na">fooCycle
</span> <span class=
"na">values
</span><span class=
"o">=
</span><span class=
"s1">'bar,baz
'</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
'bar
' *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2659 <span class=
"cp">{
</span><span class=
"nf">cycle
</span> <span class=
"na">name
</span><span class=
"o">=
</span><span class=
"na">fooCycle
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
'baz
' *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2661 <span class=
"cp">{
</span><span class=
"nf">cycle
</span> <span class=
"na">name
</span><span class=
"o">=
</span><span class=
"na">fooCycle
</span> <span class=
"na">advance
</span><span class=
"o">=
</span><span class=
"kc">false
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
'baz
' again *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2663 <span class=
"cp">{
</span><span class=
"nf">cycle
</span> <span class=
"na">name
</span><span class=
"o">=
</span><span class=
"na">fooCycle
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
'bar
' *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2665 <div class=
"admonition info">
2666 <p class=
"admonition-title">The values attribute only has to be present for the first call. If
<code>cycle
</code> is used in a loop, the presence of the same values in consecutive calls has no effect. Only once the values change, the cycle is reset.
</p>
2672 <th>Description
</th>
2677 <td><code>advance
</code></td>
2678 <td>if
<code>true
</code>, the current cycle value is advanced to the next value;
<code>true
</code> by default
</td>
2681 <td><code>assign
</code></td>
2682 <td>optional name of the template variable the current cycle value is assigned to; if used,
<code>print
</code> is set to
<code>false
</code></td>
2685 <td><code>delimiter
</code></td>
2686 <td>delimiter between the different cycle values;
<code>,
</code> by default
</td>
2689 <td><code>name
</code></td>
2690 <td>name of the cycle, relevant if multiple cycles are used simultaneously
</td>
2693 <td><code>print
</code></td>
2694 <td>if
<code>true
</code>, the current cycle value is printed,
<code>false
</code> by default
</td>
2697 <td><code>reset
</code></td>
2698 <td>if
<code>true
</code>, the current cycle value is set to the first value,
<code>false
</code> by default
</td>
2701 <td><code>values
</code></td>
2702 <td>string containing the different cycles values, also see
<code>delimiter
</code></td>
2706 <h2 id=
"date"><code>date
</code><a class=
"headerlink" href=
"#date" title=
"Permanent link">#
</a></h2>
2707 <p><code>date
</code> generated a formatted date using
<code>wcf\util\DateUtil::format()
</code> with
<code>DateUtil::DATE_FORMAT
</code> internally.
</p>
2708 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nv">$timestamp
</span><span class=
"o">|
</span><span class=
"na">date
</span><span class=
"cp">}
</span><span class=
"x"></span>
2710 <h2 id=
"31-dateinterval"><span class=
"label label-info">3.1+
</span> <code>dateInterval
</code><a class=
"headerlink" href=
"#31-dateinterval" title=
"Permanent link">#
</a></h2>
2711 <p><code>dateInterval
</code> calculates the difference between two unix timestamps and generated a textual date interval.
</p>
2712 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">dateInterval
</span> <span class=
"na">start
</span><span class=
"o">=
</span><span class=
"nv">$startTimestamp
</span> <span class=
"na">end
</span><span class=
"o">=
</span><span class=
"nv">$endTimestamp
</span> <span class=
"na">full
</span><span class=
"o">=
</span><span class=
"kc">true
</span> <span class=
"na">format
</span><span class=
"o">=
</span><span class=
"s1">'sentence
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2718 <th>Description
</th>
2723 <td><code>end
</code></td>
2724 <td>end of the time interval; current timestamp by default (though either
<code>start
</code> or
<code>end
</code> has to be set)
</td>
2727 <td><code>format
</code></td>
2728 <td>output format, either
<code>default
</code>,
<code>sentence
</code>, or
<code>plain
</code>; defaults to
<code>default
</code>, see
<code>wcf\util\DateUtil::FORMAT_*
</code> constants
</td>
2731 <td><code>full
</code></td>
2732 <td>if
<code>true
</code>, full difference in minutes is shown; if
<code>false
</code>, only the longest time interval is shown;
<code>false
</code> by default
</td>
2735 <td><code>start
</code></td>
2736 <td>start of the time interval; current timestamp by default (though either
<code>start
</code> or
<code>end
</code> has to be set)
</td>
2740 <h2 id=
"encodejs"><code>encodeJS
</code><a class=
"headerlink" href=
"#encodejs" title=
"Permanent link">#
</a></h2>
2741 <p><code>encodeJS
</code> encodes a string to be used as a single-quoted string in JavaScript by replacing
<code>\\
</code> with
<code>\\\\
</code>,
<code>'
</code> with
<code>\'
</code>, linebreaks with
<code>\n
</code>, and
<code>/
</code> with
<code>\/
</code>.
</p>
2742 <div class=
"highlight"><pre><span></span><code><span class=
"x"><script
></span>
2743 <span class=
"x"> var foo =
'</span><span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$foo
</span><span class=
"o">|
</span><span class=
"na">encodeJS
</span><span class=
"cp">}
</span><span class=
"x">';
</span>
2744 <span class=
"x"></script
></span>
2746 <h2 id=
"encodejson"><code>encodeJSON
</code><a class=
"headerlink" href=
"#encodejson" title=
"Permanent link">#
</a></h2>
2747 <p><code>encodeJSON
</code> encodes a JSON string to be used as a single-quoted string in JavaScript by replacing
<code>\\
</code> with
<code>\\\\
</code>,
<code>'
</code> with
<code>&#
39;
</code>, linebreaks with
<code>\n
</code>, and
<code>/
</code> with
<code>\/
</code>.
2748 Additionally,
<code>htmlspecialchars
</code> is applied to the string.
</p>
2749 <div class=
"highlight"><pre><span></span><code><span class=
"x">'</span><span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$foo
</span><span class=
"o">|
</span><span class=
"na">encodeJSON
</span><span class=
"cp">}
</span><span class=
"x">'</span>
2751 <h2 id=
"escapecdata"><code>escapeCDATA
</code><a class=
"headerlink" href=
"#escapecdata" title=
"Permanent link">#
</a></h2>
2752 <p><code>escapeCDATA
</code> encodes a string to be used in a
<code>CDATA
</code> element by replacing
<code>]]
></code> with
<code>]]]]
><![CDATA[
></code>.
</p>
2753 <div class=
"highlight"><pre><span></span><code><span class=
"x"><![CDATA[
</span><span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$foo
</span><span class=
"o">|
</span><span class=
"na">encodeCDATA
</span><span class=
"cp">}
</span><span class=
"x">]]
></span>
2755 <h2 id=
"event"><code>event
</code><a class=
"headerlink" href=
"#event" title=
"Permanent link">#
</a></h2>
2756 <p><code>event
</code> provides extension points in templates that
<a href=
"../../package/pip/template-listener/">template listeners
</a> can use.
</p>
2757 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">event
</span> <span class=
"na">name
</span><span class=
"o">=
</span><span class=
"s1">'foo
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2759 <h2 id=
"fetch"><code>fetch
</code><a class=
"headerlink" href=
"#fetch" title=
"Permanent link">#
</a></h2>
2760 <p><code>fetch
</code> fetches the contents of a file using
<code>file_get_contents
</code>.
</p>
2761 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">fetch
</span> <span class=
"na">file
</span><span class=
"o">=
</span><span class=
"s1">'foo.html
'</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints the contents of `foo.html` *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2763 <span class=
"cp">{
</span><span class=
"nf">fetch
</span> <span class=
"na">file
</span><span class=
"o">=
</span><span class=
"s1">'bar.html
'</span> <span class=
"na">assign
</span><span class=
"o">=
</span><span class=
"na">bar
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* assigns the contents of `foo.html` to `$bar`; does not print the contents *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2765 <h2 id=
"filesizebinary"><code>filesizeBinary
</code><a class=
"headerlink" href=
"#filesizebinary" title=
"Permanent link">#
</a></h2>
2766 <p><code>filesizeBinary
</code> formats the filesize using binary filesize (in bytes).
</p>
2767 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nv">$filesize
</span><span class=
"o">|
</span><span class=
"na">filesizeBinary
</span><span class=
"cp">}
</span><span class=
"x"></span>
2769 <h2 id=
"filesize"><code>filesize
</code><a class=
"headerlink" href=
"#filesize" title=
"Permanent link">#
</a></h2>
2770 <p><code>filesize
</code> formats the filesize using filesize (in bytes).
</p>
2771 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nv">$filesize
</span><span class=
"o">|
</span><span class=
"na">filesize
</span><span class=
"cp">}
</span><span class=
"x"></span>
2773 <h2 id=
"hascontent"><code>hascontent
</code><a class=
"headerlink" href=
"#hascontent" title=
"Permanent link">#
</a></h2>
2774 <p>In many cases, conditional statements can be used to determine if a certain section of a template is shown:
</p>
2775 <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>
2776 <span class=
"x"> only shown if $foo is bar
</span>
2777 <span class=
"cp">{
</span><span class=
"nf">/if
</span><span class=
"cp">}
</span><span class=
"x"></span>
2779 <p>In some situations, however, such conditional statements are not sufficient.
2780 One prominent example is a template event:
</p>
2781 <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>
2782 <span class=
"x"> <ul
></span>
2783 <span class=
"x"> </span><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>
2784 <span class=
"x"> <li
>Bar
</li
></span>
2785 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">/if
</span><span class=
"cp">}
</span><span class=
"x"></span>
2787 <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">'listItems
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2788 <span class=
"x"> </li
></span>
2789 <span class=
"cp">{
</span><span class=
"nf">/if
</span><span class=
"cp">}
</span><span class=
"x"></span>
2791 <p>In this example, if
<code>$foo !== 'bar'
</code>, the list will not be shown, regardless of the additional template code provided by template listeners.
2792 In such a situation,
<code>hascontent
</code> has to be used:
</p>
2793 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2794 <span class=
"x"> <ul
></span>
2795 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">content
</span><span class=
"cp">}
</span><span class=
"x"></span>
2796 <span class=
"x"> </span><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>
2797 <span class=
"x"> <li
>Bar
</li
></span>
2798 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">/if
</span><span class=
"cp">}
</span><span class=
"x"></span>
2800 <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">'listItems
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2801 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">/content
</span><span class=
"cp">}
</span><span class=
"x"></span>
2802 <span class=
"x"> </ul
></span>
2803 <span class=
"cp">{
</span><span class=
"nf">/hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2805 <p>If the part of the template wrapped in the
<code>content
</code> tags has any (trimmed) content, the part of the template wrapped by
<code>hascontent
</code> tags is shown (including the part wrapped by the
<code>content
</code> tags), otherwise nothing is shown.
2806 Thus, this construct avoids an empty list compared to the
<code>if
</code> solution above.
</p>
2807 <p>Like
<code>foreach
</code>,
<code>hascontent
</code> also supports an
<code>else
</code> part:
</p>
2808 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2809 <span class=
"x"> <ul
></span>
2810 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">content
</span><span class=
"cp">}
</span><span class=
"x"></span>
2811 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* … *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2812 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">/content
</span><span class=
"cp">}
</span><span class=
"x"></span>
2813 <span class=
"x"> </ul
></span>
2814 <span class=
"cp">{
</span><span class=
"nf">hascontentelse
</span><span class=
"cp">}
</span><span class=
"x"></span>
2815 <span class=
"x"> no list
</span>
2816 <span class=
"cp">{
</span><span class=
"nf">/hascontent
</span><span class=
"cp">}
</span><span class=
"x"></span>
2818 <h2 id=
"htmlcheckboxes"><code>htmlCheckboxes
</code><a class=
"headerlink" href=
"#htmlcheckboxes" title=
"Permanent link">#
</a></h2>
2819 <p><code>htmlCheckboxes
</code> generates a list of HTML checkboxes.
</p>
2820 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">htmlCheckboxes
</span> <span class=
"na">name
</span><span class=
"o">=
</span><span class=
"na">foo
</span> <span class=
"na">options
</span><span class=
"o">=
</span><span class=
"nv">$fooOptions
</span> <span class=
"na">selected
</span><span class=
"o">=
</span><span class=
"nv">$currentFoo
</span><span class=
"cp">}
</span><span class=
"x"></span>
2822 <span class=
"cp">{
</span><span class=
"nf">htmlCheckboxes
</span> <span class=
"na">name
</span><span class=
"o">=
</span><span class=
"na">bar
</span> <span class=
"na">output
</span><span class=
"o">=
</span><span class=
"nv">$barLabels
</span> <span class=
"na">values
</span><span class=
"o">=
</span><span class=
"nv">$barValues
</span> <span class=
"na">selected
</span><span class=
"o">=
</span><span class=
"nv">$currentBar
</span><span class=
"cp">}
</span><span class=
"x"></span>
2828 <th>Description
</th>
2833 <td><span class=
"label label-info">5.2+
</span> <code>disabled
</code></td>
2834 <td>if
<code>true
</code>, all checkboxes are disabled
</td>
2837 <td><code>disableEncoding
</code></td>
2838 <td>if
<code>true
</code>, the values are not passed through
<code>wcf\util\StringUtil::encodeHTML()
</code>;
<code>false
</code> by default
</td>
2841 <td><code>name
</code></td>
2842 <td><code>name
</code> attribute of the
<code>input
</code> checkbox element
</td>
2845 <td><code>output
</code></td>
2846 <td>array used as keys and values for
<code>options
</code> if present; not present by default
</td>
2849 <td><code>options
</code></td>
2850 <td>array selectable options with the key used as
<code>value
</code> attribute and the value as the checkbox label
</td>
2853 <td><code>selected
</code></td>
2854 <td>current selected value(s)
</td>
2857 <td><code>separator
</code></td>
2858 <td>separator between the different checkboxes in the generated output; empty string by default
</td>
2861 <td><code>values
</code></td>
2862 <td>array with values used in combination with
<code>output
</code>, where
<code>output
</code> is only used as keys for
<code>options
</code></td>
2866 <h2 id=
"htmloptions"><code>htmlOptions
</code><a class=
"headerlink" href=
"#htmloptions" title=
"Permanent link">#
</a></h2>
2867 <p><code>htmlOptions
</code> generates an
<code>select
</code> HTML element.
</p>
2868 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">htmlOptions
</span> <span class=
"na">name
</span><span class=
"o">=
</span><span class=
"s1">'foo
'</span> <span class=
"na">options
</span><span class=
"o">=
</span><span class=
"nv">$options
</span> <span class=
"na">selected
</span><span class=
"o">=
</span><span class=
"nv">$selected
</span><span class=
"cp">}
</span><span class=
"x"></span>
2870 <span class=
"x"><select name=
"bar
"></span>
2871 <span class=
"x"> <option value=
""</span><span class=
"cp">{
</span><span class=
"nf">if
</span> <span class=
"o">!
</span><span class=
"nv">$selected
</span><span class=
"cp">}
</span><span class=
"x"> selected
</span><span class=
"cp">{
</span><span class=
"nf">/if
</span><span class=
"cp">}
</span><span class=
"x">></span><span class=
"cp">{
</span><span class=
"nf">lang
</span><span class=
"cp">}
</span><span class=
"x">foo.bar.default
</span><span class=
"cp">{
</span><span class=
"nf">/lang
</span><span class=
"cp">}
</span><span class=
"x"></option
></span>
2872 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"nf">htmlOptions
</span> <span class=
"na">options
</span><span class=
"o">=
</span><span class=
"nv">$options
</span> <span class=
"na">selected
</span><span class=
"o">=
</span><span class=
"nv">$selected
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* no `name` attribute *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2873 <span class=
"x"></select
></span>
2879 <th>Description
</th>
2884 <td><code>disableEncoding
</code></td>
2885 <td>if
<code>true
</code>, the values are not passed through
<code>wcf\util\StringUtil::encodeHTML()
</code>;
<code>false
</code> by default
</td>
2888 <td><code>object
</code></td>
2889 <td>optional instance of
<code>wcf\data\DatabaseObjectList
</code> that provides the selectable options (overwrites
<code>options
</code> attribute internally)
</td>
2892 <td><code>name
</code></td>
2893 <td><code>name
</code> attribute of the
<code>select
</code> element; if not present, only the
<strong>contents
</strong> of the
<code>select
</code> element are printed
</td>
2896 <td><code>output
</code></td>
2897 <td>array used as keys and values for
<code>options
</code> if present; not present by default
</td>
2900 <td><code>values
</code></td>
2901 <td>array with values used in combination with
<code>output
</code>, where
<code>output
</code> is only used as keys for
<code>options
</code></td>
2904 <td><code>options
</code></td>
2905 <td>array selectable options with the key used as
<code>value
</code> attribute and the value as the option label; if a value is an array, an
<code>optgroup
</code> is generated with the array key as the
<code>optgroup
</code> label
</td>
2908 <td><code>selected
</code></td>
2909 <td>current selected value(s)
</td>
2913 <p>All additional attributes are added as attributes of the
<code>select
</code> HTML element.
</p>
2914 <h2 id=
"implode"><code>implode
</code><a class=
"headerlink" href=
"#implode" title=
"Permanent link">#
</a></h2>
2915 <p><code>implodes
</code> transforms an array into a string and prints it.
</p>
2916 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">implode
</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">item
</span> <span class=
"na">glue
</span><span class=
"o">=
</span><span class=
"s2">";
"</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=
"nf">/implode
</span><span class=
"cp">}
</span><span class=
"x"></span>
2922 <th>Description
</th>
2927 <td><code>from
</code></td>
2928 <td>array with the imploded values
</td>
2931 <td><code>glue
</code></td>
2932 <td>separator between the different array values;
<code>', '
</code> by default
</td>
2935 <td><code>item
</code></td>
2936 <td>template variable name where the current array value is stored during the iteration
</td>
2939 <td><code>key
</code></td>
2940 <td>optional template variable name where the current array key is stored during the iteration
</td>
2944 <h2 id=
"52-ipsearch"><span class=
"label label-info">5.2+
</span> <code>ipSearch
</code><a class=
"headerlink" href=
"#52-ipsearch" title=
"Permanent link">#
</a></h2>
2945 <p><code>ipSearch
</code> generates a link to search for an IP address.
</p>
2946 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"s2">"127.0.0.1"</span><span class=
"o">|
</span><span class=
"na">ipSearch
</span><span class=
"cp">}
</span><span class=
"x"></span>
2948 <h2 id=
"30-js"><span class=
"label label-info">3.0+
</span> <code>js
</code><a class=
"headerlink" href=
"#30-js" title=
"Permanent link">#
</a></h2>
2949 <p><code>js
</code> generates script tags based on whether
<code>ENABLE_DEBUG_MODE
</code> and
<code>VISITOR_USE_TINY_BUILD
</code> are enabled.
</p>
2950 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">js
</span> <span class=
"na">application
</span><span class=
"o">=
</span><span class=
"s1">'wbb
'</span> <span class=
"na">file
</span><span class=
"o">=
</span><span class=
"s1">'WBB
'</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* generates
'http://example.com/js/WBB.js
' *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2952 <span class=
"cp">{
</span><span class=
"nf">js
</span> <span class=
"na">application
</span><span class=
"o">=
</span><span class=
"s1">'wcf
'</span> <span class=
"na">file
</span><span class=
"o">=
</span><span class=
"s1">'WCF.Like
'</span> <span class=
"na">bundle
</span><span class=
"o">=
</span><span class=
"s1">'WCF.Combined
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2953 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* generates
'http://example.com/wcf/js/WCF.Like.js
' if ENABLE_DEBUG_MODE=
1 *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2954 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* generates
'http://example.com/wcf/js/WCF.Combined.min.js
' if ENABLE_DEBUG_MODE=
0 *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2956 <span class=
"cp">{
</span><span class=
"nf">js
</span> <span class=
"na">application
</span><span class=
"o">=
</span><span class=
"s1">'wcf
'</span> <span class=
"na">lib
</span><span class=
"o">=
</span><span class=
"s1">'jquery
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2957 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* generates
'http://example.com/wcf/js/
3rdParty/jquery.js
' *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2959 <span class=
"cp">{
</span><span class=
"nf">js
</span> <span class=
"na">application
</span><span class=
"o">=
</span><span class=
"s1">'wcf
'</span> <span class=
"na">lib
</span><span class=
"o">=
</span><span class=
"s1">'jquery-ui
'</span> <span class=
"na">file
</span><span class=
"o">=
</span><span class=
"s1">'awesomeWidget
'</span><span class=
"cp">}
</span><span class=
"x"></span>
2960 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* generates
'http://example.com/wcf/js/
3rdParty/jquery-ui/awesomeWidget.js
' *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2962 <span class=
"cp">{
</span><span class=
"nf">js
</span> <span class=
"na">application
</span><span class=
"o">=
</span><span class=
"s1">'wcf
'</span> <span class=
"na">file
</span><span class=
"o">=
</span><span class=
"s1">'WCF.Like
'</span> <span class=
"na">bundle
</span><span class=
"o">=
</span><span class=
"s1">'WCF.Combined
'</span> <span class=
"na">hasTiny
</span><span class=
"o">=
</span><span class=
"kc">true
</span><span class=
"cp">}
</span><span class=
"x"></span>
2963 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* generates
'http://example.com/wcf/js/WCF.Like.js
' if ENABLE_DEBUG_MODE=
1 *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2964 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* generates
'http://example.com/wcf/js/WCF.Combined.min.js
' (ENABLE_DEBUG_MODE=
0 *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2965 <span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* generates
'http://example.com/wcf/js/WCF.Combined.tiny.min.js
' if ENABLE_DEBUG_MODE=
0 and VISITOR_USE_TINY_BUILD=
1 *
</span><span class=
"cp">}
</span><span class=
"x"></span>
2967 <h2 id=
"53-jslang"><span class=
"label label-info">5.3+
</span> <code>jslang
</code><a class=
"headerlink" href=
"#53-jslang" title=
"Permanent link">#
</a></h2>
2968 <p><code>jslang
</code> works like
<a href=
"#lang"><code>lang
</code></a> with the difference that the resulting string is automatically passed through
<a href=
"#encodejs"><code>encodeJS
</code></a>.
</p>
2969 <div class=
"highlight"><pre><span></span><code><span class=
"x">require([
'Language
', /* … */], function(Language, /* … */)
</span><span class=
"cp">{
</span>
2970 <span class=
"na">Language
</span><span class=
"o">.
</span><span class=
"na">addObject
</span><span class=
"o">(
</span><span class=
"cp">{
</span>
2971 <span class=
"s1">'app.foo.bar
'</span><span class=
"o">:
</span> <span class=
"s1">'{jslang}app.foo.bar{/jslang}
'</span><span class=
"o">,
</span>
2972 <span class=
"cp">}
</span><span class=
"o">);
</span>
2974 <span class=
"o">//
</span> <span class=
"err">…
</span>
2975 <span class=
"cp">}
</span><span class=
"x">);
</span>
2977 <h2 id=
"lang"><code>lang
</code><a class=
"headerlink" href=
"#lang" title=
"Permanent link">#
</a></h2>
2978 <p><code>lang
</code> replaces a language items with its value.
</p>
2979 <div class=
"highlight"><pre><span></span><code><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"></span>
2981 <span class=
"cp">{
</span><span class=
"nf">lang
</span> <span class=
"na">__literal
</span><span class=
"o">=
</span><span class=
"kc">true
</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"></span>
2983 <span class=
"cp">{
</span><span class=
"nf">lang
</span> <span class=
"na">foo
</span><span class=
"o">=
</span><span class=
"s1">'baz
'</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"></span>
2985 <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=
"nv">$action
</span><span class=
"cp">}{
</span><span class=
"nf">/lang
</span><span class=
"cp">}
</span><span class=
"x"></span>
2991 <th>Description
</th>
2996 <td><code>__encode
</code></td>
2997 <td>if
<code>true
</code>, the output will be passed through
<code>StringUtil::encodeHTML()
</code></td>
3000 <td><code>__literal
</code></td>
3001 <td>if
<code>true
</code>, template variables will not resolved but printed as they are in the language item;
<code>false
</code> by default
</td>
3004 <td><code>__optional
</code></td>
3005 <td>if
<code>true
</code> and the language item does not exist, an empty string is printed;
<code>false
</code> by default
</td>
3009 <p>All additional attributes are available when parsing the language item.
</p>
3010 <h2 id=
"language"><code>language
</code><a class=
"headerlink" href=
"#language" title=
"Permanent link">#
</a></h2>
3011 <p><code>language
</code> replaces a language items with its value.
3012 If the template variable
<code>__language
</code> exists, this language object will be used instead of
<code>WCF::getLanguage()
</code>.
3013 This modifier is useful when assigning the value directly to a variable.
</p>
3014 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nv">$languageItem
</span><span class=
"o">|
</span><span class=
"na">language
</span><span class=
"cp">}
</span><span class=
"x"></span>
3016 <span class=
"cp">{
</span><span class=
"nf">assign
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">foo
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"nv">$languageItem
</span><span class=
"o">|
</span><span class=
"na">language
</span><span class=
"cp">}
</span><span class=
"x"></span>
3018 <h2 id=
"link"><code>link
</code><a class=
"headerlink" href=
"#link" title=
"Permanent link">#
</a></h2>
3019 <p><code>link
</code> generates internal links using
<code>LinkHandler
</code>.
</p>
3020 <div class=
"highlight"><pre><span></span><code><span class=
"x"><a href=
"</span><span class=
"cp">{
</span><span class=
"nf">link
</span> <span class=
"na">controller
</span><span class=
"o">=
</span><span class=
"s1">'FooList
'</span> <span class=
"na">application
</span><span class=
"o">=
</span><span class=
"s1">'bar
'</span><span class=
"cp">}
</span><span class=
"x">param1=
2&param2=A
</span><span class=
"cp">{
</span><span class=
"nf">/link
</span><span class=
"cp">}
</span><span class=
"x">">Foo
</a
></span>
3026 <th>Description
</th>
3031 <td><code>application
</code></td>
3032 <td>abbreviation of the application the controller belongs to;
<code>wcf
</code> by default
</td>
3035 <td><code>controller
</code></td>
3036 <td>name of the controller; if not present, the landing page is linked in the frontend and the index page in the ACP
</td>
3039 <td><code>encode
</code></td>
3040 <td>if
<code>true
</code>, the generated link is passed through
<code>wcf\util\StringUtil::encodeHTML()
</code>;
<code>true
</code> by default
</td>
3043 <td><code>isEmail
</code></td>
3044 <td>sets
<code>encode=false
</code> and forces links to link to the frontend
</td>
3048 <p>Additional attributes are passed to
<code>LinkHandler::getLink()
</code>.
</p>
3049 <h2 id=
"newlinetobreak"><code>newlineToBreak
</code><a class=
"headerlink" href=
"#newlinetobreak" title=
"Permanent link">#
</a></h2>
3050 <p><code>newlineToBreak
</code> transforms newlines into HTML
<code><br
></code> elements after encoding the content via
<code>wcf\util\StringUtil::encodeHTML()
</code>.
</p>
3051 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nv">$foo
</span><span class=
"o">|
</span><span class=
"na">newlineToBreak
</span><span class=
"cp">}
</span><span class=
"x"></span>
3053 <h2 id=
"30-page"><span class=
"label label-info">3.0+
</span> <code>page
</code><a class=
"headerlink" href=
"#30-page" title=
"Permanent link">#
</a></h2>
3054 <p><code>page
</code> generates an internal link to a CMS page.
</p>
3055 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">page
</span><span class=
"cp">}
</span><span class=
"x">com.woltlab.wcf.CookiePolicy
</span><span class=
"cp">{
</span><span class=
"nf">/page
</span><span class=
"cp">}
</span><span class=
"x"></span>
3057 <span class=
"cp">{
</span><span class=
"nf">page
</span> <span class=
"na">pageID
</span><span class=
"o">=
</span><span class=
"m">1</span><span class=
"cp">}{
</span><span class=
"nf">/page
</span><span class=
"cp">}
</span><span class=
"x"></span>
3059 <span class=
"cp">{
</span><span class=
"nf">page
</span> <span class=
"na">language
</span><span class=
"o">=
</span><span class=
"s1">'de
'</span><span class=
"cp">}
</span><span class=
"x">com.woltlab.wcf.CookiePolicy
</span><span class=
"cp">{
</span><span class=
"nf">/page
</span><span class=
"cp">}
</span><span class=
"x"></span>
3061 <span class=
"cp">{
</span><span class=
"nf">page
</span> <span class=
"na">languageID
</span><span class=
"o">=
</span><span class=
"m">2</span><span class=
"cp">}
</span><span class=
"x">com.woltlab.wcf.CookiePolicy
</span><span class=
"cp">{
</span><span class=
"nf">/page
</span><span class=
"cp">}
</span><span class=
"x"></span>
3067 <th>Description
</th>
3072 <td><code>pageID
</code></td>
3073 <td>unique id of the page (cannot be used together with a page identifier as value)
</td>
3076 <td><code>languageID
</code></td>
3077 <td>id of the page language (cannot be used together with
<code>language
</code>)
</td>
3080 <td><code>language
</code></td>
3081 <td>language code of the page language (cannot be used together with
<code>languageID
</code>)
</td>
3085 <h2 id=
"pages"><code>pages
</code><a class=
"headerlink" href=
"#pages" title=
"Permanent link">#
</a></h2>
3086 <p><code>pages
</code> generates a pagination.
</p>
3087 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">pages
</span> <span class=
"na">controller
</span><span class=
"o">=
</span><span class=
"s1">'FooList
'</span> <span class=
"na">link
</span><span class=
"o">=
</span><span class=
"s2">"pageNo=%d
"</span> <span class=
"na">print
</span><span class=
"o">=
</span><span class=
"kc">true
</span> <span class=
"na">assign
</span><span class=
"o">=
</span><span class=
"na">pagesLinks
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints pagination *
</span><span class=
"cp">}
</span><span class=
"x"></span>
3089 <span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$pagesLinks
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints same pagination again *
</span><span class=
"cp">}
</span><span class=
"x"></span>
3095 <th>Description
</th>
3100 <td><code>assign
</code></td>
3101 <td>optional name of the template variable the pagination is assigned to
</td>
3104 <td><code>controller
</code></td>
3105 <td>controller name of the generated links
</td>
3108 <td><code>link
</code></td>
3109 <td>additional link parameter where
<code>%d
</code> will be replaced with the relevant page number
</td>
3112 <td><code>pages
</code></td>
3113 <td>maximum number of of pages; by default, the template variable
<code>$pages
</code> is used
</td>
3116 <td><code>print
</code></td>
3117 <td>if
<code>false
</code> and
<code>assign=true
</code>, the pagination is not printed
</td>
3120 <td><code>application
</code>,
<code>id
</code>,
<code>object
</code>,
<code>title
</code></td>
3121 <td>additional parameters passed to
<code>LinkHandler::getLink()
</code> to generate page links
</td>
3125 <h2 id=
"plaintime"><code>plainTime
</code><a class=
"headerlink" href=
"#plaintime" title=
"Permanent link">#
</a></h2>
3126 <p><code>plainTime
</code> formats a timestamp to include year, month, day, hour, and minutes.
3127 The exact formatting depends on the current language (via the language items
<code>wcf.date.dateTimeFormat
</code>,
<code>wcf.date.dateFormat
</code>, and
<code>wcf.date.timeFormat
</code>).
</p>
3128 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nv">$timestamp
</span><span class=
"o">|
</span><span class=
"na">plainTime
</span><span class=
"cp">}
</span><span class=
"x"></span>
3130 <h2 id=
"53-plural"><span class=
"label label-info">5.3+
</span> <code>plural
</code><a class=
"headerlink" href=
"#53-plural" title=
"Permanent link">#
</a></h2>
3131 <p><code>plural
</code> allows to easily select the correct plural form of a phrase based on a given
<code>value
</code>.
3132 The pluralization logic follows the
<a href=
"https://unicode-org.github.io/cldr-staging/charts/37/supplemental/language_plural_rules.md">Unicode Language Plural Rules
</a> for cardinal numbers.
</p>
3133 <p>The
<code>#
</code> placeholder within the resulting phrase is replaced by the
<code>value
</code>.
3134 It is automatically formatted using
<code>StringUtil::formatNumeric
</code>.
</p>
3136 <p>Note the use of
<code>1</code> if the number (
<code>#
</code>) is not used within the phrase and the use of
<code>one
</code> otherwise.
3137 They are equivalent for English, but following this rule generalizes better to other languages, helping the translator.
3138 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">assign
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">numberOfWorlds
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"m">2</span><span class=
"cp">}
</span><span class=
"x"></span>
3139 <span class=
"x"><h1
>Hello
</span><span class=
"cp">{
</span><span class=
"nf">plural
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"nv">$numberOfWorlds
</span> <span class=
"m">1</span><span class=
"o">=
</span><span class=
"s1">'World
'</span> <span class=
"na">other
</span><span class=
"o">=
</span><span class=
"s1">'Worlds
'</span><span class=
"cp">}
</span><span class=
"x">!
</h1
></span>
3140 <span class=
"x"><p
>There
</span><span class=
"cp">{
</span><span class=
"nf">plural
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"nv">$numberOfWorlds
</span> <span class=
"m">1</span><span class=
"o">=
</span><span class=
"s1">'is one world
'</span> <span class=
"na">other
</span><span class=
"o">=
</span><span class=
"s1">'are # worlds
'</span><span class=
"cp">}
</span><span class=
"x">!
</p
></span>
3141 <span class=
"x"><p
>There
</span><span class=
"cp">{
</span><span class=
"nf">plural
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"nv">$numberOfWorlds
</span> <span class=
"na">one
</span><span class=
"o">=
</span><span class=
"s1">'is # world
'</span> <span class=
"na">other
</span><span class=
"o">=
</span><span class=
"s1">'are # worlds
'</span><span class=
"cp">}
</span><span class=
"x">!
</p
></span>
3142 </code></pre></div></p>
3144 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">assign
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">numberOfWorlds
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"m">2</span><span class=
"cp">}
</span><span class=
"x"></span>
3145 <span class=
"x"><h1
>Hallo
</span><span class=
"cp">{
</span><span class=
"nf">plural
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"nv">$numberOfWorlds
</span> <span class=
"m">1</span><span class=
"o">=
</span><span class=
"s1">'Welt
'</span> <span class=
"na">other
</span><span class=
"o">=
</span><span class=
"s1">'Welten
'</span><span class=
"cp">}
</span><span class=
"x">!
</h1
></span>
3146 <span class=
"x"><p
>Es gibt
</span><span class=
"cp">{
</span><span class=
"nf">plural
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"nv">$numberOfWorlds
</span> <span class=
"m">1</span><span class=
"o">=
</span><span class=
"s1">'eine Welt
'</span> <span class=
"na">other
</span><span class=
"o">=
</span><span class=
"s1">'# Welten
'</span><span class=
"cp">}
</span><span class=
"x">!
</p
></span>
3147 <span class=
"x"><p
>Es gibt
</span><span class=
"cp">{
</span><span class=
"nf">plural
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"nv">$numberOfWorlds
</span> <span class=
"na">one
</span><span class=
"o">=
</span><span class=
"s1">'# Welt
'</span> <span class=
"na">other
</span><span class=
"o">=
</span><span class=
"s1">'# Welten
'</span><span class=
"cp">}
</span><span class=
"x">!
</p
></span>
3148 </code></pre></div></p>
3150 <p>Note the additional use of
<code>few
</code> which is not required in English or German.
3151 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">assign
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">numberOfWorlds
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"m">2</span><span class=
"cp">}
</span><span class=
"x"></span>
3152 <span class=
"x"><h1
>Salut
</span><span class=
"cp">{
</span><span class=
"nf">plural
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"nv">$numberOfWorlds
</span> <span class=
"m">1</span><span class=
"o">=
</span><span class=
"s1">'lume
'</span> <span class=
"na">other
</span><span class=
"o">=
</span><span class=
"s1">'lumi
'</span><span class=
"cp">}
</span><span class=
"x">!
</h1
></span>
3153 <span class=
"x"><p
>Există
</span><span class=
"cp">{
</span><span class=
"nf">plural
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"nv">$numberOfWorlds
</span> <span class=
"m">1</span><span class=
"o">=
</span><span class=
"s1">'o lume
'</span> <span class=
"na">few
</span><span class=
"o">=
</span><span class=
"s1">'# lumi
'</span> <span class=
"na">other
</span><span class=
"o">=
</span><span class=
"s1">'# de lumi
'</span><span class=
"cp">}
</span><span class=
"x">!
</p
></span>
3154 <span class=
"x"><p
>Există
</span><span class=
"cp">{
</span><span class=
"nf">plural
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"nv">$numberOfWorlds
</span> <span class=
"na">one
</span><span class=
"o">=
</span><span class=
"s1">'# lume
'</span> <span class=
"na">few
</span><span class=
"o">=
</span><span class=
"s1">'# lumi
'</span> <span class=
"na">other
</span><span class=
"o">=
</span><span class=
"s1">'# de lumi
'</span><span class=
"cp">}
</span><span class=
"x">!
</p
></span>
3155 </code></pre></div></p>
3157 <p>Note the difference between
<code>1</code> (exactly
<code>1</code>) and
<code>one
</code> (ending in
<code>1</code>, except ending in
<code>11</code>).
3158 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">assign
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">numberOfWorlds
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"m">2</span><span class=
"cp">}
</span><span class=
"x"></span>
3159 <span class=
"x"><h1
>Привет
</span><span class=
"cp">{
</span><span class=
"nf">plural
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"nv">$numberOfWorld
</span> <span class=
"m">1</span><span class=
"o">=
</span><span class=
"s1">'мир
'</span> <span class=
"na">other
</span><span class=
"o">=
</span><span class=
"s1">'миры
'</span><span class=
"cp">}
</span><span class=
"x">!
</h1
></span>
3160 <span class=
"x"><p
>Есть
</span><span class=
"cp">{
</span><span class=
"nf">plural
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"nv">$numberOfWorlds
</span> <span class=
"m">1</span><span class=
"o">=
</span><span class=
"s1">'мир
'</span> <span class=
"na">one
</span><span class=
"o">=
</span><span class=
"s1">'# мир
'</span> <span class=
"na">few
</span><span class=
"o">=
</span><span class=
"s1">'# мира
'</span> <span class=
"na">many
</span><span class=
"o">=
</span><span class=
"s1">'# миров
'</span> <span class=
"na">other
</span><span class=
"o">=
</span><span class=
"s1">'# миров
'</span><span class=
"cp">}
</span><span class=
"x">!
</p
></span>
3161 </code></pre></div></p>
3166 <th>Description
</th>
3172 <td>The value that is used to select the proper phrase.
</td>
3176 <td>The phrase that is used when no other selector matches.
</td>
3179 <td>Any Category Name
</td>
3180 <td>The phrase that is used when
<code>value
</code> belongs to the named category. Available categories depend on the language.
</td>
3183 <td>Any Integer
</td>
3184 <td>The phrase that is used when
<code>value
</code> is that exact integer.
</td>
3188 <h2 id=
"prepend"><code>prepend
</code><a class=
"headerlink" href=
"#prepend" title=
"Permanent link">#
</a></h2>
3189 <p>If a string should be prepended to the value of a variable,
<code>prepend
</code> can be used:
</p>
3190 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">assign
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">templateVariable
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"s1">'newValue
'</span><span class=
"cp">}
</span><span class=
"x"></span>
3192 <span class=
"cp">{
</span><span class=
"nv">$templateVariable
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
'newValue *
</span><span class=
"cp">}
</span><span class=
"x"></span>
3194 <span class=
"cp">{
</span><span class=
"nf">prepend
</span> <span class=
"na">var
</span><span class=
"o">=
</span><span class=
"na">templateVariable
</span> <span class=
"na">value
</span><span class=
"o">=
</span><span class=
"s1">'2'</span><span class=
"cp">}
</span><span class=
"x"></span>
3196 <span class=
"cp">{
</span><span class=
"nv">$templateVariable
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* now prints
'2newValue
' *
</span><span class=
"cp">}
</span><span class=
"x"></span>
3198 <p>If the variables does not exist yet,
<code>prepend
</code> creates a new one with the given value.
3199 If
<code>prepend
</code> is used on an array as the variable, the value is prepended to all elements of the array.
</p>
3200 <h2 id=
"shortunit"><code>shortUnit
</code><a class=
"headerlink" href=
"#shortunit" title=
"Permanent link">#
</a></h2>
3201 <p><code>shortUnit
</code> shortens numbers larger than
1000 by using unit suffixes:
</p>
3202 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"m">10000</span><span class=
"o">|
</span><span class=
"na">shortUnit
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
10k *
</span><span class=
"cp">}
</span><span class=
"x"></span>
3203 <span class=
"cp">{
</span><span class=
"m">5400000</span><span class=
"o">|
</span><span class=
"na">shortUnit
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints
5.4M *
</span><span class=
"cp">}
</span><span class=
"x"></span>
3205 <h2 id=
"smallpages"><code>smallpages
</code><a class=
"headerlink" href=
"#smallpages" title=
"Permanent link">#
</a></h2>
3206 <p><code>smallpages
</code> generates a smaller version of
<code>pages
</code> by using adding the
<code>small
</code> CSS class to the generated
<code><nav
></code> element and only showing
7 instead of
9 links.
</p>
3207 <h2 id=
"tablewordwrap"><code>tableWordwrap
</code><a class=
"headerlink" href=
"#tablewordwrap" title=
"Permanent link">#
</a></h2>
3208 <p><code>tableWordwrap
</code> inserts zero width spaces every
30 characters in words longer than
30 characters.
</p>
3209 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nv">$foo
</span><span class=
"o">|
</span><span class=
"na">tableWordwrap
</span><span class=
"cp">}
</span><span class=
"x"></span>
3211 <h2 id=
"time"><code>time
</code><a class=
"headerlink" href=
"#time" title=
"Permanent link">#
</a></h2>
3212 <p><code>time
</code> generates an HTML
<code>time
</code> elements based on a timestamp that shows a relative time or the absolute time if the timestamp more than six days ago.
</p>
3213 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nv">$timestamp
</span><span class=
"o">|
</span><span class=
"na">time
</span><span class=
"cp">}
</span><span class=
"x"> </span><span class=
"cp">{
</span><span class=
"c">* prints a
'<time
>' element *
</span><span class=
"cp">}
</span><span class=
"x"></span>
3215 <h2 id=
"truncate"><code>truncate
</code><a class=
"headerlink" href=
"#truncate" title=
"Permanent link">#
</a></h2>
3216 <p><code>truncate
</code> truncates a long string into a shorter one:
</p>
3217 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nv">$foo
</span><span class=
"o">|
</span><span class=
"na">truncate
</span><span class=
"o">:
</span><span class=
"m">35</span><span class=
"cp">}
</span><span class=
"x"></span>
3219 <span class=
"cp">{
</span><span class=
"nv">$foo
</span><span class=
"o">|
</span><span class=
"na">truncate
</span><span class=
"o">:
</span><span class=
"m">35</span><span class=
"o">:
</span><span class=
"s1">'_
'</span><span class=
"o">:
</span><span class=
"kc">true
</span><span class=
"cp">}
</span><span class=
"x"></span>
3224 <th>Parameter Number
</th>
3225 <th>Description
</th>
3231 <td>truncated string
</td>
3235 <td>truncated length;
<code>80</code> by default
</td>
3239 <td>ellipsis symbol;
<code>wcf\util\StringUtil::HELLIP
</code> by default
</td>
3243 <td>if
<code>true
</code>, words can be broken up in the middle;
<code>false
</code> by default
</td>
3247 <h2 id=
"53-user"><span class=
"label label-info">5.3+
</span> <code>user
</code><a class=
"headerlink" href=
"#53-user" title=
"Permanent link">#
</a></h2>
3248 <p><code>user
</code> generates links to user profiles.
3249 The mandatory
<code>object
</code> parameter requires an instances of
<code>UserProfile
</code>.
3250 The optional
<code>type
</code> parameter is responsible for what the generated link contains:
</p>
3252 <li><code>type='default'
</code> (also applies if no
<code>type
</code> is given) outputs the formatted username relying on the “User Marking” setting of the relevant user group.
3253 Additionally, the user popover card will be shown when hovering over the generated link.
</li>
3254 <li><code>type='plain'
</code> outputs the username without additional formatting.
</li>
3255 <li><code>type='avatar(\d+)'
</code> outputs the user’s avatar in the specified size, i.e.,
<code>avatar48
</code> outputs the avatar with a width and height of
48 pixels.
</li>
3257 <p>The last special attribute is
<code>append
</code> whose contents are appended to the
<code>href
</code> attribute of the generated anchor element.
</p>
3258 <p>All of the other attributes matching
<code>~^[a-z]+([A-z]+)+$~
</code>, except for
<code>href
</code> which may not be added, are added as attributes to the anchor element.
</p>
3260 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">user
</span> <span class=
"na">object
</span><span class=
"o">=
</span><span class=
"nv">$user
</span><span class=
"cp">}
</span><span class=
"x"></span>
3263 <div class=
"highlight"><pre><span></span><code><span class=
"x"><a href=
"</span><span class=
"cp">{
</span><span class=
"nv">$user
</span><span class=
"o">-
></span><span class=
"na">getLink
</span><span class=
"o">()
</span><span class=
"cp">}
</span><span class=
"x">" data-object-id=
"</span><span class=
"cp">{
</span><span class=
"nv">$user
</span><span class=
"o">-
></span><span class=
"na">userID
</span><span class=
"cp">}
</span><span class=
"x">" class=
"userLink
"></span><span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$user
</span><span class=
"o">-
></span><span class=
"na">getFormattedUsername
</span><span class=
"o">()
</span><span class=
"cp">}
</span><span class=
"x"></a
></span>
3266 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">user
</span> <span class=
"na">object
</span><span class=
"o">=
</span><span class=
"nv">$user
</span> <span class=
"na">type
</span><span class=
"o">=
</span><span class=
"s1">'avatar48
'</span> <span class=
"na">foo
</span><span class=
"o">=
</span><span class=
"s1">'bar
'</span><span class=
"cp">}
</span><span class=
"x"></span>
3269 <div class=
"highlight"><pre><span></span><code><span class=
"x"><a href=
"</span><span class=
"cp">{
</span><span class=
"nv">$user
</span><span class=
"o">-
></span><span class=
"na">getLink
</span><span class=
"o">()
</span><span class=
"cp">}
</span><span class=
"x">" foo=
"bar
"></span><span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$object
</span><span class=
"o">-
></span><span class=
"na">getAvatar
</span><span class=
"o">()-
></span><span class=
"na">getImageTag
</span><span class=
"o">(
</span><span class=
"m">48</span><span class=
"o">)
</span><span class=
"cp">}
</span><span class=
"x"></a
></span>
3276 <div class=
"md-source-date">
3279 Last update:
2021-
01-
08
3298 <footer class=
"md-footer">
3300 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
3302 <a href=
"../templates/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
3303 <div class=
"md-footer__button md-icon">
3304 <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>
3306 <div class=
"md-footer__title">
3307 <div class=
"md-ellipsis">
3308 <span class=
"md-footer__direction">
3317 <a href=
"../css/" class=
"md-footer__link md-footer__link--next" rel=
"next">
3318 <div class=
"md-footer__title">
3319 <div class=
"md-ellipsis">
3320 <span class=
"md-footer__direction">
3326 <div class=
"md-footer__button md-icon">
3327 <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>
3333 <div class=
"md-footer-meta md-typeset">
3334 <div class=
"md-footer-meta__inner md-grid">
3335 <div class=
"md-footer-copyright">
3337 <div class=
"md-footer-copyright__highlight">
3338 Copyright ©
2020 WoltLab GmbH
3342 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
3347 <div class=
"md-footer-copyright">
3348 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
3349 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
3356 <div class=
"md-dialog" data-md-component=
"dialog">
3357 <div class=
"md-dialog__inner md-typeset"></div>
3359 <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>
3362 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>