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>Languages - 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=
"#languages" 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
>
619 <li class=
"md-nav__item md-nav__item--active">
621 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
626 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
628 <span class=
"md-nav__icon md-icon"></span>
631 <a href=
"./" class=
"md-nav__link md-nav__link--active">
636 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
642 <label class=
"md-nav__title" for=
"__toc">
643 <span class=
"md-nav__icon md-icon"></span>
646 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
648 <li class=
"md-nav__item">
649 <a href=
"#special-phrases" class=
"md-nav__link">
653 <nav class=
"md-nav" aria-label=
"Special Phrases">
654 <ul class=
"md-nav__list">
656 <li class=
"md-nav__item">
657 <a href=
"#wcfdatedateformat" class=
"md-nav__link">
663 <li class=
"md-nav__item">
664 <a href=
"#wcfdatetimeformat" class=
"md-nav__link">
670 <li class=
"md-nav__item">
671 <a href=
"#wcfdatefirstdayoftheweek" class=
"md-nav__link">
672 wcf.date.firstDayOfTheWeek
677 <li class=
"md-nav__item">
678 <a href=
"#wcfglobalpagedirection-rtl-support" class=
"md-nav__link">
679 wcf.global.pageDirection - RTL support
701 <li class=
"md-nav__item">
702 <a href=
"../templates/" class=
"md-nav__link">
713 <li class=
"md-nav__item">
714 <a href=
"../template-plugins/" class=
"md-nav__link">
725 <li class=
"md-nav__item">
726 <a href=
"../css/" class=
"md-nav__link">
747 <li class=
"md-nav__item md-nav__item--nested">
750 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
752 <label class=
"md-nav__link" for=
"__nav_4">
753 TypeScript and JavaScript API
754 <span class=
"md-nav__icon md-icon"></span>
756 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
757 <label class=
"md-nav__title" for=
"__nav_4">
758 <span class=
"md-nav__icon md-icon"></span>
759 TypeScript and JavaScript API
761 <ul class=
"md-nav__list" data-md-scrollfix
>
767 <li class=
"md-nav__item">
768 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
779 <li class=
"md-nav__item">
780 <a href=
"../../javascript/typescript/" class=
"md-nav__link">
792 <li class=
"md-nav__item md-nav__item--nested">
795 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
797 <label class=
"md-nav__link" for=
"__nav_4_3">
799 <span class=
"md-nav__icon md-icon"></span>
801 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
802 <label class=
"md-nav__title" for=
"__nav_4_3">
803 <span class=
"md-nav__icon md-icon"></span>
806 <ul class=
"md-nav__list" data-md-scrollfix
>
812 <li class=
"md-nav__item">
813 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
824 <li class=
"md-nav__item">
825 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
836 <li class=
"md-nav__item">
837 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
848 <li class=
"md-nav__item">
849 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
860 <li class=
"md-nav__item">
861 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
872 <li class=
"md-nav__item">
873 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
884 <li class=
"md-nav__item">
885 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
896 <li class=
"md-nav__item">
897 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
898 Browser and Screen Sizes
908 <li class=
"md-nav__item">
909 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
926 <li class=
"md-nav__item">
927 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
938 <li class=
"md-nav__item">
939 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
950 <li class=
"md-nav__item">
951 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
972 <li class=
"md-nav__item md-nav__item--nested">
975 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
977 <label class=
"md-nav__link" for=
"__nav_5">
979 <span class=
"md-nav__icon md-icon"></span>
981 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
982 <label class=
"md-nav__title" for=
"__nav_5">
983 <span class=
"md-nav__icon md-icon"></span>
986 <ul class=
"md-nav__list" data-md-scrollfix
>
992 <li class=
"md-nav__item">
993 <a href=
"../../package/package-xml/" class=
"md-nav__link">
1005 <li class=
"md-nav__item md-nav__item--nested">
1008 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1010 <label class=
"md-nav__link" for=
"__nav_5_2">
1012 <span class=
"md-nav__icon md-icon"></span>
1014 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1015 <label class=
"md-nav__title" for=
"__nav_5_2">
1016 <span class=
"md-nav__icon md-icon"></span>
1019 <ul class=
"md-nav__list" data-md-scrollfix
>
1025 <li class=
"md-nav__item">
1026 <a href=
"../../package/pip/" class=
"md-nav__link">
1037 <li class=
"md-nav__item">
1038 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1049 <li class=
"md-nav__item">
1050 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1061 <li class=
"md-nav__item">
1062 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1073 <li class=
"md-nav__item">
1074 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1085 <li class=
"md-nav__item">
1086 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1097 <li class=
"md-nav__item">
1098 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1109 <li class=
"md-nav__item">
1110 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1121 <li class=
"md-nav__item">
1122 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1133 <li class=
"md-nav__item">
1134 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1145 <li class=
"md-nav__item">
1146 <a href=
"../../package/pip/database/" class=
"md-nav__link">
1157 <li class=
"md-nav__item">
1158 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1169 <li class=
"md-nav__item">
1170 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1181 <li class=
"md-nav__item">
1182 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1193 <li class=
"md-nav__item">
1194 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1205 <li class=
"md-nav__item">
1206 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1217 <li class=
"md-nav__item">
1218 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1229 <li class=
"md-nav__item">
1230 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1241 <li class=
"md-nav__item">
1242 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1243 objectTypeDefinition
1253 <li class=
"md-nav__item">
1254 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1265 <li class=
"md-nav__item">
1266 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1277 <li class=
"md-nav__item">
1278 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1289 <li class=
"md-nav__item">
1290 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1301 <li class=
"md-nav__item">
1302 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1313 <li class=
"md-nav__item">
1314 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1325 <li class=
"md-nav__item">
1326 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1337 <li class=
"md-nav__item">
1338 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1349 <li class=
"md-nav__item">
1350 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1361 <li class=
"md-nav__item">
1362 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1373 <li class=
"md-nav__item">
1374 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1385 <li class=
"md-nav__item">
1386 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1387 userNotificationEvent
1397 <li class=
"md-nav__item">
1398 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1409 <li class=
"md-nav__item">
1410 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1427 <li class=
"md-nav__item">
1428 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1449 <li class=
"md-nav__item md-nav__item--nested">
1452 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1454 <label class=
"md-nav__link" for=
"__nav_6">
1456 <span class=
"md-nav__icon md-icon"></span>
1458 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1459 <label class=
"md-nav__title" for=
"__nav_6">
1460 <span class=
"md-nav__icon md-icon"></span>
1463 <ul class=
"md-nav__list" data-md-scrollfix
>
1470 <li class=
"md-nav__item md-nav__item--nested">
1473 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1475 <label class=
"md-nav__link" for=
"__nav_6_1">
1476 Migrating from WSC
5.3
1477 <span class=
"md-nav__icon md-icon"></span>
1479 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1480 <label class=
"md-nav__title" for=
"__nav_6_1">
1481 <span class=
"md-nav__icon md-icon"></span>
1482 Migrating from WSC
5.3
1484 <ul class=
"md-nav__list" data-md-scrollfix
>
1490 <li class=
"md-nav__item">
1491 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1502 <li class=
"md-nav__item">
1503 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1504 Session Handling and Authentication
1514 <li class=
"md-nav__item">
1515 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1516 TypeScript and JavaScript
1526 <li class=
"md-nav__item">
1527 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1538 <li class=
"md-nav__item">
1539 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1540 Third Party Libraries
1557 <li class=
"md-nav__item md-nav__item--nested">
1560 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1562 <label class=
"md-nav__link" for=
"__nav_6_2">
1563 Migrating from WSC
5.2
1564 <span class=
"md-nav__icon md-icon"></span>
1566 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1567 <label class=
"md-nav__title" for=
"__nav_6_2">
1568 <span class=
"md-nav__icon md-icon"></span>
1569 Migrating from WSC
5.2
1571 <ul class=
"md-nav__list" data-md-scrollfix
>
1577 <li class=
"md-nav__item">
1578 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1589 <li class=
"md-nav__item">
1590 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1591 Templates and Languages
1601 <li class=
"md-nav__item">
1602 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1603 Third Party Libraries
1620 <li class=
"md-nav__item md-nav__item--nested">
1623 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1625 <label class=
"md-nav__link" for=
"__nav_6_3">
1626 Migrating from WSC
3.1
1627 <span class=
"md-nav__icon md-icon"></span>
1629 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1630 <label class=
"md-nav__title" for=
"__nav_6_3">
1631 <span class=
"md-nav__icon md-icon"></span>
1632 Migrating from WSC
3.1
1634 <ul class=
"md-nav__list" data-md-scrollfix
>
1640 <li class=
"md-nav__item">
1641 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1659 <li class=
"md-nav__item md-nav__item--nested">
1662 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1664 <label class=
"md-nav__link" for=
"__nav_6_4">
1665 Migrating from WSC
3.0
1666 <span class=
"md-nav__icon md-icon"></span>
1668 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1669 <label class=
"md-nav__title" for=
"__nav_6_4">
1670 <span class=
"md-nav__icon md-icon"></span>
1671 Migrating from WSC
3.0
1673 <ul class=
"md-nav__list" data-md-scrollfix
>
1679 <li class=
"md-nav__item">
1680 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1691 <li class=
"md-nav__item">
1692 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1703 <li class=
"md-nav__item">
1704 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1715 <li class=
"md-nav__item">
1716 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1727 <li class=
"md-nav__item">
1728 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1746 <li class=
"md-nav__item md-nav__item--nested">
1749 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1751 <label class=
"md-nav__link" for=
"__nav_6_5">
1752 Migrating from WCF
2.1
1753 <span class=
"md-nav__icon md-icon"></span>
1755 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1756 <label class=
"md-nav__title" for=
"__nav_6_5">
1757 <span class=
"md-nav__icon md-icon"></span>
1758 Migrating from WCF
2.1
1760 <ul class=
"md-nav__list" data-md-scrollfix
>
1766 <li class=
"md-nav__item">
1767 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1778 <li class=
"md-nav__item">
1779 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1790 <li class=
"md-nav__item">
1791 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1802 <li class=
"md-nav__item">
1803 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1830 <li class=
"md-nav__item md-nav__item--nested">
1833 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1835 <label class=
"md-nav__link" for=
"__nav_7">
1837 <span class=
"md-nav__icon md-icon"></span>
1839 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1840 <label class=
"md-nav__title" for=
"__nav_7">
1841 <span class=
"md-nav__icon md-icon"></span>
1844 <ul class=
"md-nav__list" data-md-scrollfix
>
1851 <li class=
"md-nav__item md-nav__item--nested">
1854 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1856 <label class=
"md-nav__link" for=
"__nav_7_1">
1858 <span class=
"md-nav__icon md-icon"></span>
1860 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1861 <label class=
"md-nav__title" for=
"__nav_7_1">
1862 <span class=
"md-nav__icon md-icon"></span>
1865 <ul class=
"md-nav__list" data-md-scrollfix
>
1871 <li class=
"md-nav__item">
1872 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1883 <li class=
"md-nav__item">
1884 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1895 <li class=
"md-nav__item">
1896 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1907 <li class=
"md-nav__item">
1908 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1919 <li class=
"md-nav__item">
1920 <a href=
"../../tutorial/series/part_4/" class=
"md-nav__link">
1947 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1948 <div class=
"md-sidebar__scrollwrap">
1949 <div class=
"md-sidebar__inner">
1951 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1957 <label class=
"md-nav__title" for=
"__toc">
1958 <span class=
"md-nav__icon md-icon"></span>
1961 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1963 <li class=
"md-nav__item">
1964 <a href=
"#special-phrases" class=
"md-nav__link">
1968 <nav class=
"md-nav" aria-label=
"Special Phrases">
1969 <ul class=
"md-nav__list">
1971 <li class=
"md-nav__item">
1972 <a href=
"#wcfdatedateformat" class=
"md-nav__link">
1978 <li class=
"md-nav__item">
1979 <a href=
"#wcfdatetimeformat" class=
"md-nav__link">
1985 <li class=
"md-nav__item">
1986 <a href=
"#wcfdatefirstdayoftheweek" class=
"md-nav__link">
1987 wcf.date.firstDayOfTheWeek
1992 <li class=
"md-nav__item">
1993 <a href=
"#wcfglobalpagedirection-rtl-support" class=
"md-nav__link">
1994 wcf.global.pageDirection - RTL support
2012 <div class=
"md-content" data-md-component=
"content">
2013 <article class=
"md-content__inner md-typeset">
2016 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/view/languages.md" title=
"Edit this page" class=
"md-content__button md-icon">
2017 <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>
2021 <h1 id=
"languages">Languages
<a class=
"headerlink" href=
"#languages" title=
"Permanent link">#
</a></h1>
2022 <p>WoltLab Suite offers full i18n support with its integrated language system,
2023 including but not limited to dynamic phrases using template scripting and the
2024 built-in support for right-to-left languages.
</p>
2025 <p>Phrases are deployed using the
<a href=
"../../package/pip/language/">language
</a> package
2026 installation plugin, please also read the
<a href=
"../languages-naming-conventions/">naming conventions for language items
</a>.
</p>
2027 <h2 id=
"special-phrases">Special Phrases
<a class=
"headerlink" href=
"#special-phrases" title=
"Permanent link">#
</a></h2>
2028 <h3 id=
"wcfdatedateformat"><code>wcf.date.dateFormat
</code><a class=
"headerlink" href=
"#wcfdatedateformat" title=
"Permanent link">#
</a></h3>
2029 <div class=
"admonition warning">
2030 <p class=
"admonition-title">Many characters in the format have a special meaning and will be replaced with date fragments. If you want to include a literal character, you'll have to use the backslash
<code>\
</code> as an escape sequence to indicate that the character should be output as-is rather than being replaced. For example,
<code>Y-m-d
</code> will be output as
<code>2018-
03-
30</code>, but
<code>\Y-m-d
</code> will result in
<code>Y-
03-
30</code>.
</p>
2032 <p><em>Defaults to
<code>M jS Y
</code>.
</em></p>
2033 <p>The date format without time using PHP's format characters for the
2034 <a href=
"https://secure.php.net/manual/en/function.date.php"><code>date()
</code></a> function. This
2035 value is also used inside the JavaScript implementation, where the characters
2036 are mapped to an equivalent representation.
</p>
2037 <h3 id=
"wcfdatetimeformat"><code>wcf.date.timeFormat
</code><a class=
"headerlink" href=
"#wcfdatetimeformat" title=
"Permanent link">#
</a></h3>
2038 <p><em>Defaults to
<code>g:i a
</code>.
</em></p>
2039 <p>The date format that is used to represent a time, but not a date. Please see the
2040 explanation on
<code>wcf.date.dateFormat
</code> to learn more about the format characters.
</p>
2041 <h3 id=
"wcfdatefirstdayoftheweek"><code>wcf.date.firstDayOfTheWeek
</code><a class=
"headerlink" href=
"#wcfdatefirstdayoftheweek" title=
"Permanent link">#
</a></h3>
2042 <p><em>Defaults to
<code>0</code>.
</em></p>
2043 <p>Sets the first day of the week:
2044 *
<code>0</code> - Sunday
2045 *
<code>1</code> - Monday
</p>
2046 <h3 id=
"wcfglobalpagedirection-rtl-support"><code>wcf.global.pageDirection
</code> - RTL support
<a class=
"headerlink" href=
"#wcfglobalpagedirection-rtl-support" title=
"Permanent link">#
</a></h3>
2047 <p><em>Defaults to
<code>ltr
</code>.
</em></p>
2048 <p>Changing this value to
<code>rtl
</code> will reverse the page direction and enable the
2049 right-to-left support for phrases. Additionally, a special version of the
2050 stylesheet is loaded that contains all necessary adjustments for the reverse
2057 <div class=
"md-source-date">
2060 Last update:
2021-
01-
08
2079 <footer class=
"md-footer">
2081 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2083 <a href=
"../../php/gdpr/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2084 <div class=
"md-footer__button md-icon">
2085 <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>
2087 <div class=
"md-footer__title">
2088 <div class=
"md-ellipsis">
2089 <span class=
"md-footer__direction">
2098 <a href=
"../templates/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2099 <div class=
"md-footer__title">
2100 <div class=
"md-ellipsis">
2101 <span class=
"md-footer__direction">
2107 <div class=
"md-footer__button md-icon">
2108 <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>
2114 <div class=
"md-footer-meta md-typeset">
2115 <div class=
"md-footer-meta__inner md-grid">
2116 <div class=
"md-footer-copyright">
2118 <div class=
"md-footer-copyright__highlight">
2119 Copyright ©
2020 WoltLab GmbH
2123 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2128 <div class=
"md-footer-copyright">
2129 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2130 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2137 <div class=
"md-dialog" data-md-component=
"dialog">
2138 <div class=
"md-dialog__inner md-typeset"></div>
2140 <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>
2143 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>