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>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=
"#woltlab-suite-54-documentation" 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 WoltLab Suite
5.4 Documentation
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>
145 <div class=
"md-container" data-md-component=
"container">
150 <main class=
"md-main" data-md-component=
"main">
151 <div class=
"md-main__inner md-grid">
155 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
156 <div class=
"md-sidebar__scrollwrap">
157 <div class=
"md-sidebar__inner">
163 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
164 <label class=
"md-nav__title" for=
"__drawer">
165 <a href=
"." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
167 <img src=
"assets/logo.png" alt=
"logo">
170 WoltLab Suite Documentation
173 <ul class=
"md-nav__list" data-md-scrollfix
>
182 <li class=
"md-nav__item">
183 <a href=
"getting-started/" class=
"md-nav__link">
198 <li class=
"md-nav__item md-nav__item--nested">
201 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
203 <label class=
"md-nav__link" for=
"__nav_2">
205 <span class=
"md-nav__icon md-icon"></span>
207 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
208 <label class=
"md-nav__title" for=
"__nav_2">
209 <span class=
"md-nav__icon md-icon"></span>
212 <ul class=
"md-nav__list" data-md-scrollfix
>
218 <li class=
"md-nav__item">
219 <a href=
"php/pages/" class=
"md-nav__link">
230 <li class=
"md-nav__item">
231 <a href=
"php/database-objects/" class=
"md-nav__link">
242 <li class=
"md-nav__item">
243 <a href=
"php/database-access/" class=
"md-nav__link">
254 <li class=
"md-nav__item">
255 <a href=
"php/exceptions/" class=
"md-nav__link">
267 <li class=
"md-nav__item md-nav__item--nested">
270 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
272 <label class=
"md-nav__link" for=
"__nav_2_5">
274 <span class=
"md-nav__icon md-icon"></span>
276 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
277 <label class=
"md-nav__title" for=
"__nav_2_5">
278 <span class=
"md-nav__icon md-icon"></span>
281 <ul class=
"md-nav__list" data-md-scrollfix
>
287 <li class=
"md-nav__item">
288 <a href=
"php/api/caches/" class=
"md-nav__link">
299 <li class=
"md-nav__item">
300 <a href=
"php/api/comments/" class=
"md-nav__link">
311 <li class=
"md-nav__item">
312 <a href=
"php/api/cronjobs/" class=
"md-nav__link">
323 <li class=
"md-nav__item">
324 <a href=
"php/api/events/" class=
"md-nav__link">
336 <li class=
"md-nav__item md-nav__item--nested">
339 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
341 <label class=
"md-nav__link" for=
"__nav_2_5_5">
343 <span class=
"md-nav__icon md-icon"></span>
345 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
346 <label class=
"md-nav__title" for=
"__nav_2_5_5">
347 <span class=
"md-nav__icon md-icon"></span>
350 <ul class=
"md-nav__list" data-md-scrollfix
>
356 <li class=
"md-nav__item">
357 <a href=
"php/api/form_builder/overview/" class=
"md-nav__link">
368 <li class=
"md-nav__item">
369 <a href=
"php/api/form_builder/structure/" class=
"md-nav__link">
380 <li class=
"md-nav__item">
381 <a href=
"php/api/form_builder/form_fields/" class=
"md-nav__link">
392 <li class=
"md-nav__item">
393 <a href=
"php/api/form_builder/validation_data/" class=
"md-nav__link">
404 <li class=
"md-nav__item">
405 <a href=
"php/api/form_builder/dependencies/" class=
"md-nav__link">
422 <li class=
"md-nav__item">
423 <a href=
"php/api/package_installation_plugins/" class=
"md-nav__link">
424 Package Installation Plugins
434 <li class=
"md-nav__item">
435 <a href=
"php/api/user_activity_points/" class=
"md-nav__link">
446 <li class=
"md-nav__item">
447 <a href=
"php/api/user_notifications/" class=
"md-nav__link">
458 <li class=
"md-nav__item">
459 <a href=
"php/api/sitemaps/" class=
"md-nav__link">
476 <li class=
"md-nav__item">
477 <a href=
"php/code-style/" class=
"md-nav__link">
488 <li class=
"md-nav__item">
489 <a href=
"php/apps/" class=
"md-nav__link">
500 <li class=
"md-nav__item">
501 <a href=
"php/gdpr/" class=
"md-nav__link">
522 <li class=
"md-nav__item md-nav__item--nested">
525 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
527 <label class=
"md-nav__link" for=
"__nav_3">
528 Languages, Templates & CSS
529 <span class=
"md-nav__icon md-icon"></span>
531 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
532 <label class=
"md-nav__title" for=
"__nav_3">
533 <span class=
"md-nav__icon md-icon"></span>
534 Languages, Templates & CSS
536 <ul class=
"md-nav__list" data-md-scrollfix
>
542 <li class=
"md-nav__item">
543 <a href=
"view/languages/" class=
"md-nav__link">
554 <li class=
"md-nav__item">
555 <a href=
"view/templates/" class=
"md-nav__link">
566 <li class=
"md-nav__item">
567 <a href=
"view/css/" class=
"md-nav__link">
588 <li class=
"md-nav__item md-nav__item--nested">
591 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
593 <label class=
"md-nav__link" for=
"__nav_4">
595 <span class=
"md-nav__icon md-icon"></span>
597 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
598 <label class=
"md-nav__title" for=
"__nav_4">
599 <span class=
"md-nav__icon md-icon"></span>
602 <ul class=
"md-nav__list" data-md-scrollfix
>
608 <li class=
"md-nav__item">
609 <a href=
"javascript/general-usage/" class=
"md-nav__link">
621 <li class=
"md-nav__item md-nav__item--nested">
624 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
626 <label class=
"md-nav__link" for=
"__nav_4_2">
628 <span class=
"md-nav__icon md-icon"></span>
630 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
631 <label class=
"md-nav__title" for=
"__nav_4_2">
632 <span class=
"md-nav__icon md-icon"></span>
635 <ul class=
"md-nav__list" data-md-scrollfix
>
641 <li class=
"md-nav__item">
642 <a href=
"javascript/new-api_writing-a-module/" class=
"md-nav__link">
653 <li class=
"md-nav__item">
654 <a href=
"javascript/new-api_data-structures/" class=
"md-nav__link">
665 <li class=
"md-nav__item">
666 <a href=
"javascript/new-api_core/" class=
"md-nav__link">
677 <li class=
"md-nav__item">
678 <a href=
"javascript/new-api_dom/" class=
"md-nav__link">
689 <li class=
"md-nav__item">
690 <a href=
"javascript/new-api_events/" class=
"md-nav__link">
701 <li class=
"md-nav__item">
702 <a href=
"javascript/new-api_ajax/" class=
"md-nav__link">
713 <li class=
"md-nav__item">
714 <a href=
"javascript/new-api_dialogs/" class=
"md-nav__link">
725 <li class=
"md-nav__item">
726 <a href=
"javascript/new-api_browser/" class=
"md-nav__link">
727 Browser and Screen Sizes
737 <li class=
"md-nav__item">
738 <a href=
"javascript/new-api_ui/" class=
"md-nav__link">
755 <li class=
"md-nav__item">
756 <a href=
"javascript/legacy-api/" class=
"md-nav__link">
767 <li class=
"md-nav__item">
768 <a href=
"javascript/helper-functions/" class=
"md-nav__link">
779 <li class=
"md-nav__item">
780 <a href=
"javascript/code-snippets/" class=
"md-nav__link">
801 <li class=
"md-nav__item md-nav__item--nested">
804 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
806 <label class=
"md-nav__link" for=
"__nav_5">
808 <span class=
"md-nav__icon md-icon"></span>
810 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
811 <label class=
"md-nav__title" for=
"__nav_5">
812 <span class=
"md-nav__icon md-icon"></span>
815 <ul class=
"md-nav__list" data-md-scrollfix
>
821 <li class=
"md-nav__item">
822 <a href=
"package/package-xml/" class=
"md-nav__link">
834 <li class=
"md-nav__item md-nav__item--nested">
837 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
839 <label class=
"md-nav__link" for=
"__nav_5_2">
841 <span class=
"md-nav__icon md-icon"></span>
843 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
844 <label class=
"md-nav__title" for=
"__nav_5_2">
845 <span class=
"md-nav__icon md-icon"></span>
848 <ul class=
"md-nav__list" data-md-scrollfix
>
854 <li class=
"md-nav__item">
855 <a href=
"package/pip/" class=
"md-nav__link">
866 <li class=
"md-nav__item">
867 <a href=
"package/pip/acl-option/" class=
"md-nav__link">
878 <li class=
"md-nav__item">
879 <a href=
"package/pip/acp-menu/" class=
"md-nav__link">
890 <li class=
"md-nav__item">
891 <a href=
"package/pip/acp-search-provider/" class=
"md-nav__link">
902 <li class=
"md-nav__item">
903 <a href=
"package/pip/acp-template/" class=
"md-nav__link">
914 <li class=
"md-nav__item">
915 <a href=
"package/pip/bbcode/" class=
"md-nav__link">
926 <li class=
"md-nav__item">
927 <a href=
"package/pip/box/" class=
"md-nav__link">
938 <li class=
"md-nav__item">
939 <a href=
"package/pip/clipboard-action/" class=
"md-nav__link">
950 <li class=
"md-nav__item">
951 <a href=
"package/pip/core-object/" class=
"md-nav__link">
962 <li class=
"md-nav__item">
963 <a href=
"package/pip/cronjob/" class=
"md-nav__link">
974 <li class=
"md-nav__item">
975 <a href=
"package/pip/event-listener/" class=
"md-nav__link">
986 <li class=
"md-nav__item">
987 <a href=
"package/pip/file/" class=
"md-nav__link">
998 <li class=
"md-nav__item">
999 <a href=
"package/pip/language/" class=
"md-nav__link">
1010 <li class=
"md-nav__item">
1011 <a href=
"package/pip/media-provider/" class=
"md-nav__link">
1022 <li class=
"md-nav__item">
1023 <a href=
"package/pip/menu/" class=
"md-nav__link">
1034 <li class=
"md-nav__item">
1035 <a href=
"package/pip/menu-item/" class=
"md-nav__link">
1046 <li class=
"md-nav__item">
1047 <a href=
"package/pip/object-type/" class=
"md-nav__link">
1058 <li class=
"md-nav__item">
1059 <a href=
"package/pip/object-type-definition/" class=
"md-nav__link">
1060 objectTypeDefinition
1070 <li class=
"md-nav__item">
1071 <a href=
"package/pip/option/" class=
"md-nav__link">
1082 <li class=
"md-nav__item">
1083 <a href=
"package/pip/page/" class=
"md-nav__link">
1094 <li class=
"md-nav__item">
1095 <a href=
"package/pip/pip/" class=
"md-nav__link">
1106 <li class=
"md-nav__item">
1107 <a href=
"package/pip/script/" class=
"md-nav__link">
1118 <li class=
"md-nav__item">
1119 <a href=
"package/pip/smiley/" class=
"md-nav__link">
1130 <li class=
"md-nav__item">
1131 <a href=
"package/pip/sql/" class=
"md-nav__link">
1142 <li class=
"md-nav__item">
1143 <a href=
"package/pip/style/" class=
"md-nav__link">
1154 <li class=
"md-nav__item">
1155 <a href=
"package/pip/template/" class=
"md-nav__link">
1166 <li class=
"md-nav__item">
1167 <a href=
"package/pip/template-listener/" class=
"md-nav__link">
1178 <li class=
"md-nav__item">
1179 <a href=
"package/pip/user-group-option/" class=
"md-nav__link">
1190 <li class=
"md-nav__item">
1191 <a href=
"package/pip/user-menu/" class=
"md-nav__link">
1202 <li class=
"md-nav__item">
1203 <a href=
"package/pip/user-notification-event/" class=
"md-nav__link">
1204 userNotificationEvent
1214 <li class=
"md-nav__item">
1215 <a href=
"package/pip/user-option/" class=
"md-nav__link">
1226 <li class=
"md-nav__item">
1227 <a href=
"package/pip/user-profile-menu/" class=
"md-nav__link">
1244 <li class=
"md-nav__item">
1245 <a href=
"package/database-php-api/" class=
"md-nav__link">
1266 <li class=
"md-nav__item md-nav__item--nested">
1269 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1271 <label class=
"md-nav__link" for=
"__nav_6">
1273 <span class=
"md-nav__icon md-icon"></span>
1275 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1276 <label class=
"md-nav__title" for=
"__nav_6">
1277 <span class=
"md-nav__icon md-icon"></span>
1280 <ul class=
"md-nav__list" data-md-scrollfix
>
1287 <li class=
"md-nav__item md-nav__item--nested">
1290 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1292 <label class=
"md-nav__link" for=
"__nav_6_1">
1293 Migrating from WSC
5.3
1294 <span class=
"md-nav__icon md-icon"></span>
1296 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1297 <label class=
"md-nav__title" for=
"__nav_6_1">
1298 <span class=
"md-nav__icon md-icon"></span>
1299 Migrating from WSC
5.3
1301 <ul class=
"md-nav__list" data-md-scrollfix
>
1307 <li class=
"md-nav__item">
1308 <a href=
"migration/wsc53/php/" class=
"md-nav__link">
1319 <li class=
"md-nav__item">
1320 <a href=
"migration/wsc53/session/" class=
"md-nav__link">
1321 Session Handling and Authentication
1331 <li class=
"md-nav__item">
1332 <a href=
"migration/wsc53/javascript/" class=
"md-nav__link">
1343 <li class=
"md-nav__item">
1344 <a href=
"migration/wsc53/templates/" class=
"md-nav__link">
1355 <li class=
"md-nav__item">
1356 <a href=
"migration/wsc53/libraries/" class=
"md-nav__link">
1357 Third Party Libraries
1374 <li class=
"md-nav__item md-nav__item--nested">
1377 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1379 <label class=
"md-nav__link" for=
"__nav_6_2">
1380 Migrating from WSC
5.2
1381 <span class=
"md-nav__icon md-icon"></span>
1383 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1384 <label class=
"md-nav__title" for=
"__nav_6_2">
1385 <span class=
"md-nav__icon md-icon"></span>
1386 Migrating from WSC
5.2
1388 <ul class=
"md-nav__list" data-md-scrollfix
>
1394 <li class=
"md-nav__item">
1395 <a href=
"migration/wsc52/php/" class=
"md-nav__link">
1406 <li class=
"md-nav__item">
1407 <a href=
"migration/wsc52/templates/" class=
"md-nav__link">
1408 Templates and Languages
1418 <li class=
"md-nav__item">
1419 <a href=
"migration/wsc52/libraries/" class=
"md-nav__link">
1420 Third Party Libraries
1437 <li class=
"md-nav__item md-nav__item--nested">
1440 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1442 <label class=
"md-nav__link" for=
"__nav_6_3">
1443 Migrating from WSC
3.1
1444 <span class=
"md-nav__icon md-icon"></span>
1446 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1447 <label class=
"md-nav__title" for=
"__nav_6_3">
1448 <span class=
"md-nav__icon md-icon"></span>
1449 Migrating from WSC
3.1
1451 <ul class=
"md-nav__list" data-md-scrollfix
>
1457 <li class=
"md-nav__item">
1458 <a href=
"migration/wsc31/php/" class=
"md-nav__link">
1476 <li class=
"md-nav__item md-nav__item--nested">
1479 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1481 <label class=
"md-nav__link" for=
"__nav_6_4">
1482 Migrating from WSC
3.0
1483 <span class=
"md-nav__icon md-icon"></span>
1485 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1486 <label class=
"md-nav__title" for=
"__nav_6_4">
1487 <span class=
"md-nav__icon md-icon"></span>
1488 Migrating from WSC
3.0
1490 <ul class=
"md-nav__list" data-md-scrollfix
>
1496 <li class=
"md-nav__item">
1497 <a href=
"migration/wsc30/php/" class=
"md-nav__link">
1508 <li class=
"md-nav__item">
1509 <a href=
"migration/wsc30/javascript/" class=
"md-nav__link">
1520 <li class=
"md-nav__item">
1521 <a href=
"migration/wsc30/templates/" class=
"md-nav__link">
1532 <li class=
"md-nav__item">
1533 <a href=
"migration/wsc30/css/" class=
"md-nav__link">
1544 <li class=
"md-nav__item">
1545 <a href=
"migration/wsc30/package/" class=
"md-nav__link">
1563 <li class=
"md-nav__item md-nav__item--nested">
1566 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1568 <label class=
"md-nav__link" for=
"__nav_6_5">
1569 Migrating from WCF
2.1
1570 <span class=
"md-nav__icon md-icon"></span>
1572 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1573 <label class=
"md-nav__title" for=
"__nav_6_5">
1574 <span class=
"md-nav__icon md-icon"></span>
1575 Migrating from WCF
2.1
1577 <ul class=
"md-nav__list" data-md-scrollfix
>
1583 <li class=
"md-nav__item">
1584 <a href=
"migration/wcf21/php/" class=
"md-nav__link">
1595 <li class=
"md-nav__item">
1596 <a href=
"migration/wcf21/templates/" class=
"md-nav__link">
1607 <li class=
"md-nav__item">
1608 <a href=
"migration/wcf21/css/" class=
"md-nav__link">
1619 <li class=
"md-nav__item">
1620 <a href=
"migration/wcf21/package/" class=
"md-nav__link">
1647 <li class=
"md-nav__item md-nav__item--nested">
1650 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1652 <label class=
"md-nav__link" for=
"__nav_7">
1654 <span class=
"md-nav__icon md-icon"></span>
1656 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1657 <label class=
"md-nav__title" for=
"__nav_7">
1658 <span class=
"md-nav__icon md-icon"></span>
1661 <ul class=
"md-nav__list" data-md-scrollfix
>
1668 <li class=
"md-nav__item md-nav__item--nested">
1671 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1673 <label class=
"md-nav__link" for=
"__nav_7_1">
1675 <span class=
"md-nav__icon md-icon"></span>
1677 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1678 <label class=
"md-nav__title" for=
"__nav_7_1">
1679 <span class=
"md-nav__icon md-icon"></span>
1682 <ul class=
"md-nav__list" data-md-scrollfix
>
1688 <li class=
"md-nav__item">
1689 <a href=
"tutorial/series/overview/" class=
"md-nav__link">
1700 <li class=
"md-nav__item">
1701 <a href=
"tutorial/series/part_1/" class=
"md-nav__link">
1712 <li class=
"md-nav__item">
1713 <a href=
"tutorial/series/part_2/" class=
"md-nav__link">
1724 <li class=
"md-nav__item">
1725 <a href=
"tutorial/series/part_3/" class=
"md-nav__link">
1752 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1753 <div class=
"md-sidebar__scrollwrap">
1754 <div class=
"md-sidebar__inner">
1756 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1762 <label class=
"md-nav__title" for=
"__toc">
1763 <span class=
"md-nav__icon md-icon"></span>
1766 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1768 <li class=
"md-nav__item">
1769 <a href=
"#introduction" class=
"md-nav__link">
1775 <li class=
"md-nav__item">
1776 <a href=
"#about-woltlab-suite" class=
"md-nav__link">
1790 <div class=
"md-content" data-md-component=
"content">
1791 <article class=
"md-content__inner md-typeset">
1795 <h1 id=
"woltlab-suite-54-documentation">WoltLab Suite
5.4 Documentation
<a class=
"headerlink" href=
"#woltlab-suite-54-documentation" title=
"Permanent link">#
</a></h1>
1796 <h2 id=
"introduction">Introduction
<a class=
"headerlink" href=
"#introduction" title=
"Permanent link">#
</a></h2>
1797 <p>This documentation explains the basic API functionality and the creation of own packages. It is expected that you are somewhat experienced with
<a href=
"https://en.wikipedia.org/wiki/PHP">PHP
</a>,
<a href=
"https://en.wikipedia.org/wiki/Object-oriented_programming">object-oriented programming
</a> and
<a href=
"https://en.wikipedia.org/wiki/MySQL">MySQL
</a>.
</p>
1798 <p>Head over to the
<a href=
"getting-started/">quick start tutorial
</a> to learn more.
</p>
1799 <h2 id=
"about-woltlab-suite">About WoltLab Suite
<a class=
"headerlink" href=
"#about-woltlab-suite" title=
"Permanent link">#
</a></h2>
1800 <p><a href=
"https://github.com/WoltLab/WCF">WoltLab Suite Core
</a> as well as most of the other packages are available on
<a href=
"https://github.com/WoltLab">GitHub
</a> and are licensed under the terms of the
<a href=
"https://github.com/WoltLab/WCF/blob/master/LICENSE">GNU Lesser General Public License
2.1</a>.
</p>
1814 <footer class=
"md-footer">
1816 <div class=
"md-footer-meta md-typeset">
1817 <div class=
"md-footer-meta__inner md-grid">
1818 <div class=
"md-footer-copyright">
1820 <div class=
"md-footer-copyright__highlight">
1821 Copyright ©
2020 WoltLab GmbH
1825 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
1830 <div class=
"md-footer-copyright">
1831 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
1832 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
1839 <div class=
"md-dialog" data-md-component=
"dialog">
1840 <div class=
"md-dialog__inner md-typeset"></div>
1842 <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>
1845 <script src=
"assets/javascripts/bundle.5cf3e710.min.js"></script>