3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
11 <link rel=
"canonical" href=
"https://docs.woltlab.com/6.0/migration/wsc30/package/">
14 <link rel=
"prev" href=
"../css/">
17 <link rel=
"next" href=
"../../wcf21/php/">
19 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
20 <meta name=
"generator" content=
"mkdocs-1.4.3, mkdocs-material-9.1.15">
24 <title>Package Components - WoltLab Suite Documentation
</title>
28 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.26e3688c.min.css">
31 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ecc896b0.min.css">
41 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
43 <script>__md_scope=new URL(
"../../..",location),__md_hash=e=
>[...e].reduce((e,_)=
>(e<
<5)-e+_.charCodeAt(
0),
0),__md_get=(e,_=localStorage,t=__md_scope)=
>JSON.parse(_.getItem(t.pathname+
"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=
>{try{t.setItem(a.pathname+
"."+e,JSON.stringify(_))}catch(e){}}
</script>
58 <body dir=
"ltr" data-md-color-scheme=
"default" data-md-color-primary=
"teal" data-md-color-accent=
"indigo">
62 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
63 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
64 <label class=
"md-overlay" for=
"__drawer"></label>
65 <div data-md-component=
"skip">
68 <a href=
"#migrating-from-wsc-30-package-components" class=
"md-skip">
73 <div data-md-component=
"announce">
75 <aside class=
"md-banner">
76 <div class=
"md-banner__inner md-grid md-typeset">
79 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
87 <div data-md-color-scheme=
"default" data-md-component=
"outdated" hidden
>
96 <header class=
"md-header md-header--shadow" data-md-component=
"header">
97 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
98 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
100 <img src=
"../../../assets/logo.png" alt=
"logo">
103 <label class=
"md-header__button md-icon" for=
"__drawer">
104 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
106 <div class=
"md-header__title" data-md-component=
"header-title">
107 <div class=
"md-header__ellipsis">
108 <div class=
"md-header__topic">
109 <span class=
"md-ellipsis">
110 WoltLab Suite Documentation
113 <div class=
"md-header__topic" data-md-component=
"header-topic">
114 <span class=
"md-ellipsis">
127 <label class=
"md-header__button md-icon" for=
"__search">
128 <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>
130 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
131 <label class=
"md-search__overlay" for=
"__search"></label>
132 <div class=
"md-search__inner" role=
"search">
133 <form class=
"md-search__form" name=
"search">
134 <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" required
>
135 <label class=
"md-search__icon md-icon" for=
"__search">
136 <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>
137 <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>
139 <nav class=
"md-search__options" aria-label=
"Search">
141 <button type=
"reset" class=
"md-search__icon md-icon" title=
"Clear" aria-label=
"Clear" tabindex=
"-1">
142 <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>
147 <div class=
"md-search__output">
148 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
149 <div class=
"md-search-result" data-md-component=
"search-result">
150 <div class=
"md-search-result__meta">
153 <ol class=
"md-search-result__list" role=
"presentation"></ol>
161 <div class=
"md-header__source">
162 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
163 <div class=
"md-source__icon md-icon">
165 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
167 <div class=
"md-source__repository">
177 <div class=
"md-container" data-md-component=
"container">
184 <main class=
"md-main" data-md-component=
"main">
185 <div class=
"md-main__inner md-grid">
189 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
190 <div class=
"md-sidebar__scrollwrap">
191 <div class=
"md-sidebar__inner">
195 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
196 <label class=
"md-nav__title" for=
"__drawer">
197 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
199 <img src=
"../../../assets/logo.png" alt=
"logo">
202 WoltLab Suite Documentation
205 <div class=
"md-nav__source">
206 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
207 <div class=
"md-source__icon md-icon">
209 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
211 <div class=
"md-source__repository">
217 <ul class=
"md-nav__list" data-md-scrollfix
>
226 <li class=
"md-nav__item">
227 <a href=
"../../../getting-started/" class=
"md-nav__link">
242 <li class=
"md-nav__item md-nav__item--nested">
247 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2" >
251 <label class=
"md-nav__link" for=
"__nav_2" id=
"__nav_2_label" tabindex=
"0">
253 <span class=
"md-nav__icon md-icon"></span>
256 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_2_label" aria-expanded=
"false">
257 <label class=
"md-nav__title" for=
"__nav_2">
258 <span class=
"md-nav__icon md-icon"></span>
261 <ul class=
"md-nav__list" data-md-scrollfix
>
268 <li class=
"md-nav__item">
269 <a href=
"../../../php/pages/" class=
"md-nav__link">
282 <li class=
"md-nav__item">
283 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
296 <li class=
"md-nav__item">
297 <a href=
"../../../php/database-access/" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
325 <li class=
"md-nav__item md-nav__item--nested">
330 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5" >
334 <label class=
"md-nav__link" for=
"__nav_2_5" id=
"__nav_2_5_label" tabindex=
"0">
336 <span class=
"md-nav__icon md-icon"></span>
339 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_2_5_label" aria-expanded=
"false">
340 <label class=
"md-nav__title" for=
"__nav_2_5">
341 <span class=
"md-nav__icon md-icon"></span>
344 <ul class=
"md-nav__list" data-md-scrollfix
>
352 <li class=
"md-nav__item md-nav__item--nested">
357 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5_1" >
361 <label class=
"md-nav__link" for=
"__nav_2_5_1" id=
"__nav_2_5_1_label" tabindex=
"0">
363 <span class=
"md-nav__icon md-icon"></span>
366 <nav class=
"md-nav" data-md-level=
"3" aria-labelledby=
"__nav_2_5_1_label" aria-expanded=
"false">
367 <label class=
"md-nav__title" for=
"__nav_2_5_1">
368 <span class=
"md-nav__icon md-icon"></span>
371 <ul class=
"md-nav__list" data-md-scrollfix
>
378 <li class=
"md-nav__item">
379 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
392 <li class=
"md-nav__item">
393 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
406 <li class=
"md-nav__item">
407 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
427 <li class=
"md-nav__item">
428 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
455 <li class=
"md-nav__item">
456 <a href=
"../../../php/api/events/" class=
"md-nav__link">
470 <li class=
"md-nav__item md-nav__item--nested">
475 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5_5" >
479 <label class=
"md-nav__link" for=
"__nav_2_5_5" id=
"__nav_2_5_5_label" tabindex=
"0">
481 <span class=
"md-nav__icon md-icon"></span>
484 <nav class=
"md-nav" data-md-level=
"3" aria-labelledby=
"__nav_2_5_5_label" aria-expanded=
"false">
485 <label class=
"md-nav__title" for=
"__nav_2_5_5">
486 <span class=
"md-nav__icon md-icon"></span>
489 <ul class=
"md-nav__list" data-md-scrollfix
>
496 <li class=
"md-nav__item">
497 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
510 <li class=
"md-nav__item">
511 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
524 <li class=
"md-nav__item">
525 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
538 <li class=
"md-nav__item">
539 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
552 <li class=
"md-nav__item">
553 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
575 Package Installation Plugins
587 <li class=
"md-nav__item">
588 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
601 <li class=
"md-nav__item">
602 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
615 <li class=
"md-nav__item">
616 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
636 <li class=
"md-nav__item">
637 <a href=
"../../../php/code-style/" class=
"md-nav__link">
650 <li class=
"md-nav__item">
651 <a href=
"../../../php/apps/" class=
"md-nav__link">
664 <li class=
"md-nav__item">
665 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
687 <li class=
"md-nav__item md-nav__item--nested">
692 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_3" >
696 <label class=
"md-nav__link" for=
"__nav_3" id=
"__nav_3_label" tabindex=
"0">
697 Languages, Templates & CSS
698 <span class=
"md-nav__icon md-icon"></span>
701 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_3_label" aria-expanded=
"false">
702 <label class=
"md-nav__title" for=
"__nav_3">
703 <span class=
"md-nav__icon md-icon"></span>
704 Languages, Templates & CSS
706 <ul class=
"md-nav__list" data-md-scrollfix
>
713 <li class=
"md-nav__item">
714 <a href=
"../../../view/languages/" class=
"md-nav__link">
727 <li class=
"md-nav__item">
728 <a href=
"../../../view/templates/" class=
"md-nav__link">
741 <li class=
"md-nav__item">
742 <a href=
"../../../view/template-modifiers/" class=
"md-nav__link">
755 <li class=
"md-nav__item">
756 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
769 <li class=
"md-nav__item">
770 <a href=
"../../../view/css/" class=
"md-nav__link">
792 <li class=
"md-nav__item md-nav__item--nested">
797 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4" >
801 <label class=
"md-nav__link" for=
"__nav_4" id=
"__nav_4_label" tabindex=
"0">
802 TypeScript and JavaScript API
803 <span class=
"md-nav__icon md-icon"></span>
806 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_4_label" aria-expanded=
"false">
807 <label class=
"md-nav__title" for=
"__nav_4">
808 <span class=
"md-nav__icon md-icon"></span>
809 TypeScript and JavaScript API
811 <ul class=
"md-nav__list" data-md-scrollfix
>
818 <li class=
"md-nav__item">
819 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
832 <li class=
"md-nav__item">
833 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
847 <li class=
"md-nav__item md-nav__item--nested">
852 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4_3" >
856 <label class=
"md-nav__link" for=
"__nav_4_3" id=
"__nav_4_3_label" tabindex=
"0">
858 <span class=
"md-nav__icon md-icon"></span>
861 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_4_3_label" aria-expanded=
"false">
862 <label class=
"md-nav__title" for=
"__nav_4_3">
863 <span class=
"md-nav__icon md-icon"></span>
866 <ul class=
"md-nav__list" data-md-scrollfix
>
873 <li class=
"md-nav__item">
874 <a href=
"../../../javascript/components_confirmation/" class=
"md-nav__link">
887 <li class=
"md-nav__item">
888 <a href=
"../../../javascript/components_dialog/" class=
"md-nav__link">
901 <li class=
"md-nav__item">
902 <a href=
"../../../javascript/components_google_maps/" class=
"md-nav__link">
915 <li class=
"md-nav__item">
916 <a href=
"../../../javascript/components_pagination/" class=
"md-nav__link">
937 <li class=
"md-nav__item md-nav__item--nested">
942 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4_4" >
946 <label class=
"md-nav__link" for=
"__nav_4_4" id=
"__nav_4_4_label" tabindex=
"0">
948 <span class=
"md-nav__icon md-icon"></span>
951 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_4_4_label" aria-expanded=
"false">
952 <label class=
"md-nav__title" for=
"__nav_4_4">
953 <span class=
"md-nav__icon md-icon"></span>
956 <ul class=
"md-nav__list" data-md-scrollfix
>
963 <li class=
"md-nav__item">
964 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
977 <li class=
"md-nav__item">
978 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
991 <li class=
"md-nav__item">
992 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
1005 <li class=
"md-nav__item">
1006 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
1019 <li class=
"md-nav__item">
1020 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
1033 <li class=
"md-nav__item">
1034 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
1047 <li class=
"md-nav__item">
1048 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
1049 Browser and Screen Sizes
1061 <li class=
"md-nav__item">
1062 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
1082 <li class=
"md-nav__item">
1083 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
1096 <li class=
"md-nav__item">
1097 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
1119 <li class=
"md-nav__item md-nav__item--nested">
1124 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5" >
1128 <label class=
"md-nav__link" for=
"__nav_5" id=
"__nav_5_label" tabindex=
"0">
1130 <span class=
"md-nav__icon md-icon"></span>
1133 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_5_label" aria-expanded=
"false">
1134 <label class=
"md-nav__title" for=
"__nav_5">
1135 <span class=
"md-nav__icon md-icon"></span>
1138 <ul class=
"md-nav__list" data-md-scrollfix
>
1145 <li class=
"md-nav__item">
1146 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
1160 <li class=
"md-nav__item md-nav__item--nested">
1165 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5_2" >
1169 <label class=
"md-nav__link" for=
"__nav_5_2" id=
"__nav_5_2_label" tabindex=
"0">
1171 <span class=
"md-nav__icon md-icon"></span>
1174 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_5_2_label" aria-expanded=
"false">
1175 <label class=
"md-nav__title" for=
"__nav_5_2">
1176 <span class=
"md-nav__icon md-icon"></span>
1179 <ul class=
"md-nav__list" data-md-scrollfix
>
1186 <li class=
"md-nav__item">
1187 <a href=
"../../../package/pip/" class=
"md-nav__link">
1200 <li class=
"md-nav__item">
1201 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
1214 <li class=
"md-nav__item">
1215 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
1228 <li class=
"md-nav__item">
1229 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
1242 <li class=
"md-nav__item">
1243 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1256 <li class=
"md-nav__item">
1257 <a href=
"../../../package/pip/acp-template-delete/" class=
"md-nav__link">
1270 <li class=
"md-nav__item">
1271 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1284 <li class=
"md-nav__item">
1285 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1298 <li class=
"md-nav__item">
1299 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1312 <li class=
"md-nav__item">
1313 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1326 <li class=
"md-nav__item">
1327 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1340 <li class=
"md-nav__item">
1341 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1354 <li class=
"md-nav__item">
1355 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1368 <li class=
"md-nav__item">
1369 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1382 <li class=
"md-nav__item">
1383 <a href=
"../../../package/pip/file-delete/" class=
"md-nav__link">
1396 <li class=
"md-nav__item">
1397 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1410 <li class=
"md-nav__item">
1411 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1424 <li class=
"md-nav__item">
1425 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1438 <li class=
"md-nav__item">
1439 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1452 <li class=
"md-nav__item">
1453 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1466 <li class=
"md-nav__item">
1467 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1468 objectTypeDefinition
1480 <li class=
"md-nav__item">
1481 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1494 <li class=
"md-nav__item">
1495 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1508 <li class=
"md-nav__item">
1509 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1522 <li class=
"md-nav__item">
1523 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1536 <li class=
"md-nav__item">
1537 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1550 <li class=
"md-nav__item">
1551 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1564 <li class=
"md-nav__item">
1565 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1578 <li class=
"md-nav__item">
1579 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1592 <li class=
"md-nav__item">
1593 <a href=
"../../../package/pip/template-delete/" class=
"md-nav__link">
1606 <li class=
"md-nav__item">
1607 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1620 <li class=
"md-nav__item">
1621 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1634 <li class=
"md-nav__item">
1635 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1648 <li class=
"md-nav__item">
1649 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1650 userNotificationEvent
1662 <li class=
"md-nav__item">
1663 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1676 <li class=
"md-nav__item">
1677 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1697 <li class=
"md-nav__item">
1698 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1722 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1727 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6" checked
>
1731 <label class=
"md-nav__link" for=
"__nav_6" id=
"__nav_6_label" tabindex=
"0">
1733 <span class=
"md-nav__icon md-icon"></span>
1736 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_6_label" aria-expanded=
"true">
1737 <label class=
"md-nav__title" for=
"__nav_6">
1738 <span class=
"md-nav__icon md-icon"></span>
1741 <ul class=
"md-nav__list" data-md-scrollfix
>
1749 <li class=
"md-nav__item md-nav__item--nested">
1754 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_1" >
1758 <label class=
"md-nav__link" for=
"__nav_6_1" id=
"__nav_6_1_label" tabindex=
"0">
1759 From WoltLab Suite
5.5
1760 <span class=
"md-nav__icon md-icon"></span>
1763 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_1_label" aria-expanded=
"false">
1764 <label class=
"md-nav__title" for=
"__nav_6_1">
1765 <span class=
"md-nav__icon md-icon"></span>
1766 From WoltLab Suite
5.5
1768 <ul class=
"md-nav__list" data-md-scrollfix
>
1775 <li class=
"md-nav__item">
1776 <a href=
"../../wsc55/php/" class=
"md-nav__link">
1789 <li class=
"md-nav__item">
1790 <a href=
"../../wsc55/javascript/" class=
"md-nav__link">
1791 TypeScript and JavaScript
1803 <li class=
"md-nav__item">
1804 <a href=
"../../wsc55/templates/" class=
"md-nav__link">
1817 <li class=
"md-nav__item">
1818 <a href=
"../../wsc55/icons/" class=
"md-nav__link">
1831 <li class=
"md-nav__item">
1832 <a href=
"../../wsc55/dialogs/" class=
"md-nav__link">
1845 <li class=
"md-nav__item">
1846 <a href=
"../../wsc55/libraries/" class=
"md-nav__link">
1847 Third Party Libraries
1859 <li class=
"md-nav__item">
1860 <a href=
"../../wsc55/deprecations_removals/" class=
"md-nav__link">
1861 Deprecations and Removals
1881 <li class=
"md-nav__item md-nav__item--nested">
1886 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_2" >
1890 <label class=
"md-nav__link" for=
"__nav_6_2" id=
"__nav_6_2_label" tabindex=
"0">
1891 From WoltLab Suite
5.4
1892 <span class=
"md-nav__icon md-icon"></span>
1895 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_2_label" aria-expanded=
"false">
1896 <label class=
"md-nav__title" for=
"__nav_6_2">
1897 <span class=
"md-nav__icon md-icon"></span>
1898 From WoltLab Suite
5.4
1900 <ul class=
"md-nav__list" data-md-scrollfix
>
1907 <li class=
"md-nav__item">
1908 <a href=
"../../wsc54/php/" class=
"md-nav__link">
1921 <li class=
"md-nav__item">
1922 <a href=
"../../wsc54/javascript/" class=
"md-nav__link">
1923 TypeScript and JavaScript
1935 <li class=
"md-nav__item">
1936 <a href=
"../../wsc54/templates/" class=
"md-nav__link">
1949 <li class=
"md-nav__item">
1950 <a href=
"../../wsc54/libraries/" class=
"md-nav__link">
1951 Third Party Libraries
1963 <li class=
"md-nav__item">
1964 <a href=
"../../wsc54/deprecations_removals/" class=
"md-nav__link">
1965 Deprecations and Removals
1985 <li class=
"md-nav__item md-nav__item--nested">
1990 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_3" >
1994 <label class=
"md-nav__link" for=
"__nav_6_3" id=
"__nav_6_3_label" tabindex=
"0">
1995 From WoltLab Suite
5.3
1996 <span class=
"md-nav__icon md-icon"></span>
1999 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_3_label" aria-expanded=
"false">
2000 <label class=
"md-nav__title" for=
"__nav_6_3">
2001 <span class=
"md-nav__icon md-icon"></span>
2002 From WoltLab Suite
5.3
2004 <ul class=
"md-nav__list" data-md-scrollfix
>
2011 <li class=
"md-nav__item">
2012 <a href=
"../../wsc53/php/" class=
"md-nav__link">
2025 <li class=
"md-nav__item">
2026 <a href=
"../../wsc53/session/" class=
"md-nav__link">
2027 Session Handling and Authentication
2039 <li class=
"md-nav__item">
2040 <a href=
"../../wsc53/javascript/" class=
"md-nav__link">
2041 TypeScript and JavaScript
2053 <li class=
"md-nav__item">
2054 <a href=
"../../wsc53/templates/" class=
"md-nav__link">
2067 <li class=
"md-nav__item">
2068 <a href=
"../../wsc53/libraries/" class=
"md-nav__link">
2069 Third Party Libraries
2089 <li class=
"md-nav__item md-nav__item--nested">
2094 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_4" >
2098 <label class=
"md-nav__link" for=
"__nav_6_4" id=
"__nav_6_4_label" tabindex=
"0">
2099 From WoltLab Suite
5.2
2100 <span class=
"md-nav__icon md-icon"></span>
2103 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_4_label" aria-expanded=
"false">
2104 <label class=
"md-nav__title" for=
"__nav_6_4">
2105 <span class=
"md-nav__icon md-icon"></span>
2106 From WoltLab Suite
5.2
2108 <ul class=
"md-nav__list" data-md-scrollfix
>
2115 <li class=
"md-nav__item">
2116 <a href=
"../../wsc52/php/" class=
"md-nav__link">
2129 <li class=
"md-nav__item">
2130 <a href=
"../../wsc52/templates/" class=
"md-nav__link">
2131 Templates and Languages
2143 <li class=
"md-nav__item">
2144 <a href=
"../../wsc52/libraries/" class=
"md-nav__link">
2145 Third Party Libraries
2165 <li class=
"md-nav__item md-nav__item--nested">
2170 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_5" >
2174 <label class=
"md-nav__link" for=
"__nav_6_5" id=
"__nav_6_5_label" tabindex=
"0">
2175 From WoltLab Suite
3.1
2176 <span class=
"md-nav__icon md-icon"></span>
2179 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_5_label" aria-expanded=
"false">
2180 <label class=
"md-nav__title" for=
"__nav_6_5">
2181 <span class=
"md-nav__icon md-icon"></span>
2182 From WoltLab Suite
3.1
2184 <ul class=
"md-nav__list" data-md-scrollfix
>
2191 <li class=
"md-nav__item">
2192 <a href=
"../../wsc31/php/" class=
"md-nav__link">
2215 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
2220 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_6" checked
>
2224 <label class=
"md-nav__link" for=
"__nav_6_6" id=
"__nav_6_6_label" tabindex=
"0">
2225 From WoltLab Suite
3.0
2226 <span class=
"md-nav__icon md-icon"></span>
2229 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_6_label" aria-expanded=
"true">
2230 <label class=
"md-nav__title" for=
"__nav_6_6">
2231 <span class=
"md-nav__icon md-icon"></span>
2232 From WoltLab Suite
3.0
2234 <ul class=
"md-nav__list" data-md-scrollfix
>
2241 <li class=
"md-nav__item">
2242 <a href=
"../php/" class=
"md-nav__link">
2255 <li class=
"md-nav__item">
2256 <a href=
"../javascript/" class=
"md-nav__link">
2269 <li class=
"md-nav__item">
2270 <a href=
"../templates/" class=
"md-nav__link">
2283 <li class=
"md-nav__item">
2284 <a href=
"../css/" class=
"md-nav__link">
2299 <li class=
"md-nav__item md-nav__item--active">
2301 <input class=
"md-nav__toggle md-toggle" type=
"checkbox" id=
"__toc">
2307 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
2309 <span class=
"md-nav__icon md-icon"></span>
2312 <a href=
"./" class=
"md-nav__link md-nav__link--active">
2318 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2325 <label class=
"md-nav__title" for=
"__toc">
2326 <span class=
"md-nav__icon md-icon"></span>
2329 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2331 <li class=
"md-nav__item">
2332 <a href=
"#cronjob-scheduler-uses-server-timezone" class=
"md-nav__link">
2333 Cronjob Scheduler uses Server Timezone
2338 <li class=
"md-nav__item">
2339 <a href=
"#exclude-pages-from-becoming-a-landing-page" class=
"md-nav__link">
2340 Exclude Pages from becoming a Landing Page
2343 <nav class=
"md-nav" aria-label=
"Exclude Pages from becoming a Landing Page">
2344 <ul class=
"md-nav__list">
2346 <li class=
"md-nav__item">
2347 <a href=
"#example-code" class=
"md-nav__link">
2358 <li class=
"md-nav__item">
2359 <a href=
"#new-package-installation-plugin-for-media-providers" class=
"md-nav__link">
2360 New Package Installation Plugin for Media Providers
2365 <li class=
"md-nav__item">
2366 <a href=
"#limited-forward-compatibility-for-plugins" class=
"md-nav__link">
2367 Limited Forward-Compatibility for Plugins
2394 <li class=
"md-nav__item md-nav__item--nested">
2399 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_7" >
2403 <label class=
"md-nav__link" for=
"__nav_6_7" id=
"__nav_6_7_label" tabindex=
"0">
2405 <span class=
"md-nav__icon md-icon"></span>
2408 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_7_label" aria-expanded=
"false">
2409 <label class=
"md-nav__title" for=
"__nav_6_7">
2410 <span class=
"md-nav__icon md-icon"></span>
2413 <ul class=
"md-nav__list" data-md-scrollfix
>
2420 <li class=
"md-nav__item">
2421 <a href=
"../../wcf21/php/" class=
"md-nav__link">
2434 <li class=
"md-nav__item">
2435 <a href=
"../../wcf21/templates/" class=
"md-nav__link">
2448 <li class=
"md-nav__item">
2449 <a href=
"../../wcf21/css/" class=
"md-nav__link">
2462 <li class=
"md-nav__item">
2463 <a href=
"../../wcf21/package/" class=
"md-nav__link">
2492 <li class=
"md-nav__item md-nav__item--nested">
2497 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7" >
2501 <label class=
"md-nav__link" for=
"__nav_7" id=
"__nav_7_label" tabindex=
"0">
2503 <span class=
"md-nav__icon md-icon"></span>
2506 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_7_label" aria-expanded=
"false">
2507 <label class=
"md-nav__title" for=
"__nav_7">
2508 <span class=
"md-nav__icon md-icon"></span>
2511 <ul class=
"md-nav__list" data-md-scrollfix
>
2519 <li class=
"md-nav__item md-nav__item--nested">
2524 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7_1" >
2528 <label class=
"md-nav__link" for=
"__nav_7_1" id=
"__nav_7_1_label" tabindex=
"0">
2530 <span class=
"md-nav__icon md-icon"></span>
2533 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_7_1_label" aria-expanded=
"false">
2534 <label class=
"md-nav__title" for=
"__nav_7_1">
2535 <span class=
"md-nav__icon md-icon"></span>
2538 <ul class=
"md-nav__list" data-md-scrollfix
>
2545 <li class=
"md-nav__item">
2546 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
2559 <li class=
"md-nav__item">
2560 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
2573 <li class=
"md-nav__item">
2574 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
2587 <li class=
"md-nav__item">
2588 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
2601 <li class=
"md-nav__item">
2602 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
2615 <li class=
"md-nav__item">
2616 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
2629 <li class=
"md-nav__item">
2630 <a href=
"../../../tutorial/series/part_6/" class=
"md-nav__link">
2659 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2660 <div class=
"md-sidebar__scrollwrap">
2661 <div class=
"md-sidebar__inner">
2664 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2671 <label class=
"md-nav__title" for=
"__toc">
2672 <span class=
"md-nav__icon md-icon"></span>
2675 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2677 <li class=
"md-nav__item">
2678 <a href=
"#cronjob-scheduler-uses-server-timezone" class=
"md-nav__link">
2679 Cronjob Scheduler uses Server Timezone
2684 <li class=
"md-nav__item">
2685 <a href=
"#exclude-pages-from-becoming-a-landing-page" class=
"md-nav__link">
2686 Exclude Pages from becoming a Landing Page
2689 <nav class=
"md-nav" aria-label=
"Exclude Pages from becoming a Landing Page">
2690 <ul class=
"md-nav__list">
2692 <li class=
"md-nav__item">
2693 <a href=
"#example-code" class=
"md-nav__link">
2704 <li class=
"md-nav__item">
2705 <a href=
"#new-package-installation-plugin-for-media-providers" class=
"md-nav__link">
2706 New Package Installation Plugin for Media Providers
2711 <li class=
"md-nav__item">
2712 <a href=
"#limited-forward-compatibility-for-plugins" class=
"md-nav__link">
2713 Limited Forward-Compatibility for Plugins
2727 <div class=
"md-content" data-md-component=
"content">
2728 <article class=
"md-content__inner md-typeset">
2736 <h1 id=
"migrating-from-wsc-30-package-components">Migrating from WSC
3.0 - Package Components
<a class=
"headerlink" href=
"#migrating-from-wsc-30-package-components" title=
"Permanent link">#
</a></h1>
2737 <h2 id=
"cronjob-scheduler-uses-server-timezone">Cronjob Scheduler uses Server Timezone
<a class=
"headerlink" href=
"#cronjob-scheduler-uses-server-timezone" title=
"Permanent link">#
</a></h2>
2738 <p>The execution time of cronjobs was previously calculated based on the coordinated universal time (UTC). This was changed in WoltLab Suite
3.1 to use the server timezone or, to be precise, the default timezone set in the administration control panel.
</p>
2739 <h2 id=
"exclude-pages-from-becoming-a-landing-page">Exclude Pages from becoming a Landing Page
<a class=
"headerlink" href=
"#exclude-pages-from-becoming-a-landing-page" title=
"Permanent link">#
</a></h2>
2740 <p>Some pages do not qualify as landing page, because they're designed around specific expectations that aren't matched in all cases. Examples include the user control panel and its sub-pages that cannot be accessed by guests and will therefore break the landing page for those. While it is somewhat to be expected from control panel pages, there are enough pages that fall under the same restrictions, but aren't easily recognized as such by an administrator.
</p>
2741 <p>You can exclude these pages by adding
<code><excludeFromLandingPage
>1</excludeFromLandingPage
></code> (case-sensitive) to the relevant pages in your
<code>page.xml
</code>.
</p>
2742 <h3 id=
"example-code">Example Code
<a class=
"headerlink" href=
"#example-code" title=
"Permanent link">#
</a></h3>
2743 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal"> 1</span>
2744 <span class=
"normal"> 2</span>
2745 <span class=
"normal"> 3</span>
2746 <span class=
"normal"> 4</span>
2747 <span class=
"normal"> 5</span>
2748 <span class=
"normal"> 6</span>
2749 <span class=
"normal"> 7</span>
2750 <span class=
"normal"> 8</span>
2751 <span class=
"normal"> 9</span>
2752 <span class=
"normal">10</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
2753 <span class=
"nt"><data
</span><span class=
"w"> </span><span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span><span class=
"w"> </span><span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span><span class=
"w"> </span><span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/tornado/page.xsd
"</span><span class=
"nt">></span>
2754 <span class=
"w"> </span><span class=
"nt"><import
></span>
2755 <span class=
"w"> </span><span class=
"nt"><page
</span><span class=
"w"> </span><span class=
"na">identifier=
</span><span class=
"s">"com.example.foo.Bar
"</span><span class=
"nt">></span>
2756 <span class=
"w"> </span><span class=
"cm"><!-- ... --
></span>
2757 <span class=
"w"> </span><span class=
"nt"><excludeFromLandingPage
></span>1<span class=
"nt"></excludeFromLandingPage
></span>
2758 <span class=
"w"> </span><span class=
"cm"><!-- ... --
></span>
2759 <span class=
"w"> </span><span class=
"nt"></page
></span>
2760 <span class=
"w"> </span><span class=
"nt"></import
></span>
2761 <span class=
"nt"></data
></span>
2762 </code></pre></div></td></tr></table></div>
2763 <h2 id=
"new-package-installation-plugin-for-media-providers">New Package Installation Plugin for Media Providers
<a class=
"headerlink" href=
"#new-package-installation-plugin-for-media-providers" title=
"Permanent link">#
</a></h2>
2764 <p>Please refer to the documentation of the
<a href=
"../../../package/pip/media-provider/"><code>mediaProvider.xml
</code></a> to learn more.
</p>
2765 <h2 id=
"limited-forward-compatibility-for-plugins">Limited Forward-Compatibility for Plugins
<a class=
"headerlink" href=
"#limited-forward-compatibility-for-plugins" title=
"Permanent link">#
</a></h2>
2766 <p>Please refer to the documentation of the
<a href=
"../../../package/package-xml/#compatibility"><code><compatibility
></code></a> tag in the
<code>package.xml
</code>.
</p>
2769 <div class=
"md-source-file">
2791 <footer class=
"md-footer">
2793 <div class=
"md-footer-meta md-typeset">
2794 <div class=
"md-footer-meta__inner md-grid">
2795 <div class=
"md-copyright">
2797 <div class=
"md-copyright__highlight">
2798 Copyright ©
2020 WoltLab GmbH
2803 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2809 <div class=
"md-copyright">
2810 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2811 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2819 <div class=
"md-dialog" data-md-component=
"dialog">
2820 <div class=
"md-dialog__inner md-typeset"></div>
2823 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [
"navigation.tracking"],
"search":
"../../../assets/javascripts/workers/search.208ed371.min.js",
"translations": {
"clipboard.copied":
"Copied to clipboard",
"clipboard.copy":
"Copy to clipboard",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.placeholder":
"Type to start searching",
"search.result.term.missing":
"Missing",
"select.version":
"Select version"},
"version": {
"provider":
"mike"}}
</script>
2826 <script src=
"../../../assets/javascripts/bundle.b4d07000.min.js"></script>