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.3">
17 <title>language - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.1655a90d.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.7fa14f5b.min.css">
28 <meta name=
"theme-color" content=
"#009485">
37 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
51 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
56 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
57 <label class=
"md-overlay" for=
"__drawer"></label>
58 <div data-md-component=
"skip">
61 <a href=
"#language-package-installation-plugin" class=
"md-skip">
66 <div data-md-component=
"announce">
68 <aside class=
"md-announce">
69 <div class=
"md-announce__inner md-grid md-typeset">
71 <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">
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">
106 <div class=
"md-header__options">
110 <label class=
"md-header__button md-icon" for=
"__search">
111 <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>
114 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
115 <label class=
"md-search__overlay" for=
"__search"></label>
116 <div class=
"md-search__inner" role=
"search">
117 <form class=
"md-search__form" name=
"search">
118 <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
>
119 <label class=
"md-search__icon md-icon" for=
"__search">
120 <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>
121 <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>
123 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
124 <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>
127 <div class=
"md-search__output">
128 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
129 <div class=
"md-search-result" data-md-component=
"search-result">
130 <div class=
"md-search-result__meta">
133 <ol class=
"md-search-result__list"></ol>
144 <div class=
"md-container" data-md-component=
"container">
149 <main class=
"md-main" data-md-component=
"main">
150 <div class=
"md-main__inner md-grid">
154 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
155 <div class=
"md-sidebar__scrollwrap">
156 <div class=
"md-sidebar__inner">
162 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
163 <label class=
"md-nav__title" for=
"__drawer">
164 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
166 <img src=
"../../../assets/logo.png" alt=
"logo">
169 WoltLab Suite Documentation
172 <ul class=
"md-nav__list" data-md-scrollfix
>
181 <li class=
"md-nav__item">
182 <a href=
"../../../getting-started/" class=
"md-nav__link">
197 <li class=
"md-nav__item md-nav__item--nested">
200 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
202 <label class=
"md-nav__link" for=
"__nav_2">
204 <span class=
"md-nav__icon md-icon"></span>
206 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
207 <label class=
"md-nav__title" for=
"__nav_2">
208 <span class=
"md-nav__icon md-icon"></span>
211 <ul class=
"md-nav__list" data-md-scrollfix
>
217 <li class=
"md-nav__item">
218 <a href=
"../../../php/pages/" class=
"md-nav__link">
229 <li class=
"md-nav__item">
230 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
241 <li class=
"md-nav__item">
242 <a href=
"../../../php/database-access/" class=
"md-nav__link">
253 <li class=
"md-nav__item">
254 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
266 <li class=
"md-nav__item md-nav__item--nested">
269 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
271 <label class=
"md-nav__link" for=
"__nav_2_5">
273 <span class=
"md-nav__icon md-icon"></span>
275 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
276 <label class=
"md-nav__title" for=
"__nav_2_5">
277 <span class=
"md-nav__icon md-icon"></span>
280 <ul class=
"md-nav__list" data-md-scrollfix
>
286 <li class=
"md-nav__item">
287 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
298 <li class=
"md-nav__item">
299 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
322 <li class=
"md-nav__item">
323 <a href=
"../../../php/api/events/" class=
"md-nav__link">
335 <li class=
"md-nav__item md-nav__item--nested">
338 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
340 <label class=
"md-nav__link" for=
"__nav_2_5_5">
342 <span class=
"md-nav__icon md-icon"></span>
344 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
345 <label class=
"md-nav__title" for=
"__nav_2_5_5">
346 <span class=
"md-nav__icon md-icon"></span>
349 <ul class=
"md-nav__list" data-md-scrollfix
>
355 <li class=
"md-nav__item">
356 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
367 <li class=
"md-nav__item">
368 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
379 <li class=
"md-nav__item">
380 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
391 <li class=
"md-nav__item">
392 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
403 <li class=
"md-nav__item">
404 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
421 <li class=
"md-nav__item">
422 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
423 Package Installation Plugins
433 <li class=
"md-nav__item">
434 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
445 <li class=
"md-nav__item">
446 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
457 <li class=
"md-nav__item">
458 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
475 <li class=
"md-nav__item">
476 <a href=
"../../../php/code-style/" class=
"md-nav__link">
487 <li class=
"md-nav__item">
488 <a href=
"../../../php/apps/" class=
"md-nav__link">
499 <li class=
"md-nav__item">
500 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
521 <li class=
"md-nav__item md-nav__item--nested">
524 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
526 <label class=
"md-nav__link" for=
"__nav_3">
527 Languages, Templates & CSS
528 <span class=
"md-nav__icon md-icon"></span>
530 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
531 <label class=
"md-nav__title" for=
"__nav_3">
532 <span class=
"md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
535 <ul class=
"md-nav__list" data-md-scrollfix
>
541 <li class=
"md-nav__item">
542 <a href=
"../../../view/languages/" class=
"md-nav__link">
553 <li class=
"md-nav__item">
554 <a href=
"../../../view/templates/" class=
"md-nav__link">
565 <li class=
"md-nav__item">
566 <a href=
"../../../view/css/" class=
"md-nav__link">
587 <li class=
"md-nav__item md-nav__item--nested">
590 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
592 <label class=
"md-nav__link" for=
"__nav_4">
594 <span class=
"md-nav__icon md-icon"></span>
596 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
597 <label class=
"md-nav__title" for=
"__nav_4">
598 <span class=
"md-nav__icon md-icon"></span>
601 <ul class=
"md-nav__list" data-md-scrollfix
>
607 <li class=
"md-nav__item">
608 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
620 <li class=
"md-nav__item md-nav__item--nested">
623 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
625 <label class=
"md-nav__link" for=
"__nav_4_2">
627 <span class=
"md-nav__icon md-icon"></span>
629 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
630 <label class=
"md-nav__title" for=
"__nav_4_2">
631 <span class=
"md-nav__icon md-icon"></span>
634 <ul class=
"md-nav__list" data-md-scrollfix
>
640 <li class=
"md-nav__item">
641 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
652 <li class=
"md-nav__item">
653 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
664 <li class=
"md-nav__item">
665 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
676 <li class=
"md-nav__item">
677 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
688 <li class=
"md-nav__item">
689 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
700 <li class=
"md-nav__item">
701 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
712 <li class=
"md-nav__item">
713 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
724 <li class=
"md-nav__item">
725 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
726 Browser and Screen Sizes
736 <li class=
"md-nav__item">
737 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
754 <li class=
"md-nav__item">
755 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
766 <li class=
"md-nav__item">
767 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
778 <li class=
"md-nav__item">
779 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
802 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
805 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
807 <label class=
"md-nav__link" for=
"__nav_5">
809 <span class=
"md-nav__icon md-icon"></span>
811 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
812 <label class=
"md-nav__title" for=
"__nav_5">
813 <span class=
"md-nav__icon md-icon"></span>
816 <ul class=
"md-nav__list" data-md-scrollfix
>
822 <li class=
"md-nav__item">
823 <a href=
"../../package-xml/" class=
"md-nav__link">
837 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
840 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
842 <label class=
"md-nav__link" for=
"__nav_5_2">
844 <span class=
"md-nav__icon md-icon"></span>
846 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
847 <label class=
"md-nav__title" for=
"__nav_5_2">
848 <span class=
"md-nav__icon md-icon"></span>
851 <ul class=
"md-nav__list" data-md-scrollfix
>
857 <li class=
"md-nav__item">
858 <a href=
"../" class=
"md-nav__link">
869 <li class=
"md-nav__item">
870 <a href=
"../acl-option/" class=
"md-nav__link">
881 <li class=
"md-nav__item">
882 <a href=
"../acp-menu/" class=
"md-nav__link">
893 <li class=
"md-nav__item">
894 <a href=
"../acp-search-provider/" class=
"md-nav__link">
905 <li class=
"md-nav__item">
906 <a href=
"../acp-template/" class=
"md-nav__link">
917 <li class=
"md-nav__item">
918 <a href=
"../bbcode/" class=
"md-nav__link">
929 <li class=
"md-nav__item">
930 <a href=
"../box/" class=
"md-nav__link">
941 <li class=
"md-nav__item">
942 <a href=
"../clipboard-action/" class=
"md-nav__link">
953 <li class=
"md-nav__item">
954 <a href=
"../core-object/" class=
"md-nav__link">
965 <li class=
"md-nav__item">
966 <a href=
"../cronjob/" class=
"md-nav__link">
977 <li class=
"md-nav__item">
978 <a href=
"../event-listener/" class=
"md-nav__link">
989 <li class=
"md-nav__item">
990 <a href=
"../file/" class=
"md-nav__link">
1003 <li class=
"md-nav__item md-nav__item--active">
1005 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1010 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1012 <span class=
"md-nav__icon md-icon"></span>
1015 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1020 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1026 <label class=
"md-nav__title" for=
"__toc">
1027 <span class=
"md-nav__icon md-icon"></span>
1030 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1032 <li class=
"md-nav__item">
1033 <a href=
"#components" class=
"md-nav__link">
1037 <nav class=
"md-nav" aria-label=
"Components">
1038 <ul class=
"md-nav__list">
1040 <li class=
"md-nav__item">
1041 <a href=
"#category" class=
"md-nav__link">
1045 <nav class=
"md-nav" aria-label=
"<category>">
1046 <ul class=
"md-nav__list">
1048 <li class=
"md-nav__item">
1049 <a href=
"#item" class=
"md-nav__link">
1065 <li class=
"md-nav__item">
1066 <a href=
"#example" class=
"md-nav__link">
1084 <li class=
"md-nav__item">
1085 <a href=
"../media-provider/" class=
"md-nav__link">
1096 <li class=
"md-nav__item">
1097 <a href=
"../menu/" class=
"md-nav__link">
1108 <li class=
"md-nav__item">
1109 <a href=
"../menu-item/" class=
"md-nav__link">
1120 <li class=
"md-nav__item">
1121 <a href=
"../object-type/" class=
"md-nav__link">
1132 <li class=
"md-nav__item">
1133 <a href=
"../object-type-definition/" class=
"md-nav__link">
1134 objectTypeDefinition
1144 <li class=
"md-nav__item">
1145 <a href=
"../option/" class=
"md-nav__link">
1156 <li class=
"md-nav__item">
1157 <a href=
"../page/" class=
"md-nav__link">
1168 <li class=
"md-nav__item">
1169 <a href=
"../pip/" class=
"md-nav__link">
1180 <li class=
"md-nav__item">
1181 <a href=
"../script/" class=
"md-nav__link">
1192 <li class=
"md-nav__item">
1193 <a href=
"../smiley/" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../sql/" class=
"md-nav__link">
1216 <li class=
"md-nav__item">
1217 <a href=
"../style/" class=
"md-nav__link">
1228 <li class=
"md-nav__item">
1229 <a href=
"../template/" class=
"md-nav__link">
1240 <li class=
"md-nav__item">
1241 <a href=
"../template-listener/" class=
"md-nav__link">
1252 <li class=
"md-nav__item">
1253 <a href=
"../user-group-option/" class=
"md-nav__link">
1264 <li class=
"md-nav__item">
1265 <a href=
"../user-menu/" class=
"md-nav__link">
1276 <li class=
"md-nav__item">
1277 <a href=
"../user-notification-event/" class=
"md-nav__link">
1278 userNotificationEvent
1288 <li class=
"md-nav__item">
1289 <a href=
"../user-option/" class=
"md-nav__link">
1300 <li class=
"md-nav__item">
1301 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1318 <li class=
"md-nav__item">
1319 <a href=
"../../database-php-api/" class=
"md-nav__link">
1340 <li class=
"md-nav__item md-nav__item--nested">
1343 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1345 <label class=
"md-nav__link" for=
"__nav_6">
1347 <span class=
"md-nav__icon md-icon"></span>
1349 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1350 <label class=
"md-nav__title" for=
"__nav_6">
1351 <span class=
"md-nav__icon md-icon"></span>
1354 <ul class=
"md-nav__list" data-md-scrollfix
>
1361 <li class=
"md-nav__item md-nav__item--nested">
1364 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1366 <label class=
"md-nav__link" for=
"__nav_6_1">
1367 Migrating from WSC
5.3
1368 <span class=
"md-nav__icon md-icon"></span>
1370 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1371 <label class=
"md-nav__title" for=
"__nav_6_1">
1372 <span class=
"md-nav__icon md-icon"></span>
1373 Migrating from WSC
5.3
1375 <ul class=
"md-nav__list" data-md-scrollfix
>
1381 <li class=
"md-nav__item">
1382 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1393 <li class=
"md-nav__item">
1394 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1395 Session Handling and Authentication
1405 <li class=
"md-nav__item">
1406 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1417 <li class=
"md-nav__item">
1418 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1429 <li class=
"md-nav__item">
1430 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1431 Third Party Libraries
1448 <li class=
"md-nav__item md-nav__item--nested">
1451 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1453 <label class=
"md-nav__link" for=
"__nav_6_2">
1454 Migrating from WSC
5.2
1455 <span class=
"md-nav__icon md-icon"></span>
1457 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1458 <label class=
"md-nav__title" for=
"__nav_6_2">
1459 <span class=
"md-nav__icon md-icon"></span>
1460 Migrating from WSC
5.2
1462 <ul class=
"md-nav__list" data-md-scrollfix
>
1468 <li class=
"md-nav__item">
1469 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1480 <li class=
"md-nav__item">
1481 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1482 Templates and Languages
1492 <li class=
"md-nav__item">
1493 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1494 Third Party Libraries
1511 <li class=
"md-nav__item md-nav__item--nested">
1514 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1516 <label class=
"md-nav__link" for=
"__nav_6_3">
1517 Migrating from WSC
3.1
1518 <span class=
"md-nav__icon md-icon"></span>
1520 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1521 <label class=
"md-nav__title" for=
"__nav_6_3">
1522 <span class=
"md-nav__icon md-icon"></span>
1523 Migrating from WSC
3.1
1525 <ul class=
"md-nav__list" data-md-scrollfix
>
1531 <li class=
"md-nav__item">
1532 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1550 <li class=
"md-nav__item md-nav__item--nested">
1553 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1555 <label class=
"md-nav__link" for=
"__nav_6_4">
1556 Migrating from WSC
3.0
1557 <span class=
"md-nav__icon md-icon"></span>
1559 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1560 <label class=
"md-nav__title" for=
"__nav_6_4">
1561 <span class=
"md-nav__icon md-icon"></span>
1562 Migrating from WSC
3.0
1564 <ul class=
"md-nav__list" data-md-scrollfix
>
1570 <li class=
"md-nav__item">
1571 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1582 <li class=
"md-nav__item">
1583 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1594 <li class=
"md-nav__item">
1595 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1606 <li class=
"md-nav__item">
1607 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1618 <li class=
"md-nav__item">
1619 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1637 <li class=
"md-nav__item md-nav__item--nested">
1640 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1642 <label class=
"md-nav__link" for=
"__nav_6_5">
1643 Migrating from WCF
2.1
1644 <span class=
"md-nav__icon md-icon"></span>
1646 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1647 <label class=
"md-nav__title" for=
"__nav_6_5">
1648 <span class=
"md-nav__icon md-icon"></span>
1649 Migrating from WCF
2.1
1651 <ul class=
"md-nav__list" data-md-scrollfix
>
1657 <li class=
"md-nav__item">
1658 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1669 <li class=
"md-nav__item">
1670 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1681 <li class=
"md-nav__item">
1682 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1693 <li class=
"md-nav__item">
1694 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1721 <li class=
"md-nav__item md-nav__item--nested">
1724 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1726 <label class=
"md-nav__link" for=
"__nav_7">
1728 <span class=
"md-nav__icon md-icon"></span>
1730 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1731 <label class=
"md-nav__title" for=
"__nav_7">
1732 <span class=
"md-nav__icon md-icon"></span>
1735 <ul class=
"md-nav__list" data-md-scrollfix
>
1742 <li class=
"md-nav__item md-nav__item--nested">
1745 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1747 <label class=
"md-nav__link" for=
"__nav_7_1">
1749 <span class=
"md-nav__icon md-icon"></span>
1751 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1752 <label class=
"md-nav__title" for=
"__nav_7_1">
1753 <span class=
"md-nav__icon md-icon"></span>
1756 <ul class=
"md-nav__list" data-md-scrollfix
>
1762 <li class=
"md-nav__item">
1763 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1774 <li class=
"md-nav__item">
1775 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1786 <li class=
"md-nav__item">
1787 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1798 <li class=
"md-nav__item">
1799 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1826 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1827 <div class=
"md-sidebar__scrollwrap">
1828 <div class=
"md-sidebar__inner">
1830 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1836 <label class=
"md-nav__title" for=
"__toc">
1837 <span class=
"md-nav__icon md-icon"></span>
1840 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1842 <li class=
"md-nav__item">
1843 <a href=
"#components" class=
"md-nav__link">
1847 <nav class=
"md-nav" aria-label=
"Components">
1848 <ul class=
"md-nav__list">
1850 <li class=
"md-nav__item">
1851 <a href=
"#category" class=
"md-nav__link">
1855 <nav class=
"md-nav" aria-label=
"<category>">
1856 <ul class=
"md-nav__list">
1858 <li class=
"md-nav__item">
1859 <a href=
"#item" class=
"md-nav__link">
1875 <li class=
"md-nav__item">
1876 <a href=
"#example" class=
"md-nav__link">
1890 <div class=
"md-content" data-md-component=
"content">
1891 <article class=
"md-content__inner md-typeset">
1895 <h1 id=
"language-package-installation-plugin">Language Package Installation Plugin
<a class=
"headerlink" href=
"#language-package-installation-plugin" title=
"Permanent link">#
</a></h1>
1896 <p>Registers new language items.
</p>
1897 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
1898 <div class=
"admonition info">
1899 <p class=
"admonition-title">The
<code>languagecode
</code> attribute is required and should specify the
<a href=
"https://en.wikipedia.org/wiki/ISO_639-1">ISO-
639-
1</a> language code.
</p>
1901 <p>The top level
<code><language
></code> node must contain a
<code>languagecode
</code> attribute.
</p>
1902 <h3 id=
"category"><code><category
></code><a class=
"headerlink" href=
"#category" title=
"Permanent link">#
</a></h3>
1903 <p>Each category must contain a
<code>name
</code> attribute containing two or three components consisting of alphanumeric character only, separated by a single full stop (
<code>.
</code>, U+
002E).
</p>
1904 <h4 id=
"item"><code><item
></code><a class=
"headerlink" href=
"#item" title=
"Permanent link">#
</a></h4>
1905 <p>Each language item must contain a
<code>name
</code> attribute containing at least three components consisting of alphanumeric character only, separated by a single full stop (
<code>.
</code>, U+
002E). The
<code>name
</code> of the parent
<code><category
></code> node followed by a full stop must be a prefix of the
<code><item
></code>’s
<code>name
</code>.
</p>
1906 <div class=
"admonition info">
1907 <p class=
"admonition-title">Wrap the text content inside a CDATA to avoid escaping of special characters.
</p>
1909 <div class=
"admonition warning">
1910 <p class=
"admonition-title">Do not use the
<code>{lang}
</code> tag inside a language item.
</p>
1912 <p>The text content of the
<code><item
></code> node is the value of the language item. Language items that are not in the
<code>wcf.global
</code> category support template scripting.
</p>
1913 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
1914 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
1915 <span class=
"nt"><language
</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/
2019/language.xsd
"</span> <span class=
"na">languagecode=
</span><span class=
"s">"de
"</span><span class=
"nt">></span>
1916 <span class=
"nt"><category
</span> <span class=
"na">name=
</span><span class=
"s">"wcf.example
"</span><span class=
"nt">></span>
1917 <span class=
"nt"><item
</span> <span class=
"na">name=
</span><span class=
"s">"wcf.example.foo
"</span><span class=
"nt">></span><span class=
"cp"><![CDATA[
<strong
>Look!
</strong
>]]
></span><span class=
"nt"></item
></span>
1918 <span class=
"nt"></category
></span>
1919 <span class=
"nt"></language
></span>
1934 <footer class=
"md-footer">
1936 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
1938 <a href=
"../file/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
1939 <div class=
"md-footer__button md-icon">
1940 <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>
1942 <div class=
"md-footer__title">
1943 <div class=
"md-ellipsis">
1944 <span class=
"md-footer__direction">
1953 <a href=
"../media-provider/" class=
"md-footer__link md-footer__link--next" rel=
"next">
1954 <div class=
"md-footer__title">
1955 <div class=
"md-ellipsis">
1956 <span class=
"md-footer__direction">
1962 <div class=
"md-footer__button md-icon">
1963 <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>
1969 <div class=
"md-footer-meta md-typeset">
1970 <div class=
"md-footer-meta__inner md-grid">
1971 <div class=
"md-footer-copyright">
1973 <div class=
"md-footer-copyright__highlight">
1974 Copyright ©
2020 WoltLab GmbH
1978 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
1982 <div class=
"md-footer-copyright">
1983 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
1984 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
1991 <div class=
"md-dialog" data-md-component=
"dialog">
1992 <div class=
"md-dialog__inner md-typeset"></div>
1994 <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>
1997 <script src=
"../../../assets/javascripts/bundle.ca5457b8.min.js"></script>