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>Sitemaps - 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">
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=
"#sitemaps" 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">
199 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
202 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" checked
>
204 <label class=
"md-nav__link" for=
"__nav_2">
206 <span class=
"md-nav__icon md-icon"></span>
208 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
209 <label class=
"md-nav__title" for=
"__nav_2">
210 <span class=
"md-nav__icon md-icon"></span>
213 <ul class=
"md-nav__list" data-md-scrollfix
>
219 <li class=
"md-nav__item">
220 <a href=
"../../pages/" class=
"md-nav__link">
231 <li class=
"md-nav__item">
232 <a href=
"../../database-objects/" class=
"md-nav__link">
243 <li class=
"md-nav__item">
244 <a href=
"../../database-access/" class=
"md-nav__link">
255 <li class=
"md-nav__item">
256 <a href=
"../../exceptions/" class=
"md-nav__link">
270 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
273 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" checked
>
275 <label class=
"md-nav__link" for=
"__nav_2_5">
277 <span class=
"md-nav__icon md-icon"></span>
279 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
280 <label class=
"md-nav__title" for=
"__nav_2_5">
281 <span class=
"md-nav__icon md-icon"></span>
284 <ul class=
"md-nav__list" data-md-scrollfix
>
290 <li class=
"md-nav__item">
291 <a href=
"../caches/" class=
"md-nav__link">
302 <li class=
"md-nav__item">
303 <a href=
"../comments/" class=
"md-nav__link">
314 <li class=
"md-nav__item">
315 <a href=
"../cronjobs/" class=
"md-nav__link">
326 <li class=
"md-nav__item">
327 <a href=
"../events/" class=
"md-nav__link">
339 <li class=
"md-nav__item md-nav__item--nested">
342 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
344 <label class=
"md-nav__link" for=
"__nav_2_5_5">
346 <span class=
"md-nav__icon md-icon"></span>
348 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
349 <label class=
"md-nav__title" for=
"__nav_2_5_5">
350 <span class=
"md-nav__icon md-icon"></span>
353 <ul class=
"md-nav__list" data-md-scrollfix
>
359 <li class=
"md-nav__item">
360 <a href=
"../form_builder/overview/" class=
"md-nav__link">
371 <li class=
"md-nav__item">
372 <a href=
"../form_builder/structure/" class=
"md-nav__link">
383 <li class=
"md-nav__item">
384 <a href=
"../form_builder/form_fields/" class=
"md-nav__link">
395 <li class=
"md-nav__item">
396 <a href=
"../form_builder/validation_data/" class=
"md-nav__link">
407 <li class=
"md-nav__item">
408 <a href=
"../form_builder/dependencies/" class=
"md-nav__link">
425 <li class=
"md-nav__item">
426 <a href=
"../package_installation_plugins/" class=
"md-nav__link">
427 Package Installation Plugins
437 <li class=
"md-nav__item">
438 <a href=
"../user_activity_points/" class=
"md-nav__link">
449 <li class=
"md-nav__item">
450 <a href=
"../user_notifications/" class=
"md-nav__link">
463 <li class=
"md-nav__item md-nav__item--active">
465 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
470 <a href=
"./" class=
"md-nav__link md-nav__link--active">
488 <li class=
"md-nav__item">
489 <a href=
"../../code-style/" class=
"md-nav__link">
500 <li class=
"md-nav__item">
501 <a href=
"../../apps/" class=
"md-nav__link">
512 <li class=
"md-nav__item">
513 <a href=
"../../gdpr/" class=
"md-nav__link">
534 <li class=
"md-nav__item md-nav__item--nested">
537 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
539 <label class=
"md-nav__link" for=
"__nav_3">
540 Languages, Templates & CSS
541 <span class=
"md-nav__icon md-icon"></span>
543 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
544 <label class=
"md-nav__title" for=
"__nav_3">
545 <span class=
"md-nav__icon md-icon"></span>
546 Languages, Templates & CSS
548 <ul class=
"md-nav__list" data-md-scrollfix
>
554 <li class=
"md-nav__item">
555 <a href=
"../../../view/languages/" class=
"md-nav__link">
566 <li class=
"md-nav__item">
567 <a href=
"../../../view/templates/" class=
"md-nav__link">
578 <li class=
"md-nav__item">
579 <a href=
"../../../view/css/" class=
"md-nav__link">
600 <li class=
"md-nav__item md-nav__item--nested">
603 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
605 <label class=
"md-nav__link" for=
"__nav_4">
607 <span class=
"md-nav__icon md-icon"></span>
609 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
610 <label class=
"md-nav__title" for=
"__nav_4">
611 <span class=
"md-nav__icon md-icon"></span>
614 <ul class=
"md-nav__list" data-md-scrollfix
>
620 <li class=
"md-nav__item">
621 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
633 <li class=
"md-nav__item md-nav__item--nested">
636 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
638 <label class=
"md-nav__link" for=
"__nav_4_2">
640 <span class=
"md-nav__icon md-icon"></span>
642 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
643 <label class=
"md-nav__title" for=
"__nav_4_2">
644 <span class=
"md-nav__icon md-icon"></span>
647 <ul class=
"md-nav__list" data-md-scrollfix
>
653 <li class=
"md-nav__item">
654 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
665 <li class=
"md-nav__item">
666 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
677 <li class=
"md-nav__item">
678 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
689 <li class=
"md-nav__item">
690 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
701 <li class=
"md-nav__item">
702 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
713 <li class=
"md-nav__item">
714 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
725 <li class=
"md-nav__item">
726 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
737 <li class=
"md-nav__item">
738 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
739 Browser and Screen Sizes
749 <li class=
"md-nav__item">
750 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
767 <li class=
"md-nav__item">
768 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
779 <li class=
"md-nav__item">
780 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
791 <li class=
"md-nav__item">
792 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
813 <li class=
"md-nav__item md-nav__item--nested">
816 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
818 <label class=
"md-nav__link" for=
"__nav_5">
820 <span class=
"md-nav__icon md-icon"></span>
822 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
823 <label class=
"md-nav__title" for=
"__nav_5">
824 <span class=
"md-nav__icon md-icon"></span>
827 <ul class=
"md-nav__list" data-md-scrollfix
>
833 <li class=
"md-nav__item">
834 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
846 <li class=
"md-nav__item md-nav__item--nested">
849 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
851 <label class=
"md-nav__link" for=
"__nav_5_2">
853 <span class=
"md-nav__icon md-icon"></span>
855 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
856 <label class=
"md-nav__title" for=
"__nav_5_2">
857 <span class=
"md-nav__icon md-icon"></span>
860 <ul class=
"md-nav__list" data-md-scrollfix
>
866 <li class=
"md-nav__item">
867 <a href=
"../../../package/pip/" class=
"md-nav__link">
878 <li class=
"md-nav__item">
879 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
890 <li class=
"md-nav__item">
891 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
902 <li class=
"md-nav__item">
903 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
914 <li class=
"md-nav__item">
915 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
926 <li class=
"md-nav__item">
927 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
938 <li class=
"md-nav__item">
939 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
950 <li class=
"md-nav__item">
951 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
962 <li class=
"md-nav__item">
963 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
974 <li class=
"md-nav__item">
975 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
986 <li class=
"md-nav__item">
987 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
998 <li class=
"md-nav__item">
999 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1010 <li class=
"md-nav__item">
1011 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1022 <li class=
"md-nav__item">
1023 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1034 <li class=
"md-nav__item">
1035 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1046 <li class=
"md-nav__item">
1047 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1058 <li class=
"md-nav__item">
1059 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1070 <li class=
"md-nav__item">
1071 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1072 objectTypeDefinition
1082 <li class=
"md-nav__item">
1083 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1094 <li class=
"md-nav__item">
1095 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1106 <li class=
"md-nav__item">
1107 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1118 <li class=
"md-nav__item">
1119 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1130 <li class=
"md-nav__item">
1131 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1142 <li class=
"md-nav__item">
1143 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1154 <li class=
"md-nav__item">
1155 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1166 <li class=
"md-nav__item">
1167 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1178 <li class=
"md-nav__item">
1179 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1190 <li class=
"md-nav__item">
1191 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1202 <li class=
"md-nav__item">
1203 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1214 <li class=
"md-nav__item">
1215 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1216 userNotificationEvent
1226 <li class=
"md-nav__item">
1227 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1238 <li class=
"md-nav__item">
1239 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1256 <li class=
"md-nav__item">
1257 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1278 <li class=
"md-nav__item md-nav__item--nested">
1281 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1283 <label class=
"md-nav__link" for=
"__nav_6">
1285 <span class=
"md-nav__icon md-icon"></span>
1287 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1288 <label class=
"md-nav__title" for=
"__nav_6">
1289 <span class=
"md-nav__icon md-icon"></span>
1292 <ul class=
"md-nav__list" data-md-scrollfix
>
1299 <li class=
"md-nav__item md-nav__item--nested">
1302 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1304 <label class=
"md-nav__link" for=
"__nav_6_1">
1305 Migrating from WSC
5.3
1306 <span class=
"md-nav__icon md-icon"></span>
1308 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1309 <label class=
"md-nav__title" for=
"__nav_6_1">
1310 <span class=
"md-nav__icon md-icon"></span>
1311 Migrating from WSC
5.3
1313 <ul class=
"md-nav__list" data-md-scrollfix
>
1319 <li class=
"md-nav__item">
1320 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1331 <li class=
"md-nav__item">
1332 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1333 Session Handling and Authentication
1343 <li class=
"md-nav__item">
1344 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1355 <li class=
"md-nav__item">
1356 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1367 <li class=
"md-nav__item">
1368 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1369 Third Party Libraries
1386 <li class=
"md-nav__item md-nav__item--nested">
1389 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1391 <label class=
"md-nav__link" for=
"__nav_6_2">
1392 Migrating from WSC
5.2
1393 <span class=
"md-nav__icon md-icon"></span>
1395 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1396 <label class=
"md-nav__title" for=
"__nav_6_2">
1397 <span class=
"md-nav__icon md-icon"></span>
1398 Migrating from WSC
5.2
1400 <ul class=
"md-nav__list" data-md-scrollfix
>
1406 <li class=
"md-nav__item">
1407 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1418 <li class=
"md-nav__item">
1419 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1420 Templates and Languages
1430 <li class=
"md-nav__item">
1431 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1432 Third Party Libraries
1449 <li class=
"md-nav__item md-nav__item--nested">
1452 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1454 <label class=
"md-nav__link" for=
"__nav_6_3">
1455 Migrating from WSC
3.1
1456 <span class=
"md-nav__icon md-icon"></span>
1458 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1459 <label class=
"md-nav__title" for=
"__nav_6_3">
1460 <span class=
"md-nav__icon md-icon"></span>
1461 Migrating from WSC
3.1
1463 <ul class=
"md-nav__list" data-md-scrollfix
>
1469 <li class=
"md-nav__item">
1470 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1488 <li class=
"md-nav__item md-nav__item--nested">
1491 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1493 <label class=
"md-nav__link" for=
"__nav_6_4">
1494 Migrating from WSC
3.0
1495 <span class=
"md-nav__icon md-icon"></span>
1497 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1498 <label class=
"md-nav__title" for=
"__nav_6_4">
1499 <span class=
"md-nav__icon md-icon"></span>
1500 Migrating from WSC
3.0
1502 <ul class=
"md-nav__list" data-md-scrollfix
>
1508 <li class=
"md-nav__item">
1509 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1520 <li class=
"md-nav__item">
1521 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1532 <li class=
"md-nav__item">
1533 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1544 <li class=
"md-nav__item">
1545 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1556 <li class=
"md-nav__item">
1557 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1575 <li class=
"md-nav__item md-nav__item--nested">
1578 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1580 <label class=
"md-nav__link" for=
"__nav_6_5">
1581 Migrating from WCF
2.1
1582 <span class=
"md-nav__icon md-icon"></span>
1584 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1585 <label class=
"md-nav__title" for=
"__nav_6_5">
1586 <span class=
"md-nav__icon md-icon"></span>
1587 Migrating from WCF
2.1
1589 <ul class=
"md-nav__list" data-md-scrollfix
>
1595 <li class=
"md-nav__item">
1596 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1607 <li class=
"md-nav__item">
1608 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1619 <li class=
"md-nav__item">
1620 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1631 <li class=
"md-nav__item">
1632 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1659 <li class=
"md-nav__item md-nav__item--nested">
1662 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1664 <label class=
"md-nav__link" for=
"__nav_7">
1666 <span class=
"md-nav__icon md-icon"></span>
1668 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1669 <label class=
"md-nav__title" for=
"__nav_7">
1670 <span class=
"md-nav__icon md-icon"></span>
1673 <ul class=
"md-nav__list" data-md-scrollfix
>
1680 <li class=
"md-nav__item md-nav__item--nested">
1683 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1685 <label class=
"md-nav__link" for=
"__nav_7_1">
1687 <span class=
"md-nav__icon md-icon"></span>
1689 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1690 <label class=
"md-nav__title" for=
"__nav_7_1">
1691 <span class=
"md-nav__icon md-icon"></span>
1694 <ul class=
"md-nav__list" data-md-scrollfix
>
1700 <li class=
"md-nav__item">
1701 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1712 <li class=
"md-nav__item">
1713 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1724 <li class=
"md-nav__item">
1725 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1736 <li class=
"md-nav__item">
1737 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1764 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1765 <div class=
"md-sidebar__scrollwrap">
1766 <div class=
"md-sidebar__inner">
1768 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1780 <div class=
"md-content" data-md-component=
"content">
1781 <article class=
"md-content__inner md-typeset">
1785 <h1 id=
"sitemaps">Sitemaps
<a class=
"headerlink" href=
"#sitemaps" title=
"Permanent link">#
</a></h1>
1786 <div class=
"admonition warning">
1787 <p class=
"admonition-title">This feature is available with WoltLab Suite
3.1 or newer only.
</p>
1789 <p>Since version
3.1, WoltLab Suite Core is capable of automatically creating a sitemap.
1790 This sitemap contains all static pages registered via the page package installation plugin and which may be indexed by search engines (checking the
<code>allowSpidersToIndex
</code> parameter and page permissions) and do not expect an object ID.
1791 Other pages have to be added to the sitemap as a separate object.
</p>
1792 <p>The only prerequisite for sitemap objects is that the objects are instances of
<code>wcf\data\DatabaseObject
</code> and that there is a
<code>wcf\data\DatabaseObjectList
</code> implementation.
</p>
1793 <p>First, we implement the PHP class, which provides us all database objects and optionally checks the permissions for a single object.
1794 The class must implement the interface
<code>wcf\system\sitemap\object\ISitemapObjectObjectType
</code>.
1795 However, in order to have some methods already implemented and ensure backwards compatibility, you should use the abstract class
<code>wcf\system\sitemap\object\AbstractSitemapObjectObjectType
</code>.
1796 The abstract class takes care of generating the
<code>DatabaseObjectList
</code> class name and list directly and implements optional methods with the default values.
1797 The only method that you have to implement yourself is the
<code>getObjectClass()
</code> method which returns the fully qualified name of the
<code>DatabaseObject
</code> class.
1798 The
<code>DatabaseObject
</code> class must implement the interface
<code>wcf\data\ILinkableObject
</code>.
</p>
1799 <p>Other optional methods are:
</p>
1801 <li>The
<code>getLastModifiedColumn()
</code> method returns the name of the column in the database where the last modification date is stored.
1802 If there is none, this method must return
<code>null
</code>.
</li>
1803 <li>The
<code>canView()
</code> method checks whether the passed
<code>DatabaseObject
</code> is visible to the current user with the current user always being a guest.
</li>
1804 <li>The
<code>getObjectListClass()
</code> method returns a non-standard
<code>DatabaseObjectList
</code> class name.
</li>
1805 <li>The
<code>getObjectList()
</code> method returns the
<code>DatabaseObjectList
</code> instance.
1806 You can, for example, specify additional query conditions in the method.
</li>
1808 <p>As an example, the implementation for users looks like this:
</p>
1809 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
1810 <span class=
"k">namespace
</span> <span class=
"nx">wcf\system\sitemap\object
</span><span class=
"p">;
</span>
1811 <span class=
"k">use
</span> <span class=
"nx">wcf\data\user\User
</span><span class=
"p">;
</span>
1812 <span class=
"k">use
</span> <span class=
"nx">wcf\data\DatabaseObject
</span><span class=
"p">;
</span>
1813 <span class=
"k">use
</span> <span class=
"nx">wcf\system\WCF
</span><span class=
"p">;
</span>
1815 <span class=
"sd">/**
</span>
1816 <span class=
"sd"> * User sitemap implementation.
</span>
1817 <span class=
"sd"> *
</span>
1818 <span class=
"sd"> * @author Joshua Ruesweg
</span>
1819 <span class=
"sd"> * @copyright
2001-
2017 WoltLab GmbH
</span>
1820 <span class=
"sd"> * @license GNU Lesser General Public License
<http://opensource.org/licenses/lgpl-license.php
></span>
1821 <span class=
"sd"> * @package WoltLabSuite\Core\Sitemap\Object
</span>
1822 <span class=
"sd"> * @since
3.1</span>
1823 <span class=
"sd"> */
</span>
1824 <span class=
"k">class
</span> <span class=
"nc">UserSitemapObject
</span> <span class=
"k">extends
</span> <span class=
"nx">AbstractSitemapObjectObjectType
</span> <span class=
"p">{
</span>
1825 <span class=
"sd">/**
</span>
1826 <span class=
"sd"> * @inheritDoc
</span>
1827 <span class=
"sd"> */
</span>
1828 <span class=
"k">public
</span> <span class=
"k">function
</span> <span class=
"nf">getObjectClass
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
1829 <span class=
"k">return
</span> <span class=
"nx">User
</span><span class=
"o">::
</span><span class=
"na">class
</span><span class=
"p">;
</span>
1830 <span class=
"p">}
</span>
1832 <span class=
"sd">/**
</span>
1833 <span class=
"sd"> * @inheritDoc
</span>
1834 <span class=
"sd"> */
</span>
1835 <span class=
"k">public
</span> <span class=
"k">function
</span> <span class=
"nf">getLastModifiedColumn
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
1836 <span class=
"k">return
</span> <span class=
"s1">'lastActivityTime
'</span><span class=
"p">;
</span>
1837 <span class=
"p">}
</span>
1839 <span class=
"sd">/**
</span>
1840 <span class=
"sd"> * @inheritDoc
</span>
1841 <span class=
"sd"> */
</span>
1842 <span class=
"k">public
</span> <span class=
"k">function
</span> <span class=
"nf">canView
</span><span class=
"p">(
</span><span class=
"nx">DatabaseObject
</span> <span class=
"nv">$object
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
1843 <span class=
"k">return
</span> <span class=
"nx">WCF
</span><span class=
"o">::
</span><span class=
"na">getSession
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">getPermission
</span><span class=
"p">(
</span><span class=
"s1">'user.profile.canViewUserProfile
'</span><span class=
"p">);
</span>
1844 <span class=
"p">}
</span>
1845 <span class=
"p">}
</span>
1847 <p>Next, the sitemap object must be registered as an object type:
</p>
1848 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><type
></span>
1849 <span class=
"nt"><name
></span>com.example.plugin.sitemap.object.user
<span class=
"nt"></name
></span>
1850 <span class=
"nt"><definitionname
></span>com.woltlab.wcf.sitemap.object
<span class=
"nt"></definitionname
></span>
1851 <span class=
"nt"><classname
></span>wcf\system\sitemap\object\UserSitemapObject
<span class=
"nt"></classname
></span>
1852 <span class=
"nt"><priority
></span>0.5<span class=
"nt"></priority
></span>
1853 <span class=
"nt"><changeFreq
></span>monthly
<span class=
"nt"></changeFreq
></span>
1854 <span class=
"nt"><rebuildTime
></span>259200<span class=
"nt"></rebuildTime
></span>
1855 <span class=
"nt"></type
></span>
1857 <p>In addition to the fully qualified class name, the object type definition
<code>com.woltlab.wcf.sitemap.object
</code> and the object type name, the parameters
<code>priority
</code>,
<code>changeFreq
</code> and
<code>rebuildTime
</code> must also be specified.
1858 <code>priority
</code> (
<a href=
"https://www.sitemaps.org/protocol.html#prioritydef">https://www.sitemaps.org/protocol.html#prioritydef
</a>) and
<code>changeFreq
</code> (
<a href=
"https://www.sitemaps.org/protocol.html#changefreqdef">https://www.sitemaps.org/protocol.html#changefreqdef
</a>) are specifications in the sitemaps protocol and can be changed by the user in the ACP.
1859 The
<code>priority
</code> should be
<code>0.5</code> by default, unless there is an important reason to change it.
1860 The parameter
<code>rebuildTime
</code> specifies the number of seconds after which the sitemap should be regenerated.
</p>
1861 <p>Finally, you have to create the language variable for the sitemap object.
1862 The language variable follows the pattern
<code>wcf.acp.sitemap.objectType.{objectTypeName}
</code> and is in the category
<code>wcf.acp.sitemap
</code>.
</p>
1876 <footer class=
"md-footer">
1878 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
1880 <a href=
"../user_notifications/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
1881 <div class=
"md-footer__button md-icon">
1882 <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>
1884 <div class=
"md-footer__title">
1885 <div class=
"md-ellipsis">
1886 <span class=
"md-footer__direction">
1895 <a href=
"../../code-style/" class=
"md-footer__link md-footer__link--next" rel=
"next">
1896 <div class=
"md-footer__title">
1897 <div class=
"md-ellipsis">
1898 <span class=
"md-footer__direction">
1904 <div class=
"md-footer__button md-icon">
1905 <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>
1911 <div class=
"md-footer-meta md-typeset">
1912 <div class=
"md-footer-meta__inner md-grid">
1913 <div class=
"md-footer-copyright">
1915 <div class=
"md-footer-copyright__highlight">
1916 Copyright ©
2020 WoltLab GmbH
1920 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
1925 <div class=
"md-footer-copyright">
1926 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
1927 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
1934 <div class=
"md-dialog" data-md-component=
"dialog">
1935 <div class=
"md-dialog__inner md-typeset"></div>
1937 <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>
1940 <script src=
"../../../assets/javascripts/bundle.5cf3e710.min.js"></script>