3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"shortcut icon" href=
"../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.0.5">
17 <title>Language Naming Conventions - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.77f3fd56.min.css">
24 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.7fa14f5b.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
56 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
57 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
58 <label class=
"md-overlay" for=
"__drawer"></label>
59 <div data-md-component=
"skip">
62 <a href=
"#language-naming-conventions" class=
"md-skip">
67 <div data-md-component=
"announce">
69 <aside class=
"md-announce">
70 <div class=
"md-announce__inner md-grid md-typeset">
72 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
81 <header class=
"md-header" data-md-component=
"header">
82 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
83 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation">
85 <img src=
"../../assets/logo.png" alt=
"logo">
88 <label class=
"md-header__button md-icon" for=
"__drawer">
89 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
91 <div class=
"md-header__title" data-md-component=
"header-title">
92 <div class=
"md-header__ellipsis">
93 <div class=
"md-header__topic">
94 <span class=
"md-ellipsis">
95 WoltLab Suite Documentation
98 <div class=
"md-header__topic" data-md-component=
"header-topic">
99 <span class=
"md-ellipsis">
101 Language Naming Conventions
107 <div class=
"md-header__options">
111 <label class=
"md-header__button md-icon" for=
"__search">
112 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
115 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
116 <label class=
"md-search__overlay" for=
"__search"></label>
117 <div class=
"md-search__inner" role=
"search">
118 <form class=
"md-search__form" name=
"search">
119 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
120 <label class=
"md-search__icon md-icon" for=
"__search">
121 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
122 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
124 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
125 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
128 <div class=
"md-search__output">
129 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
130 <div class=
"md-search-result" data-md-component=
"search-result">
131 <div class=
"md-search-result__meta">
134 <ol class=
"md-search-result__list"></ol>
142 <div class=
"md-header__source">
144 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
145 <div class=
"md-source__icon md-icon">
147 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
149 <div class=
"md-source__repository">
158 <div class=
"md-container" data-md-component=
"container">
163 <main class=
"md-main" data-md-component=
"main">
164 <div class=
"md-main__inner md-grid">
168 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
169 <div class=
"md-sidebar__scrollwrap">
170 <div class=
"md-sidebar__inner">
176 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
177 <label class=
"md-nav__title" for=
"__drawer">
178 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
180 <img src=
"../../assets/logo.png" alt=
"logo">
183 WoltLab Suite Documentation
186 <div class=
"md-nav__source">
188 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
189 <div class=
"md-source__icon md-icon">
191 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
193 <div class=
"md-source__repository">
199 <ul class=
"md-nav__list" data-md-scrollfix
>
208 <li class=
"md-nav__item">
209 <a href=
"../../getting-started/" class=
"md-nav__link">
224 <li class=
"md-nav__item md-nav__item--nested">
227 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
229 <label class=
"md-nav__link" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
233 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
234 <label class=
"md-nav__title" for=
"__nav_2">
235 <span class=
"md-nav__icon md-icon"></span>
238 <ul class=
"md-nav__list" data-md-scrollfix
>
244 <li class=
"md-nav__item">
245 <a href=
"../../php/pages/" class=
"md-nav__link">
256 <li class=
"md-nav__item">
257 <a href=
"../../php/database-objects/" class=
"md-nav__link">
268 <li class=
"md-nav__item">
269 <a href=
"../../php/database-access/" class=
"md-nav__link">
280 <li class=
"md-nav__item">
281 <a href=
"../../php/exceptions/" class=
"md-nav__link">
293 <li class=
"md-nav__item md-nav__item--nested">
296 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
298 <label class=
"md-nav__link" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
302 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
303 <label class=
"md-nav__title" for=
"__nav_2_5">
304 <span class=
"md-nav__icon md-icon"></span>
307 <ul class=
"md-nav__list" data-md-scrollfix
>
313 <li class=
"md-nav__item">
314 <a href=
"../../php/api/caches/" class=
"md-nav__link">
325 <li class=
"md-nav__item">
326 <a href=
"../../php/api/comments/" class=
"md-nav__link">
337 <li class=
"md-nav__item">
338 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
349 <li class=
"md-nav__item">
350 <a href=
"../../php/api/events/" class=
"md-nav__link">
362 <li class=
"md-nav__item md-nav__item--nested">
365 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
367 <label class=
"md-nav__link" for=
"__nav_2_5_5">
369 <span class=
"md-nav__icon md-icon"></span>
371 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
372 <label class=
"md-nav__title" for=
"__nav_2_5_5">
373 <span class=
"md-nav__icon md-icon"></span>
376 <ul class=
"md-nav__list" data-md-scrollfix
>
382 <li class=
"md-nav__item">
383 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
394 <li class=
"md-nav__item">
395 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
406 <li class=
"md-nav__item">
407 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
418 <li class=
"md-nav__item">
419 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
430 <li class=
"md-nav__item">
431 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
448 <li class=
"md-nav__item">
449 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
450 Package Installation Plugins
460 <li class=
"md-nav__item">
461 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
472 <li class=
"md-nav__item">
473 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
484 <li class=
"md-nav__item">
485 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
502 <li class=
"md-nav__item">
503 <a href=
"../../php/code-style/" class=
"md-nav__link">
514 <li class=
"md-nav__item">
515 <a href=
"../../php/apps/" class=
"md-nav__link">
526 <li class=
"md-nav__item">
527 <a href=
"../../php/gdpr/" class=
"md-nav__link">
548 <li class=
"md-nav__item md-nav__item--nested">
551 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
553 <label class=
"md-nav__link" for=
"__nav_3">
554 Languages, Templates & CSS
555 <span class=
"md-nav__icon md-icon"></span>
557 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
558 <label class=
"md-nav__title" for=
"__nav_3">
559 <span class=
"md-nav__icon md-icon"></span>
560 Languages, Templates & CSS
562 <ul class=
"md-nav__list" data-md-scrollfix
>
568 <li class=
"md-nav__item">
569 <a href=
"../languages/" class=
"md-nav__link">
580 <li class=
"md-nav__item">
581 <a href=
"../templates/" class=
"md-nav__link">
592 <li class=
"md-nav__item">
593 <a href=
"../css/" class=
"md-nav__link">
614 <li class=
"md-nav__item md-nav__item--nested">
617 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
619 <label class=
"md-nav__link" for=
"__nav_4">
621 <span class=
"md-nav__icon md-icon"></span>
623 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
624 <label class=
"md-nav__title" for=
"__nav_4">
625 <span class=
"md-nav__icon md-icon"></span>
628 <ul class=
"md-nav__list" data-md-scrollfix
>
634 <li class=
"md-nav__item">
635 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
647 <li class=
"md-nav__item md-nav__item--nested">
650 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
652 <label class=
"md-nav__link" for=
"__nav_4_2">
654 <span class=
"md-nav__icon md-icon"></span>
656 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
657 <label class=
"md-nav__title" for=
"__nav_4_2">
658 <span class=
"md-nav__icon md-icon"></span>
661 <ul class=
"md-nav__list" data-md-scrollfix
>
667 <li class=
"md-nav__item">
668 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
679 <li class=
"md-nav__item">
680 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
691 <li class=
"md-nav__item">
692 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
703 <li class=
"md-nav__item">
704 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
715 <li class=
"md-nav__item">
716 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
727 <li class=
"md-nav__item">
728 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
739 <li class=
"md-nav__item">
740 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
751 <li class=
"md-nav__item">
752 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
753 Browser and Screen Sizes
763 <li class=
"md-nav__item">
764 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
781 <li class=
"md-nav__item">
782 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
793 <li class=
"md-nav__item">
794 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
805 <li class=
"md-nav__item">
806 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
827 <li class=
"md-nav__item md-nav__item--nested">
830 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
832 <label class=
"md-nav__link" for=
"__nav_5">
834 <span class=
"md-nav__icon md-icon"></span>
836 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
837 <label class=
"md-nav__title" for=
"__nav_5">
838 <span class=
"md-nav__icon md-icon"></span>
841 <ul class=
"md-nav__list" data-md-scrollfix
>
847 <li class=
"md-nav__item">
848 <a href=
"../../package/package-xml/" class=
"md-nav__link">
860 <li class=
"md-nav__item md-nav__item--nested">
863 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
865 <label class=
"md-nav__link" for=
"__nav_5_2">
867 <span class=
"md-nav__icon md-icon"></span>
869 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
870 <label class=
"md-nav__title" for=
"__nav_5_2">
871 <span class=
"md-nav__icon md-icon"></span>
874 <ul class=
"md-nav__list" data-md-scrollfix
>
880 <li class=
"md-nav__item">
881 <a href=
"../../package/pip/" class=
"md-nav__link">
892 <li class=
"md-nav__item">
893 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
904 <li class=
"md-nav__item">
905 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
916 <li class=
"md-nav__item">
917 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
928 <li class=
"md-nav__item">
929 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
940 <li class=
"md-nav__item">
941 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
952 <li class=
"md-nav__item">
953 <a href=
"../../package/pip/box/" class=
"md-nav__link">
964 <li class=
"md-nav__item">
965 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
976 <li class=
"md-nav__item">
977 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
988 <li class=
"md-nav__item">
989 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1000 <li class=
"md-nav__item">
1001 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1012 <li class=
"md-nav__item">
1013 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1024 <li class=
"md-nav__item">
1025 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1036 <li class=
"md-nav__item">
1037 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1048 <li class=
"md-nav__item">
1049 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1060 <li class=
"md-nav__item">
1061 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1072 <li class=
"md-nav__item">
1073 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1084 <li class=
"md-nav__item">
1085 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1086 objectTypeDefinition
1096 <li class=
"md-nav__item">
1097 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1108 <li class=
"md-nav__item">
1109 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1120 <li class=
"md-nav__item">
1121 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1132 <li class=
"md-nav__item">
1133 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1144 <li class=
"md-nav__item">
1145 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1156 <li class=
"md-nav__item">
1157 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1168 <li class=
"md-nav__item">
1169 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1180 <li class=
"md-nav__item">
1181 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1192 <li class=
"md-nav__item">
1193 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1216 <li class=
"md-nav__item">
1217 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1228 <li class=
"md-nav__item">
1229 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1230 userNotificationEvent
1240 <li class=
"md-nav__item">
1241 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1252 <li class=
"md-nav__item">
1253 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1270 <li class=
"md-nav__item">
1271 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1292 <li class=
"md-nav__item md-nav__item--nested">
1295 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1297 <label class=
"md-nav__link" for=
"__nav_6">
1299 <span class=
"md-nav__icon md-icon"></span>
1301 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1302 <label class=
"md-nav__title" for=
"__nav_6">
1303 <span class=
"md-nav__icon md-icon"></span>
1306 <ul class=
"md-nav__list" data-md-scrollfix
>
1313 <li class=
"md-nav__item md-nav__item--nested">
1316 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1318 <label class=
"md-nav__link" for=
"__nav_6_1">
1319 Migrating from WSC
5.3
1320 <span class=
"md-nav__icon md-icon"></span>
1322 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1323 <label class=
"md-nav__title" for=
"__nav_6_1">
1324 <span class=
"md-nav__icon md-icon"></span>
1325 Migrating from WSC
5.3
1327 <ul class=
"md-nav__list" data-md-scrollfix
>
1333 <li class=
"md-nav__item">
1334 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1345 <li class=
"md-nav__item">
1346 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1347 Session Handling and Authentication
1357 <li class=
"md-nav__item">
1358 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1369 <li class=
"md-nav__item">
1370 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1381 <li class=
"md-nav__item">
1382 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1383 Third Party Libraries
1400 <li class=
"md-nav__item md-nav__item--nested">
1403 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1405 <label class=
"md-nav__link" for=
"__nav_6_2">
1406 Migrating from WSC
5.2
1407 <span class=
"md-nav__icon md-icon"></span>
1409 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1410 <label class=
"md-nav__title" for=
"__nav_6_2">
1411 <span class=
"md-nav__icon md-icon"></span>
1412 Migrating from WSC
5.2
1414 <ul class=
"md-nav__list" data-md-scrollfix
>
1420 <li class=
"md-nav__item">
1421 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1432 <li class=
"md-nav__item">
1433 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1434 Templates and Languages
1444 <li class=
"md-nav__item">
1445 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1446 Third Party Libraries
1463 <li class=
"md-nav__item md-nav__item--nested">
1466 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1468 <label class=
"md-nav__link" for=
"__nav_6_3">
1469 Migrating from WSC
3.1
1470 <span class=
"md-nav__icon md-icon"></span>
1472 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1473 <label class=
"md-nav__title" for=
"__nav_6_3">
1474 <span class=
"md-nav__icon md-icon"></span>
1475 Migrating from WSC
3.1
1477 <ul class=
"md-nav__list" data-md-scrollfix
>
1483 <li class=
"md-nav__item">
1484 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1502 <li class=
"md-nav__item md-nav__item--nested">
1505 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1507 <label class=
"md-nav__link" for=
"__nav_6_4">
1508 Migrating from WSC
3.0
1509 <span class=
"md-nav__icon md-icon"></span>
1511 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1512 <label class=
"md-nav__title" for=
"__nav_6_4">
1513 <span class=
"md-nav__icon md-icon"></span>
1514 Migrating from WSC
3.0
1516 <ul class=
"md-nav__list" data-md-scrollfix
>
1522 <li class=
"md-nav__item">
1523 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1534 <li class=
"md-nav__item">
1535 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1546 <li class=
"md-nav__item">
1547 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1558 <li class=
"md-nav__item">
1559 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1570 <li class=
"md-nav__item">
1571 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1589 <li class=
"md-nav__item md-nav__item--nested">
1592 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1594 <label class=
"md-nav__link" for=
"__nav_6_5">
1595 Migrating from WCF
2.1
1596 <span class=
"md-nav__icon md-icon"></span>
1598 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1599 <label class=
"md-nav__title" for=
"__nav_6_5">
1600 <span class=
"md-nav__icon md-icon"></span>
1601 Migrating from WCF
2.1
1603 <ul class=
"md-nav__list" data-md-scrollfix
>
1609 <li class=
"md-nav__item">
1610 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1621 <li class=
"md-nav__item">
1622 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1633 <li class=
"md-nav__item">
1634 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1645 <li class=
"md-nav__item">
1646 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1673 <li class=
"md-nav__item md-nav__item--nested">
1676 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1678 <label class=
"md-nav__link" for=
"__nav_7">
1680 <span class=
"md-nav__icon md-icon"></span>
1682 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1683 <label class=
"md-nav__title" for=
"__nav_7">
1684 <span class=
"md-nav__icon md-icon"></span>
1687 <ul class=
"md-nav__list" data-md-scrollfix
>
1694 <li class=
"md-nav__item md-nav__item--nested">
1697 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1699 <label class=
"md-nav__link" for=
"__nav_7_1">
1701 <span class=
"md-nav__icon md-icon"></span>
1703 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1704 <label class=
"md-nav__title" for=
"__nav_7_1">
1705 <span class=
"md-nav__icon md-icon"></span>
1708 <ul class=
"md-nav__list" data-md-scrollfix
>
1714 <li class=
"md-nav__item">
1715 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1726 <li class=
"md-nav__item">
1727 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1738 <li class=
"md-nav__item">
1739 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1750 <li class=
"md-nav__item">
1751 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1778 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1779 <div class=
"md-sidebar__scrollwrap">
1780 <div class=
"md-sidebar__inner">
1782 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1788 <label class=
"md-nav__title" for=
"__toc">
1789 <span class=
"md-nav__icon md-icon"></span>
1792 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1794 <li class=
"md-nav__item">
1795 <a href=
"#forms" class=
"md-nav__link">
1799 <nav class=
"md-nav" aria-label=
"Forms">
1800 <ul class=
"md-nav__list">
1802 <li class=
"md-nav__item">
1803 <a href=
"#fields" class=
"md-nav__link">
1809 <li class=
"md-nav__item">
1810 <a href=
"#error-texts" class=
"md-nav__link">
1814 <nav class=
"md-nav" aria-label=
"Error Texts">
1815 <ul class=
"md-nav__list">
1817 <li class=
"md-nav__item">
1818 <a href=
"#naming-conventions" class=
"md-nav__link">
1834 <li class=
"md-nav__item">
1835 <a href=
"#confirmation-messages" class=
"md-nav__link">
1836 Confirmation messages
1839 <nav class=
"md-nav" aria-label=
"Confirmation messages">
1840 <ul class=
"md-nav__list">
1842 <li class=
"md-nav__item">
1843 <a href=
"#type-specific-deletion-confirmation-message" class=
"md-nav__link">
1844 Type-Specific Deletion Confirmation Message
1847 <nav class=
"md-nav" aria-label=
"Type-Specific Deletion Confirmation Message">
1848 <ul class=
"md-nav__list">
1850 <li class=
"md-nav__item">
1851 <a href=
"#german" class=
"md-nav__link">
1857 <li class=
"md-nav__item">
1858 <a href=
"#english" class=
"md-nav__link">
1869 <li class=
"md-nav__item">
1870 <a href=
"#object-specific-deletion-confirmation-message" class=
"md-nav__link">
1871 Object-Specific Deletion Confirmation Message
1874 <nav class=
"md-nav" aria-label=
"Object-Specific Deletion Confirmation Message">
1875 <ul class=
"md-nav__list">
1877 <li class=
"md-nav__item">
1878 <a href=
"#german_1" class=
"md-nav__link">
1884 <li class=
"md-nav__item">
1885 <a href=
"#english_1" class=
"md-nav__link">
1901 <li class=
"md-nav__item">
1902 <a href=
"#user-group-options" class=
"md-nav__link">
1906 <nav class=
"md-nav" aria-label=
"User Group Options">
1907 <ul class=
"md-nav__list">
1909 <li class=
"md-nav__item">
1910 <a href=
"#comments" class=
"md-nav__link">
1914 <nav class=
"md-nav" aria-label=
"Comments">
1915 <ul class=
"md-nav__list">
1917 <li class=
"md-nav__item">
1918 <a href=
"#german_2" class=
"md-nav__link">
1924 <li class=
"md-nav__item">
1925 <a href=
"#english_2" class=
"md-nav__link">
1949 <div class=
"md-content" data-md-component=
"content">
1950 <article class=
"md-content__inner md-typeset">
1953 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/master/docs/view/languages-naming-conventions.md" title=
"Edit this page" class=
"md-content__button md-icon">
1954 <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>
1958 <h1 id=
"language-naming-conventions">Language Naming Conventions
<a class=
"headerlink" href=
"#language-naming-conventions" title=
"Permanent link">#
</a></h1>
1959 <p>This page contains general rules for naming language items and for their values.
1960 API-specific rules are listed on the relevant API page:
</p>
1962 <li><a href=
"../../php/api/comments/#language-items">Comments
</a></li>
1964 <h2 id=
"forms">Forms
<a class=
"headerlink" href=
"#forms" title=
"Permanent link">#
</a></h2>
1965 <h3 id=
"fields">Fields
<a class=
"headerlink" href=
"#fields" title=
"Permanent link">#
</a></h3>
1966 <p>If you have an application
<code>foo
</code> and a database object
<code>foo\data\bar\Bar
</code> with a property
<code>baz
</code> that can be set via a form field, the name of the corresponding language item has to be
<code>foo.bar.baz
</code>.
1967 If you want to add an additional description below the field, use the language item
<code>foo.bar.baz.description
</code>.
</p>
1968 <h3 id=
"error-texts">Error Texts
<a class=
"headerlink" href=
"#error-texts" title=
"Permanent link">#
</a></h3>
1969 <p>If an error of type
<code>{error type}
</code> for the previously mentioned form field occurs during validation, you have to use the language item
<code>foo.bar.baz.error.{error type}
</code> for the language item describing the error.
</p>
1970 <p>Exception to this rule:
1971 There are several general error messages like
<code>wcf.global.form.error.empty
</code> that have to be used for general errors like an empty field that may not be empty to avoid duplication of the same error message text over and over again in different language items.
</p>
1972 <h4 id=
"naming-conventions">Naming Conventions
<a class=
"headerlink" href=
"#naming-conventions" title=
"Permanent link">#
</a></h4>
1974 <li>If the entered text does not conform to some special rules, i.e. if the text is invalid, use
<code>invalid
</code> as error type.
</li>
1975 <li>If the entered text is required to be unique but is already used for another object, use
<code>notUnique
</code> as error type.
</li>
1977 <h2 id=
"confirmation-messages">Confirmation messages
<a class=
"headerlink" href=
"#confirmation-messages" title=
"Permanent link">#
</a></h2>
1978 <p>If the language item for an action is
<code>foo.bar.action
</code>, the language item for the confirmation message has to be
<code>foo.bar.action.confirmMessage
</code> instead of
<code>foo.bar.action.sure
</code> which is still used by some older language items.
</p>
1979 <h3 id=
"type-specific-deletion-confirmation-message">Type-Specific Deletion Confirmation Message
<a class=
"headerlink" href=
"#type-specific-deletion-confirmation-message" title=
"Permanent link">#
</a></h3>
1980 <h4 id=
"german">German
<a class=
"headerlink" href=
"#german" title=
"Permanent link">#
</a></h4>
1981 <div class=
"highlight"><pre><span></span><code>{if LANGUAGE_USE_INFORMAL_VARIANT}Willst du{else}Wollen Sie{/if} {element type} wirklich löschen?
1984 <div class=
"highlight"><pre><span></span><code>{if LANGUAGE_USE_INFORMAL_VARIANT}Willst du{else}Wollen Sie{/if} das Icon wirklich löschen?
1986 <h4 id=
"english">English
<a class=
"headerlink" href=
"#english" title=
"Permanent link">#
</a></h4>
1987 <div class=
"highlight"><pre><span></span><code>Do you really want delete the {element type}?
1990 <div class=
"highlight"><pre><span></span><code>Do you really want delete the icon?
1992 <h3 id=
"object-specific-deletion-confirmation-message">Object-Specific Deletion Confirmation Message
<a class=
"headerlink" href=
"#object-specific-deletion-confirmation-message" title=
"Permanent link">#
</a></h3>
1993 <h4 id=
"german_1">German
<a class=
"headerlink" href=
"#german_1" title=
"Permanent link">#
</a></h4>
1994 <div class=
"highlight"><pre><span></span><code>{if LANGUAGE_USE_INFORMAL_VARIANT}Willst du{else}Wollen Sie{/if} {element type}
<span class=
"confirmationObject
">{object name}
</span
> wirklich löschen?
1997 <div class=
"highlight"><pre><span></span><code>{if LANGUAGE_USE_INFORMAL_VARIANT}Willst du{else}Wollen Sie{/if} den Artikel
<span class=
"confirmationObject
">{$article-
>getTitle()}
</span
> wirklich löschen?
1999 <h4 id=
"english_1">English
<a class=
"headerlink" href=
"#english_1" title=
"Permanent link">#
</a></h4>
2000 <div class=
"highlight"><pre><span></span><code>Do you really want to delete the {element type}
<span class=
"confirmationObject
">{object name}
</span
>?
2003 <div class=
"highlight"><pre><span></span><code>Do you really want to delete the article
<span class=
"confirmationObject
">{$article-
>getTitle()}
</span
>?
2005 <h2 id=
"user-group-options">User Group Options
<a class=
"headerlink" href=
"#user-group-options" title=
"Permanent link">#
</a></h2>
2006 <h3 id=
"comments">Comments
<a class=
"headerlink" href=
"#comments" title=
"Permanent link">#
</a></h3>
2007 <h4 id=
"german_2">German
<a class=
"headerlink" href=
"#german_2" title=
"Permanent link">#
</a></h4>
2013 <th>example permission name
</th>
2014 <th>language item
</th>
2021 <td><code>user.foo.canAddComment
</code></td>
2022 <td><code>Kann Kommentare erstellen
</code></td>
2027 <td><code>user.foo.canDeleteComment
</code></td>
2028 <td><code>Kann eigene Kommentare löschen
</code></td>
2033 <td><code>user.foo.canEditComment
</code></td>
2034 <td><code>Kann eigene Kommentare bearbeiten
</code></td>
2039 <td><code>mod.foo.canDeleteComment
</code></td>
2040 <td><code>Kann Kommentare löschen
</code></td>
2045 <td><code>mod.foo.canEditComment
</code></td>
2046 <td><code>Kann Kommentare bearbeiten
</code></td>
2051 <td><code>mod.foo.canModerateComment
</code></td>
2052 <td><code>Kann Kommentare moderieren
</code></td>
2056 <h4 id=
"english_2">English
<a class=
"headerlink" href=
"#english_2" title=
"Permanent link">#
</a></h4>
2062 <th>example permission name
</th>
2063 <th>language item
</th>
2070 <td><code>user.foo.canAddComment
</code></td>
2071 <td><code>Can create comments
</code></td>
2076 <td><code>user.foo.canDeleteComment
</code></td>
2077 <td><code>Can delete their comments
</code></td>
2082 <td><code>user.foo.canEditComment
</code></td>
2083 <td><code>Can edit their comments
</code></td>
2088 <td><code>mod.foo.canDeleteComment
</code></td>
2089 <td><code>Can delete comments
</code></td>
2094 <td><code>mod.foo.canEditComment
</code></td>
2095 <td><code>Can edit comments
</code></td>
2100 <td><code>mod.foo.canModerateComment
</code></td>
2101 <td><code>Can moderate comments
</code></td>
2118 <footer class=
"md-footer">
2120 <div class=
"md-footer-meta md-typeset">
2121 <div class=
"md-footer-meta__inner md-grid">
2122 <div class=
"md-footer-copyright">
2124 <div class=
"md-footer-copyright__highlight">
2125 Copyright ©
2020 WoltLab GmbH
2129 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2134 <div class=
"md-footer-copyright">
2135 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2136 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2143 <div class=
"md-dialog" data-md-component=
"dialog">
2144 <div class=
"md-dialog__inner md-typeset"></div>
2146 <script id=
"__config" type=
"application/json">{
"base":
"../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../assets/javascripts/workers/search.fb4a9340.min.js",
"version": {
"provider":
"mike"}}
</script>
2149 <script src=
"../../assets/javascripts/bundle.5cf3e710.min.js"></script>