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">
112 <div class=
"md-header__source">
114 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
115 <div class=
"md-source__icon md-icon">
117 <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>
119 <div class=
"md-source__repository">
128 <div class=
"md-container" data-md-component=
"container">
133 <main class=
"md-main" data-md-component=
"main">
134 <div class=
"md-main__inner md-grid">
138 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
139 <div class=
"md-sidebar__scrollwrap">
140 <div class=
"md-sidebar__inner">
146 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
147 <label class=
"md-nav__title" for=
"__drawer">
148 <a href=
"." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
150 <img src=
"assets/logo.png" alt=
"logo">
153 WoltLab Suite Documentation
156 <div class=
"md-nav__source">
158 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
159 <div class=
"md-source__icon md-icon">
161 <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>
163 <div class=
"md-source__repository">
169 <ul class=
"md-nav__list" data-md-scrollfix
>
178 <li class=
"md-nav__item">
179 <a href=
"getting-started/" class=
"md-nav__link">
194 <li class=
"md-nav__item md-nav__item--nested">
197 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
199 <label class=
"md-nav__link" for=
"__nav_2">
201 <span class=
"md-nav__icon md-icon"></span>
203 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
204 <label class=
"md-nav__title" for=
"__nav_2">
205 <span class=
"md-nav__icon md-icon"></span>
208 <ul class=
"md-nav__list" data-md-scrollfix
>
214 <li class=
"md-nav__item">
215 <a href=
"php/pages/" class=
"md-nav__link">
226 <li class=
"md-nav__item">
227 <a href=
"php/database-objects/" class=
"md-nav__link">
238 <li class=
"md-nav__item">
239 <a href=
"php/database-access/" class=
"md-nav__link">
250 <li class=
"md-nav__item">
251 <a href=
"php/exceptions/" class=
"md-nav__link">
263 <li class=
"md-nav__item md-nav__item--nested">
266 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
268 <label class=
"md-nav__link" for=
"__nav_2_5">
270 <span class=
"md-nav__icon md-icon"></span>
272 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
273 <label class=
"md-nav__title" for=
"__nav_2_5">
274 <span class=
"md-nav__icon md-icon"></span>
277 <ul class=
"md-nav__list" data-md-scrollfix
>
283 <li class=
"md-nav__item">
284 <a href=
"php/api/caches/" class=
"md-nav__link">
295 <li class=
"md-nav__item">
296 <a href=
"php/api/comments/" class=
"md-nav__link">
307 <li class=
"md-nav__item">
308 <a href=
"php/api/cronjobs/" class=
"md-nav__link">
319 <li class=
"md-nav__item">
320 <a href=
"php/api/events/" class=
"md-nav__link">
332 <li class=
"md-nav__item md-nav__item--nested">
335 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
337 <label class=
"md-nav__link" for=
"__nav_2_5_5">
339 <span class=
"md-nav__icon md-icon"></span>
341 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
342 <label class=
"md-nav__title" for=
"__nav_2_5_5">
343 <span class=
"md-nav__icon md-icon"></span>
346 <ul class=
"md-nav__list" data-md-scrollfix
>
352 <li class=
"md-nav__item">
353 <a href=
"php/api/form_builder/overview/" class=
"md-nav__link">
364 <li class=
"md-nav__item">
365 <a href=
"php/api/form_builder/structure/" class=
"md-nav__link">
376 <li class=
"md-nav__item">
377 <a href=
"php/api/form_builder/form_fields/" class=
"md-nav__link">
388 <li class=
"md-nav__item">
389 <a href=
"php/api/form_builder/validation_data/" class=
"md-nav__link">
400 <li class=
"md-nav__item">
401 <a href=
"php/api/form_builder/dependencies/" class=
"md-nav__link">
418 <li class=
"md-nav__item">
419 <a href=
"php/api/package_installation_plugins/" class=
"md-nav__link">
420 Package Installation Plugins
430 <li class=
"md-nav__item">
431 <a href=
"php/api/user_activity_points/" class=
"md-nav__link">
442 <li class=
"md-nav__item">
443 <a href=
"php/api/user_notifications/" class=
"md-nav__link">
454 <li class=
"md-nav__item">
455 <a href=
"php/api/sitemaps/" class=
"md-nav__link">
472 <li class=
"md-nav__item">
473 <a href=
"php/code-style/" class=
"md-nav__link">
484 <li class=
"md-nav__item">
485 <a href=
"php/apps/" class=
"md-nav__link">
496 <li class=
"md-nav__item">
497 <a href=
"php/gdpr/" class=
"md-nav__link">
518 <li class=
"md-nav__item md-nav__item--nested">
521 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
523 <label class=
"md-nav__link" for=
"__nav_3">
524 Languages, Templates & CSS
525 <span class=
"md-nav__icon md-icon"></span>
527 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
528 <label class=
"md-nav__title" for=
"__nav_3">
529 <span class=
"md-nav__icon md-icon"></span>
530 Languages, Templates & CSS
532 <ul class=
"md-nav__list" data-md-scrollfix
>
538 <li class=
"md-nav__item">
539 <a href=
"view/languages/" class=
"md-nav__link">
550 <li class=
"md-nav__item">
551 <a href=
"view/templates/" class=
"md-nav__link">
562 <li class=
"md-nav__item">
563 <a href=
"view/css/" class=
"md-nav__link">
584 <li class=
"md-nav__item md-nav__item--nested">
587 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
589 <label class=
"md-nav__link" for=
"__nav_4">
591 <span class=
"md-nav__icon md-icon"></span>
593 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
594 <label class=
"md-nav__title" for=
"__nav_4">
595 <span class=
"md-nav__icon md-icon"></span>
598 <ul class=
"md-nav__list" data-md-scrollfix
>
604 <li class=
"md-nav__item">
605 <a href=
"javascript/general-usage/" class=
"md-nav__link">
617 <li class=
"md-nav__item md-nav__item--nested">
620 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
622 <label class=
"md-nav__link" for=
"__nav_4_2">
624 <span class=
"md-nav__icon md-icon"></span>
626 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
627 <label class=
"md-nav__title" for=
"__nav_4_2">
628 <span class=
"md-nav__icon md-icon"></span>
631 <ul class=
"md-nav__list" data-md-scrollfix
>
637 <li class=
"md-nav__item">
638 <a href=
"javascript/new-api_writing-a-module/" class=
"md-nav__link">
649 <li class=
"md-nav__item">
650 <a href=
"javascript/new-api_data-structures/" class=
"md-nav__link">
661 <li class=
"md-nav__item">
662 <a href=
"javascript/new-api_core/" class=
"md-nav__link">
673 <li class=
"md-nav__item">
674 <a href=
"javascript/new-api_dom/" class=
"md-nav__link">
685 <li class=
"md-nav__item">
686 <a href=
"javascript/new-api_events/" class=
"md-nav__link">
697 <li class=
"md-nav__item">
698 <a href=
"javascript/new-api_ajax/" class=
"md-nav__link">
709 <li class=
"md-nav__item">
710 <a href=
"javascript/new-api_dialogs/" class=
"md-nav__link">
721 <li class=
"md-nav__item">
722 <a href=
"javascript/new-api_browser/" class=
"md-nav__link">
723 Browser and Screen Sizes
733 <li class=
"md-nav__item">
734 <a href=
"javascript/new-api_ui/" class=
"md-nav__link">
751 <li class=
"md-nav__item">
752 <a href=
"javascript/legacy-api/" class=
"md-nav__link">
763 <li class=
"md-nav__item">
764 <a href=
"javascript/helper-functions/" class=
"md-nav__link">
775 <li class=
"md-nav__item">
776 <a href=
"javascript/code-snippets/" class=
"md-nav__link">
797 <li class=
"md-nav__item md-nav__item--nested">
800 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
802 <label class=
"md-nav__link" for=
"__nav_5">
804 <span class=
"md-nav__icon md-icon"></span>
806 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
807 <label class=
"md-nav__title" for=
"__nav_5">
808 <span class=
"md-nav__icon md-icon"></span>
811 <ul class=
"md-nav__list" data-md-scrollfix
>
817 <li class=
"md-nav__item">
818 <a href=
"package/package-xml/" class=
"md-nav__link">
830 <li class=
"md-nav__item md-nav__item--nested">
833 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
835 <label class=
"md-nav__link" for=
"__nav_5_2">
837 <span class=
"md-nav__icon md-icon"></span>
839 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
840 <label class=
"md-nav__title" for=
"__nav_5_2">
841 <span class=
"md-nav__icon md-icon"></span>
844 <ul class=
"md-nav__list" data-md-scrollfix
>
850 <li class=
"md-nav__item">
851 <a href=
"package/pip/" class=
"md-nav__link">
862 <li class=
"md-nav__item">
863 <a href=
"package/pip/acl-option/" class=
"md-nav__link">
874 <li class=
"md-nav__item">
875 <a href=
"package/pip/acp-menu/" class=
"md-nav__link">
886 <li class=
"md-nav__item">
887 <a href=
"package/pip/acp-search-provider/" class=
"md-nav__link">
898 <li class=
"md-nav__item">
899 <a href=
"package/pip/acp-template/" class=
"md-nav__link">
910 <li class=
"md-nav__item">
911 <a href=
"package/pip/bbcode/" class=
"md-nav__link">
922 <li class=
"md-nav__item">
923 <a href=
"package/pip/box/" class=
"md-nav__link">
934 <li class=
"md-nav__item">
935 <a href=
"package/pip/clipboard-action/" class=
"md-nav__link">
946 <li class=
"md-nav__item">
947 <a href=
"package/pip/core-object/" class=
"md-nav__link">
958 <li class=
"md-nav__item">
959 <a href=
"package/pip/cronjob/" class=
"md-nav__link">
970 <li class=
"md-nav__item">
971 <a href=
"package/pip/event-listener/" class=
"md-nav__link">
982 <li class=
"md-nav__item">
983 <a href=
"package/pip/file/" class=
"md-nav__link">
994 <li class=
"md-nav__item">
995 <a href=
"package/pip/language/" class=
"md-nav__link">
1006 <li class=
"md-nav__item">
1007 <a href=
"package/pip/media-provider/" class=
"md-nav__link">
1018 <li class=
"md-nav__item">
1019 <a href=
"package/pip/menu/" class=
"md-nav__link">
1030 <li class=
"md-nav__item">
1031 <a href=
"package/pip/menu-item/" class=
"md-nav__link">
1042 <li class=
"md-nav__item">
1043 <a href=
"package/pip/object-type/" class=
"md-nav__link">
1054 <li class=
"md-nav__item">
1055 <a href=
"package/pip/object-type-definition/" class=
"md-nav__link">
1056 objectTypeDefinition
1066 <li class=
"md-nav__item">
1067 <a href=
"package/pip/option/" class=
"md-nav__link">
1078 <li class=
"md-nav__item">
1079 <a href=
"package/pip/page/" class=
"md-nav__link">
1090 <li class=
"md-nav__item">
1091 <a href=
"package/pip/pip/" class=
"md-nav__link">
1102 <li class=
"md-nav__item">
1103 <a href=
"package/pip/script/" class=
"md-nav__link">
1114 <li class=
"md-nav__item">
1115 <a href=
"package/pip/smiley/" class=
"md-nav__link">
1126 <li class=
"md-nav__item">
1127 <a href=
"package/pip/sql/" class=
"md-nav__link">
1138 <li class=
"md-nav__item">
1139 <a href=
"package/pip/style/" class=
"md-nav__link">
1150 <li class=
"md-nav__item">
1151 <a href=
"package/pip/template/" class=
"md-nav__link">
1162 <li class=
"md-nav__item">
1163 <a href=
"package/pip/template-listener/" class=
"md-nav__link">
1174 <li class=
"md-nav__item">
1175 <a href=
"package/pip/user-group-option/" class=
"md-nav__link">
1186 <li class=
"md-nav__item">
1187 <a href=
"package/pip/user-menu/" class=
"md-nav__link">
1198 <li class=
"md-nav__item">
1199 <a href=
"package/pip/user-notification-event/" class=
"md-nav__link">
1200 userNotificationEvent
1210 <li class=
"md-nav__item">
1211 <a href=
"package/pip/user-option/" class=
"md-nav__link">
1222 <li class=
"md-nav__item">
1223 <a href=
"package/pip/user-profile-menu/" class=
"md-nav__link">
1240 <li class=
"md-nav__item">
1241 <a href=
"package/database-php-api/" class=
"md-nav__link">
1262 <li class=
"md-nav__item md-nav__item--nested">
1265 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1267 <label class=
"md-nav__link" for=
"__nav_6">
1269 <span class=
"md-nav__icon md-icon"></span>
1271 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1272 <label class=
"md-nav__title" for=
"__nav_6">
1273 <span class=
"md-nav__icon md-icon"></span>
1276 <ul class=
"md-nav__list" data-md-scrollfix
>
1283 <li class=
"md-nav__item md-nav__item--nested">
1286 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1288 <label class=
"md-nav__link" for=
"__nav_6_1">
1289 Migrating from WSC
5.3
1290 <span class=
"md-nav__icon md-icon"></span>
1292 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1293 <label class=
"md-nav__title" for=
"__nav_6_1">
1294 <span class=
"md-nav__icon md-icon"></span>
1295 Migrating from WSC
5.3
1297 <ul class=
"md-nav__list" data-md-scrollfix
>
1303 <li class=
"md-nav__item">
1304 <a href=
"migration/wsc53/php/" class=
"md-nav__link">
1315 <li class=
"md-nav__item">
1316 <a href=
"migration/wsc53/session/" class=
"md-nav__link">
1317 Session Handling and Authentication
1327 <li class=
"md-nav__item">
1328 <a href=
"migration/wsc53/javascript/" class=
"md-nav__link">
1339 <li class=
"md-nav__item">
1340 <a href=
"migration/wsc53/templates/" class=
"md-nav__link">
1351 <li class=
"md-nav__item">
1352 <a href=
"migration/wsc53/libraries/" class=
"md-nav__link">
1353 Third Party Libraries
1370 <li class=
"md-nav__item md-nav__item--nested">
1373 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1375 <label class=
"md-nav__link" for=
"__nav_6_2">
1376 Migrating from WSC
5.2
1377 <span class=
"md-nav__icon md-icon"></span>
1379 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1380 <label class=
"md-nav__title" for=
"__nav_6_2">
1381 <span class=
"md-nav__icon md-icon"></span>
1382 Migrating from WSC
5.2
1384 <ul class=
"md-nav__list" data-md-scrollfix
>
1390 <li class=
"md-nav__item">
1391 <a href=
"migration/wsc52/php/" class=
"md-nav__link">
1402 <li class=
"md-nav__item">
1403 <a href=
"migration/wsc52/templates/" class=
"md-nav__link">
1404 Templates and Languages
1414 <li class=
"md-nav__item">
1415 <a href=
"migration/wsc52/libraries/" class=
"md-nav__link">
1416 Third Party Libraries
1433 <li class=
"md-nav__item md-nav__item--nested">
1436 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1438 <label class=
"md-nav__link" for=
"__nav_6_3">
1439 Migrating from WSC
3.1
1440 <span class=
"md-nav__icon md-icon"></span>
1442 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1443 <label class=
"md-nav__title" for=
"__nav_6_3">
1444 <span class=
"md-nav__icon md-icon"></span>
1445 Migrating from WSC
3.1
1447 <ul class=
"md-nav__list" data-md-scrollfix
>
1453 <li class=
"md-nav__item">
1454 <a href=
"migration/wsc31/php/" class=
"md-nav__link">
1472 <li class=
"md-nav__item md-nav__item--nested">
1475 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1477 <label class=
"md-nav__link" for=
"__nav_6_4">
1478 Migrating from WSC
3.0
1479 <span class=
"md-nav__icon md-icon"></span>
1481 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1482 <label class=
"md-nav__title" for=
"__nav_6_4">
1483 <span class=
"md-nav__icon md-icon"></span>
1484 Migrating from WSC
3.0
1486 <ul class=
"md-nav__list" data-md-scrollfix
>
1492 <li class=
"md-nav__item">
1493 <a href=
"migration/wsc30/php/" class=
"md-nav__link">
1504 <li class=
"md-nav__item">
1505 <a href=
"migration/wsc30/javascript/" class=
"md-nav__link">
1516 <li class=
"md-nav__item">
1517 <a href=
"migration/wsc30/templates/" class=
"md-nav__link">
1528 <li class=
"md-nav__item">
1529 <a href=
"migration/wsc30/css/" class=
"md-nav__link">
1540 <li class=
"md-nav__item">
1541 <a href=
"migration/wsc30/package/" class=
"md-nav__link">
1559 <li class=
"md-nav__item md-nav__item--nested">
1562 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1564 <label class=
"md-nav__link" for=
"__nav_6_5">
1565 Migrating from WCF
2.1
1566 <span class=
"md-nav__icon md-icon"></span>
1568 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1569 <label class=
"md-nav__title" for=
"__nav_6_5">
1570 <span class=
"md-nav__icon md-icon"></span>
1571 Migrating from WCF
2.1
1573 <ul class=
"md-nav__list" data-md-scrollfix
>
1579 <li class=
"md-nav__item">
1580 <a href=
"migration/wcf21/php/" class=
"md-nav__link">
1591 <li class=
"md-nav__item">
1592 <a href=
"migration/wcf21/templates/" class=
"md-nav__link">
1603 <li class=
"md-nav__item">
1604 <a href=
"migration/wcf21/css/" class=
"md-nav__link">
1615 <li class=
"md-nav__item">
1616 <a href=
"migration/wcf21/package/" class=
"md-nav__link">
1643 <li class=
"md-nav__item md-nav__item--nested">
1646 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1648 <label class=
"md-nav__link" for=
"__nav_7">
1650 <span class=
"md-nav__icon md-icon"></span>
1652 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1653 <label class=
"md-nav__title" for=
"__nav_7">
1654 <span class=
"md-nav__icon md-icon"></span>
1657 <ul class=
"md-nav__list" data-md-scrollfix
>
1664 <li class=
"md-nav__item md-nav__item--nested">
1667 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1669 <label class=
"md-nav__link" for=
"__nav_7_1">
1671 <span class=
"md-nav__icon md-icon"></span>
1673 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1674 <label class=
"md-nav__title" for=
"__nav_7_1">
1675 <span class=
"md-nav__icon md-icon"></span>
1678 <ul class=
"md-nav__list" data-md-scrollfix
>
1684 <li class=
"md-nav__item">
1685 <a href=
"tutorial/series/overview/" class=
"md-nav__link">
1696 <li class=
"md-nav__item">
1697 <a href=
"tutorial/series/part_1/" class=
"md-nav__link">
1708 <li class=
"md-nav__item">
1709 <a href=
"tutorial/series/part_2/" class=
"md-nav__link">
1720 <li class=
"md-nav__item">
1721 <a href=
"tutorial/series/part_3/" class=
"md-nav__link">
1748 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1749 <div class=
"md-sidebar__scrollwrap">
1750 <div class=
"md-sidebar__inner">
1752 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1758 <label class=
"md-nav__title" for=
"__toc">
1759 <span class=
"md-nav__icon md-icon"></span>
1762 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1764 <li class=
"md-nav__item">
1765 <a href=
"#introduction" class=
"md-nav__link">
1771 <li class=
"md-nav__item">
1772 <a href=
"#about-woltlab-suite" class=
"md-nav__link">
1786 <div class=
"md-content" data-md-component=
"content">
1787 <article class=
"md-content__inner md-typeset">
1790 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/index.md" title=
"Edit this page" class=
"md-content__button md-icon">
1791 <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>
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>
1806 <div class=
"md-source-date">
1809 Last update:
2021-
01-
12
1827 <footer class=
"md-footer">
1829 <div class=
"md-footer-meta md-typeset">
1830 <div class=
"md-footer-meta__inner md-grid">
1831 <div class=
"md-footer-copyright">
1833 <div class=
"md-footer-copyright__highlight">
1834 Copyright ©
2020 WoltLab GmbH
1838 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
1843 <div class=
"md-footer-copyright">
1844 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
1845 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
1852 <div class=
"md-dialog" data-md-component=
"dialog">
1853 <div class=
"md-dialog__inner md-typeset"></div>
1855 <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>
1858 <script src=
"assets/javascripts/bundle.5cf3e710.min.js"></script>