3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>Overview - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ef6f36e2.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <script>function __prefix(e){return new URL(
"../../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
57 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
58 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
59 <label class=
"md-overlay" for=
"__drawer"></label>
60 <div data-md-component=
"skip">
63 <a href=
"#tutorial-series" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
84 <img src=
"../../../assets/logo.png" alt=
"logo">
87 <label class=
"md-header__button md-icon" for=
"__drawer">
88 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 <div class=
"md-header__title" data-md-component=
"header-title">
91 <div class=
"md-header__ellipsis">
92 <div class=
"md-header__topic">
93 <span class=
"md-ellipsis">
94 WoltLab Suite Documentation
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
109 <label class=
"md-header__button md-icon" for=
"__search">
110 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
113 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
114 <label class=
"md-search__overlay" for=
"__search"></label>
115 <div class=
"md-search__inner" role=
"search">
116 <form class=
"md-search__form" name=
"search">
117 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
118 <label class=
"md-search__icon md-icon" for=
"__search">
119 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
120 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
122 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
123 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
126 <div class=
"md-search__output">
127 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
128 <div class=
"md-search-result" data-md-component=
"search-result">
129 <div class=
"md-search-result__meta">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
142 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
143 <div class=
"md-source__icon md-icon">
145 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
166 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
167 <div class=
"md-sidebar__scrollwrap">
168 <div class=
"md-sidebar__inner">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
184 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
185 <div class=
"md-source__icon md-icon">
187 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
229 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
230 <label class=
"md-nav__title" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
298 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
299 <label class=
"md-nav__title" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
309 <li class=
"md-nav__item">
310 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
321 <li class=
"md-nav__item">
322 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
333 <li class=
"md-nav__item">
334 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
345 <li class=
"md-nav__item">
346 <a href=
"../../../php/api/events/" class=
"md-nav__link">
358 <li class=
"md-nav__item md-nav__item--nested">
361 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
363 <label class=
"md-nav__link" for=
"__nav_2_5_5">
365 <span class=
"md-nav__icon md-icon"></span>
367 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
368 <label class=
"md-nav__title" for=
"__nav_2_5_5">
369 <span class=
"md-nav__icon md-icon"></span>
372 <ul class=
"md-nav__list" data-md-scrollfix
>
378 <li class=
"md-nav__item">
379 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
390 <li class=
"md-nav__item">
391 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
402 <li class=
"md-nav__item">
403 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
414 <li class=
"md-nav__item">
415 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
426 <li class=
"md-nav__item">
427 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
444 <li class=
"md-nav__item">
445 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
446 Package Installation Plugins
456 <li class=
"md-nav__item">
457 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
468 <li class=
"md-nav__item">
469 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
480 <li class=
"md-nav__item">
481 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
498 <li class=
"md-nav__item">
499 <a href=
"../../../php/code-style/" class=
"md-nav__link">
510 <li class=
"md-nav__item">
511 <a href=
"../../../php/apps/" class=
"md-nav__link">
522 <li class=
"md-nav__item">
523 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
544 <li class=
"md-nav__item md-nav__item--nested">
547 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
549 <label class=
"md-nav__link" for=
"__nav_3">
550 Languages, Templates & CSS
551 <span class=
"md-nav__icon md-icon"></span>
553 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
554 <label class=
"md-nav__title" for=
"__nav_3">
555 <span class=
"md-nav__icon md-icon"></span>
556 Languages, Templates & CSS
558 <ul class=
"md-nav__list" data-md-scrollfix
>
564 <li class=
"md-nav__item">
565 <a href=
"../../../view/languages/" class=
"md-nav__link">
576 <li class=
"md-nav__item">
577 <a href=
"../../../view/templates/" class=
"md-nav__link">
588 <li class=
"md-nav__item">
589 <a href=
"../../../view/css/" class=
"md-nav__link">
610 <li class=
"md-nav__item md-nav__item--nested">
613 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
615 <label class=
"md-nav__link" for=
"__nav_4">
617 <span class=
"md-nav__icon md-icon"></span>
619 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
620 <label class=
"md-nav__title" for=
"__nav_4">
621 <span class=
"md-nav__icon md-icon"></span>
624 <ul class=
"md-nav__list" data-md-scrollfix
>
630 <li class=
"md-nav__item">
631 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
643 <li class=
"md-nav__item md-nav__item--nested">
646 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
648 <label class=
"md-nav__link" for=
"__nav_4_2">
650 <span class=
"md-nav__icon md-icon"></span>
652 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
653 <label class=
"md-nav__title" for=
"__nav_4_2">
654 <span class=
"md-nav__icon md-icon"></span>
657 <ul class=
"md-nav__list" data-md-scrollfix
>
663 <li class=
"md-nav__item">
664 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
675 <li class=
"md-nav__item">
676 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
687 <li class=
"md-nav__item">
688 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
699 <li class=
"md-nav__item">
700 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
711 <li class=
"md-nav__item">
712 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
723 <li class=
"md-nav__item">
724 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
735 <li class=
"md-nav__item">
736 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
747 <li class=
"md-nav__item">
748 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
749 Browser and Screen Sizes
759 <li class=
"md-nav__item">
760 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
777 <li class=
"md-nav__item">
778 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
789 <li class=
"md-nav__item">
790 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
801 <li class=
"md-nav__item">
802 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
823 <li class=
"md-nav__item md-nav__item--nested">
826 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
828 <label class=
"md-nav__link" for=
"__nav_5">
830 <span class=
"md-nav__icon md-icon"></span>
832 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
833 <label class=
"md-nav__title" for=
"__nav_5">
834 <span class=
"md-nav__icon md-icon"></span>
837 <ul class=
"md-nav__list" data-md-scrollfix
>
843 <li class=
"md-nav__item">
844 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
856 <li class=
"md-nav__item md-nav__item--nested">
859 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
861 <label class=
"md-nav__link" for=
"__nav_5_2">
863 <span class=
"md-nav__icon md-icon"></span>
865 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
866 <label class=
"md-nav__title" for=
"__nav_5_2">
867 <span class=
"md-nav__icon md-icon"></span>
870 <ul class=
"md-nav__list" data-md-scrollfix
>
876 <li class=
"md-nav__item">
877 <a href=
"../../../package/pip/" class=
"md-nav__link">
888 <li class=
"md-nav__item">
889 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
900 <li class=
"md-nav__item">
901 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
912 <li class=
"md-nav__item">
913 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
924 <li class=
"md-nav__item">
925 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
936 <li class=
"md-nav__item">
937 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
948 <li class=
"md-nav__item">
949 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
960 <li class=
"md-nav__item">
961 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
972 <li class=
"md-nav__item">
973 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
984 <li class=
"md-nav__item">
985 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
996 <li class=
"md-nav__item">
997 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1008 <li class=
"md-nav__item">
1009 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1020 <li class=
"md-nav__item">
1021 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1032 <li class=
"md-nav__item">
1033 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1044 <li class=
"md-nav__item">
1045 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1056 <li class=
"md-nav__item">
1057 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1068 <li class=
"md-nav__item">
1069 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1080 <li class=
"md-nav__item">
1081 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1082 objectTypeDefinition
1092 <li class=
"md-nav__item">
1093 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1104 <li class=
"md-nav__item">
1105 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1116 <li class=
"md-nav__item">
1117 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1128 <li class=
"md-nav__item">
1129 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1140 <li class=
"md-nav__item">
1141 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1152 <li class=
"md-nav__item">
1153 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1164 <li class=
"md-nav__item">
1165 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1176 <li class=
"md-nav__item">
1177 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1188 <li class=
"md-nav__item">
1189 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1200 <li class=
"md-nav__item">
1201 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1212 <li class=
"md-nav__item">
1213 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1224 <li class=
"md-nav__item">
1225 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1226 userNotificationEvent
1236 <li class=
"md-nav__item">
1237 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1248 <li class=
"md-nav__item">
1249 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1266 <li class=
"md-nav__item">
1267 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1288 <li class=
"md-nav__item md-nav__item--nested">
1291 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1293 <label class=
"md-nav__link" for=
"__nav_6">
1295 <span class=
"md-nav__icon md-icon"></span>
1297 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1298 <label class=
"md-nav__title" for=
"__nav_6">
1299 <span class=
"md-nav__icon md-icon"></span>
1302 <ul class=
"md-nav__list" data-md-scrollfix
>
1309 <li class=
"md-nav__item md-nav__item--nested">
1312 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1314 <label class=
"md-nav__link" for=
"__nav_6_1">
1315 Migrating from WSC
5.3
1316 <span class=
"md-nav__icon md-icon"></span>
1318 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1319 <label class=
"md-nav__title" for=
"__nav_6_1">
1320 <span class=
"md-nav__icon md-icon"></span>
1321 Migrating from WSC
5.3
1323 <ul class=
"md-nav__list" data-md-scrollfix
>
1329 <li class=
"md-nav__item">
1330 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1341 <li class=
"md-nav__item">
1342 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1343 Session Handling and Authentication
1353 <li class=
"md-nav__item">
1354 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1365 <li class=
"md-nav__item">
1366 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1377 <li class=
"md-nav__item">
1378 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1379 Third Party Libraries
1396 <li class=
"md-nav__item md-nav__item--nested">
1399 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1401 <label class=
"md-nav__link" for=
"__nav_6_2">
1402 Migrating from WSC
5.2
1403 <span class=
"md-nav__icon md-icon"></span>
1405 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1406 <label class=
"md-nav__title" for=
"__nav_6_2">
1407 <span class=
"md-nav__icon md-icon"></span>
1408 Migrating from WSC
5.2
1410 <ul class=
"md-nav__list" data-md-scrollfix
>
1416 <li class=
"md-nav__item">
1417 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1428 <li class=
"md-nav__item">
1429 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1430 Templates and Languages
1440 <li class=
"md-nav__item">
1441 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1442 Third Party Libraries
1459 <li class=
"md-nav__item md-nav__item--nested">
1462 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1464 <label class=
"md-nav__link" for=
"__nav_6_3">
1465 Migrating from WSC
3.1
1466 <span class=
"md-nav__icon md-icon"></span>
1468 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1469 <label class=
"md-nav__title" for=
"__nav_6_3">
1470 <span class=
"md-nav__icon md-icon"></span>
1471 Migrating from WSC
3.1
1473 <ul class=
"md-nav__list" data-md-scrollfix
>
1479 <li class=
"md-nav__item">
1480 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1498 <li class=
"md-nav__item md-nav__item--nested">
1501 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1503 <label class=
"md-nav__link" for=
"__nav_6_4">
1504 Migrating from WSC
3.0
1505 <span class=
"md-nav__icon md-icon"></span>
1507 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1508 <label class=
"md-nav__title" for=
"__nav_6_4">
1509 <span class=
"md-nav__icon md-icon"></span>
1510 Migrating from WSC
3.0
1512 <ul class=
"md-nav__list" data-md-scrollfix
>
1518 <li class=
"md-nav__item">
1519 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1530 <li class=
"md-nav__item">
1531 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1542 <li class=
"md-nav__item">
1543 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1554 <li class=
"md-nav__item">
1555 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1566 <li class=
"md-nav__item">
1567 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1585 <li class=
"md-nav__item md-nav__item--nested">
1588 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1590 <label class=
"md-nav__link" for=
"__nav_6_5">
1591 Migrating from WCF
2.1
1592 <span class=
"md-nav__icon md-icon"></span>
1594 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1595 <label class=
"md-nav__title" for=
"__nav_6_5">
1596 <span class=
"md-nav__icon md-icon"></span>
1597 Migrating from WCF
2.1
1599 <ul class=
"md-nav__list" data-md-scrollfix
>
1605 <li class=
"md-nav__item">
1606 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1617 <li class=
"md-nav__item">
1618 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1629 <li class=
"md-nav__item">
1630 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1641 <li class=
"md-nav__item">
1642 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1671 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1674 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" checked
>
1676 <label class=
"md-nav__link" for=
"__nav_7">
1678 <span class=
"md-nav__icon md-icon"></span>
1680 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1681 <label class=
"md-nav__title" for=
"__nav_7">
1682 <span class=
"md-nav__icon md-icon"></span>
1685 <ul class=
"md-nav__list" data-md-scrollfix
>
1694 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1697 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" checked
>
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
>
1716 <li class=
"md-nav__item md-nav__item--active">
1718 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1723 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1735 <li class=
"md-nav__item">
1736 <a href=
"../part_1/" class=
"md-nav__link">
1747 <li class=
"md-nav__item">
1748 <a href=
"../part_2/" class=
"md-nav__link">
1759 <li class=
"md-nav__item">
1760 <a href=
"../part_3/" class=
"md-nav__link">
1787 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1788 <div class=
"md-sidebar__scrollwrap">
1789 <div class=
"md-sidebar__inner">
1791 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1803 <div class=
"md-content" data-md-component=
"content">
1804 <article class=
"md-content__inner md-typeset">
1807 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/tutorial/series/overview.md" title=
"Edit this page" class=
"md-content__button md-icon">
1808 <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>
1812 <h1 id=
"tutorial-series">Tutorial Series
<a class=
"headerlink" href=
"#tutorial-series" title=
"Permanent link">#
</a></h1>
1813 <p>In this tutorial series, we will code a package that allows administrators to create a registry of people.
1814 In this context,
"people" does not refer to users registered on the website but anybody living, dead or fictional.
</p>
1815 <p>We will start this tutorial series by creating a base structure for the package and then continue by adding further features step by step using different APIs.
1816 Note that in the context of this example, not every added feature might make perfect sense but the goal of this tutorial is not to create a useful package but to introduce you to WoltLab Suite.
</p>
1818 <li><a href=
"../part_1/">Part
1: Base Structure
</a></li>
1819 <li><a href=
"../part_2/">Part
2: Event Listeners and Template Listeners
</a></li>
1820 <li><a href=
"../part_3/">Part
3: Person Page and Comments
</a></li>
1827 <div class=
"md-source-date">
1830 Last update:
2021-
01-
15
1849 <footer class=
"md-footer">
1851 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
1853 <a href=
"../../../migration/wcf21/package/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
1854 <div class=
"md-footer__button md-icon">
1855 <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>
1857 <div class=
"md-footer__title">
1858 <div class=
"md-ellipsis">
1859 <span class=
"md-footer__direction">
1868 <a href=
"../part_1/" class=
"md-footer__link md-footer__link--next" rel=
"next">
1869 <div class=
"md-footer__title">
1870 <div class=
"md-ellipsis">
1871 <span class=
"md-footer__direction">
1877 <div class=
"md-footer__button md-icon">
1878 <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>
1884 <div class=
"md-footer-meta md-typeset">
1885 <div class=
"md-footer-meta__inner md-grid">
1886 <div class=
"md-footer-copyright">
1888 <div class=
"md-footer-copyright__highlight">
1889 Copyright ©
2020 WoltLab GmbH
1893 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
1898 <div class=
"md-footer-copyright">
1899 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
1900 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
1907 <div class=
"md-dialog" data-md-component=
"dialog">
1908 <div class=
"md-dialog__inner md-typeset"></div>
1910 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../../assets/javascripts/workers/search.fe42c31b.min.js",
"version": {
"provider":
"mike"}}
</script>
1913 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>