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.3">
17 <title>page - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.1655a90d.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=
"#page-package-installation-plugin" 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">
197 <li class=
"md-nav__item md-nav__item--nested">
200 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
202 <label class=
"md-nav__link" for=
"__nav_2">
204 <span class=
"md-nav__icon md-icon"></span>
206 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
207 <label class=
"md-nav__title" for=
"__nav_2">
208 <span class=
"md-nav__icon md-icon"></span>
211 <ul class=
"md-nav__list" data-md-scrollfix
>
217 <li class=
"md-nav__item">
218 <a href=
"../../../php/pages/" class=
"md-nav__link">
229 <li class=
"md-nav__item">
230 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
241 <li class=
"md-nav__item">
242 <a href=
"../../../php/database-access/" class=
"md-nav__link">
253 <li class=
"md-nav__item">
254 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
266 <li class=
"md-nav__item md-nav__item--nested">
269 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
271 <label class=
"md-nav__link" for=
"__nav_2_5">
273 <span class=
"md-nav__icon md-icon"></span>
275 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
276 <label class=
"md-nav__title" for=
"__nav_2_5">
277 <span class=
"md-nav__icon md-icon"></span>
280 <ul class=
"md-nav__list" data-md-scrollfix
>
286 <li class=
"md-nav__item">
287 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
298 <li class=
"md-nav__item">
299 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
322 <li class=
"md-nav__item">
323 <a href=
"../../../php/api/events/" class=
"md-nav__link">
335 <li class=
"md-nav__item md-nav__item--nested">
338 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
340 <label class=
"md-nav__link" for=
"__nav_2_5_5">
342 <span class=
"md-nav__icon md-icon"></span>
344 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
345 <label class=
"md-nav__title" for=
"__nav_2_5_5">
346 <span class=
"md-nav__icon md-icon"></span>
349 <ul class=
"md-nav__list" data-md-scrollfix
>
355 <li class=
"md-nav__item">
356 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
367 <li class=
"md-nav__item">
368 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
379 <li class=
"md-nav__item">
380 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
391 <li class=
"md-nav__item">
392 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
403 <li class=
"md-nav__item">
404 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
421 <li class=
"md-nav__item">
422 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
423 Package Installation Plugins
433 <li class=
"md-nav__item">
434 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
445 <li class=
"md-nav__item">
446 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
457 <li class=
"md-nav__item">
458 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
475 <li class=
"md-nav__item">
476 <a href=
"../../../php/code-style/" class=
"md-nav__link">
487 <li class=
"md-nav__item">
488 <a href=
"../../../php/apps/" class=
"md-nav__link">
499 <li class=
"md-nav__item">
500 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
521 <li class=
"md-nav__item md-nav__item--nested">
524 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
526 <label class=
"md-nav__link" for=
"__nav_3">
527 Languages, Templates & CSS
528 <span class=
"md-nav__icon md-icon"></span>
530 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
531 <label class=
"md-nav__title" for=
"__nav_3">
532 <span class=
"md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
535 <ul class=
"md-nav__list" data-md-scrollfix
>
541 <li class=
"md-nav__item">
542 <a href=
"../../../view/languages/" class=
"md-nav__link">
553 <li class=
"md-nav__item">
554 <a href=
"../../../view/templates/" class=
"md-nav__link">
565 <li class=
"md-nav__item">
566 <a href=
"../../../view/css/" class=
"md-nav__link">
587 <li class=
"md-nav__item md-nav__item--nested">
590 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
592 <label class=
"md-nav__link" for=
"__nav_4">
594 <span class=
"md-nav__icon md-icon"></span>
596 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
597 <label class=
"md-nav__title" for=
"__nav_4">
598 <span class=
"md-nav__icon md-icon"></span>
601 <ul class=
"md-nav__list" data-md-scrollfix
>
607 <li class=
"md-nav__item">
608 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
620 <li class=
"md-nav__item md-nav__item--nested">
623 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
625 <label class=
"md-nav__link" for=
"__nav_4_2">
627 <span class=
"md-nav__icon md-icon"></span>
629 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
630 <label class=
"md-nav__title" for=
"__nav_4_2">
631 <span class=
"md-nav__icon md-icon"></span>
634 <ul class=
"md-nav__list" data-md-scrollfix
>
640 <li class=
"md-nav__item">
641 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
652 <li class=
"md-nav__item">
653 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
664 <li class=
"md-nav__item">
665 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
676 <li class=
"md-nav__item">
677 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
688 <li class=
"md-nav__item">
689 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
700 <li class=
"md-nav__item">
701 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
712 <li class=
"md-nav__item">
713 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
724 <li class=
"md-nav__item">
725 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
726 Browser and Screen Sizes
736 <li class=
"md-nav__item">
737 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
754 <li class=
"md-nav__item">
755 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
766 <li class=
"md-nav__item">
767 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
778 <li class=
"md-nav__item">
779 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
802 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
805 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
807 <label class=
"md-nav__link" for=
"__nav_5">
809 <span class=
"md-nav__icon md-icon"></span>
811 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
812 <label class=
"md-nav__title" for=
"__nav_5">
813 <span class=
"md-nav__icon md-icon"></span>
816 <ul class=
"md-nav__list" data-md-scrollfix
>
822 <li class=
"md-nav__item">
823 <a href=
"../../package-xml/" class=
"md-nav__link">
837 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
840 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
842 <label class=
"md-nav__link" for=
"__nav_5_2">
844 <span class=
"md-nav__icon md-icon"></span>
846 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
847 <label class=
"md-nav__title" for=
"__nav_5_2">
848 <span class=
"md-nav__icon md-icon"></span>
851 <ul class=
"md-nav__list" data-md-scrollfix
>
857 <li class=
"md-nav__item">
858 <a href=
"../" class=
"md-nav__link">
869 <li class=
"md-nav__item">
870 <a href=
"../acl-option/" class=
"md-nav__link">
881 <li class=
"md-nav__item">
882 <a href=
"../acp-menu/" class=
"md-nav__link">
893 <li class=
"md-nav__item">
894 <a href=
"../acp-search-provider/" class=
"md-nav__link">
905 <li class=
"md-nav__item">
906 <a href=
"../acp-template/" class=
"md-nav__link">
917 <li class=
"md-nav__item">
918 <a href=
"../bbcode/" class=
"md-nav__link">
929 <li class=
"md-nav__item">
930 <a href=
"../box/" class=
"md-nav__link">
941 <li class=
"md-nav__item">
942 <a href=
"../clipboard-action/" class=
"md-nav__link">
953 <li class=
"md-nav__item">
954 <a href=
"../core-object/" class=
"md-nav__link">
965 <li class=
"md-nav__item">
966 <a href=
"../cronjob/" class=
"md-nav__link">
977 <li class=
"md-nav__item">
978 <a href=
"../event-listener/" class=
"md-nav__link">
989 <li class=
"md-nav__item">
990 <a href=
"../file/" class=
"md-nav__link">
1001 <li class=
"md-nav__item">
1002 <a href=
"../language/" class=
"md-nav__link">
1013 <li class=
"md-nav__item">
1014 <a href=
"../media-provider/" class=
"md-nav__link">
1025 <li class=
"md-nav__item">
1026 <a href=
"../menu/" class=
"md-nav__link">
1037 <li class=
"md-nav__item">
1038 <a href=
"../menu-item/" class=
"md-nav__link">
1049 <li class=
"md-nav__item">
1050 <a href=
"../object-type/" class=
"md-nav__link">
1061 <li class=
"md-nav__item">
1062 <a href=
"../object-type-definition/" class=
"md-nav__link">
1063 objectTypeDefinition
1073 <li class=
"md-nav__item">
1074 <a href=
"../option/" class=
"md-nav__link">
1087 <li class=
"md-nav__item md-nav__item--active">
1089 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1094 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1096 <span class=
"md-nav__icon md-icon"></span>
1099 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1104 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1110 <label class=
"md-nav__title" for=
"__toc">
1111 <span class=
"md-nav__icon md-icon"></span>
1114 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1116 <li class=
"md-nav__item">
1117 <a href=
"#components" class=
"md-nav__link">
1121 <nav class=
"md-nav" aria-label=
"Components">
1122 <ul class=
"md-nav__list">
1124 <li class=
"md-nav__item">
1125 <a href=
"#pagetype" class=
"md-nav__link">
1129 <nav class=
"md-nav" aria-label=
"<pageType>">
1130 <ul class=
"md-nav__list">
1132 <li class=
"md-nav__item">
1133 <a href=
"#system" class=
"md-nav__link">
1139 <li class=
"md-nav__item">
1140 <a href=
"#html-text-or-tpl" class=
"md-nav__link">
1151 <li class=
"md-nav__item">
1152 <a href=
"#controller" class=
"md-nav__link">
1158 <li class=
"md-nav__item">
1159 <a href=
"#handler" class=
"md-nav__link">
1165 <li class=
"md-nav__item">
1166 <a href=
"#name" class=
"md-nav__link">
1172 <li class=
"md-nav__item">
1173 <a href=
"#parent" class=
"md-nav__link">
1179 <li class=
"md-nav__item">
1180 <a href=
"#hasfixedparent" class=
"md-nav__link">
1181 <hasFixedParent
>
1186 <li class=
"md-nav__item">
1187 <a href=
"#permissions" class=
"md-nav__link">
1193 <li class=
"md-nav__item">
1194 <a href=
"#options" class=
"md-nav__link">
1200 <li class=
"md-nav__item">
1201 <a href=
"#excludefromlandingpage" class=
"md-nav__link">
1202 <excludeFromLandingPage
>
1207 <li class=
"md-nav__item">
1208 <a href=
"#content" class=
"md-nav__link">
1212 <nav class=
"md-nav" aria-label=
"<content>">
1213 <ul class=
"md-nav__list">
1215 <li class=
"md-nav__item">
1216 <a href=
"#title" class=
"md-nav__link">
1222 <li class=
"md-nav__item">
1223 <a href=
"#content_1" class=
"md-nav__link">
1239 <li class=
"md-nav__item">
1240 <a href=
"#example" class=
"md-nav__link">
1258 <li class=
"md-nav__item">
1259 <a href=
"../pip/" class=
"md-nav__link">
1270 <li class=
"md-nav__item">
1271 <a href=
"../script/" class=
"md-nav__link">
1282 <li class=
"md-nav__item">
1283 <a href=
"../smiley/" class=
"md-nav__link">
1294 <li class=
"md-nav__item">
1295 <a href=
"../sql/" class=
"md-nav__link">
1306 <li class=
"md-nav__item">
1307 <a href=
"../style/" class=
"md-nav__link">
1318 <li class=
"md-nav__item">
1319 <a href=
"../template/" class=
"md-nav__link">
1330 <li class=
"md-nav__item">
1331 <a href=
"../template-listener/" class=
"md-nav__link">
1342 <li class=
"md-nav__item">
1343 <a href=
"../user-group-option/" class=
"md-nav__link">
1354 <li class=
"md-nav__item">
1355 <a href=
"../user-menu/" class=
"md-nav__link">
1366 <li class=
"md-nav__item">
1367 <a href=
"../user-notification-event/" class=
"md-nav__link">
1368 userNotificationEvent
1378 <li class=
"md-nav__item">
1379 <a href=
"../user-option/" class=
"md-nav__link">
1390 <li class=
"md-nav__item">
1391 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1408 <li class=
"md-nav__item">
1409 <a href=
"../../database-php-api/" class=
"md-nav__link">
1430 <li class=
"md-nav__item md-nav__item--nested">
1433 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1435 <label class=
"md-nav__link" for=
"__nav_6">
1437 <span class=
"md-nav__icon md-icon"></span>
1439 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1440 <label class=
"md-nav__title" for=
"__nav_6">
1441 <span class=
"md-nav__icon md-icon"></span>
1444 <ul class=
"md-nav__list" data-md-scrollfix
>
1451 <li class=
"md-nav__item md-nav__item--nested">
1454 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1456 <label class=
"md-nav__link" for=
"__nav_6_1">
1457 Migrating from WSC
5.3
1458 <span class=
"md-nav__icon md-icon"></span>
1460 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1461 <label class=
"md-nav__title" for=
"__nav_6_1">
1462 <span class=
"md-nav__icon md-icon"></span>
1463 Migrating from WSC
5.3
1465 <ul class=
"md-nav__list" data-md-scrollfix
>
1471 <li class=
"md-nav__item">
1472 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1483 <li class=
"md-nav__item">
1484 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1485 Session Handling and Authentication
1495 <li class=
"md-nav__item">
1496 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1507 <li class=
"md-nav__item">
1508 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1519 <li class=
"md-nav__item">
1520 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1521 Third Party Libraries
1538 <li class=
"md-nav__item md-nav__item--nested">
1541 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1543 <label class=
"md-nav__link" for=
"__nav_6_2">
1544 Migrating from WSC
5.2
1545 <span class=
"md-nav__icon md-icon"></span>
1547 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1548 <label class=
"md-nav__title" for=
"__nav_6_2">
1549 <span class=
"md-nav__icon md-icon"></span>
1550 Migrating from WSC
5.2
1552 <ul class=
"md-nav__list" data-md-scrollfix
>
1558 <li class=
"md-nav__item">
1559 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1570 <li class=
"md-nav__item">
1571 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1572 Templates and Languages
1582 <li class=
"md-nav__item">
1583 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1584 Third Party Libraries
1601 <li class=
"md-nav__item md-nav__item--nested">
1604 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1606 <label class=
"md-nav__link" for=
"__nav_6_3">
1607 Migrating from WSC
3.1
1608 <span class=
"md-nav__icon md-icon"></span>
1610 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1611 <label class=
"md-nav__title" for=
"__nav_6_3">
1612 <span class=
"md-nav__icon md-icon"></span>
1613 Migrating from WSC
3.1
1615 <ul class=
"md-nav__list" data-md-scrollfix
>
1621 <li class=
"md-nav__item">
1622 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1640 <li class=
"md-nav__item md-nav__item--nested">
1643 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1645 <label class=
"md-nav__link" for=
"__nav_6_4">
1646 Migrating from WSC
3.0
1647 <span class=
"md-nav__icon md-icon"></span>
1649 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1650 <label class=
"md-nav__title" for=
"__nav_6_4">
1651 <span class=
"md-nav__icon md-icon"></span>
1652 Migrating from WSC
3.0
1654 <ul class=
"md-nav__list" data-md-scrollfix
>
1660 <li class=
"md-nav__item">
1661 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1672 <li class=
"md-nav__item">
1673 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1684 <li class=
"md-nav__item">
1685 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1696 <li class=
"md-nav__item">
1697 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1708 <li class=
"md-nav__item">
1709 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1727 <li class=
"md-nav__item md-nav__item--nested">
1730 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1732 <label class=
"md-nav__link" for=
"__nav_6_5">
1733 Migrating from WCF
2.1
1734 <span class=
"md-nav__icon md-icon"></span>
1736 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1737 <label class=
"md-nav__title" for=
"__nav_6_5">
1738 <span class=
"md-nav__icon md-icon"></span>
1739 Migrating from WCF
2.1
1741 <ul class=
"md-nav__list" data-md-scrollfix
>
1747 <li class=
"md-nav__item">
1748 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1759 <li class=
"md-nav__item">
1760 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1771 <li class=
"md-nav__item">
1772 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1783 <li class=
"md-nav__item">
1784 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1811 <li class=
"md-nav__item md-nav__item--nested">
1814 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1816 <label class=
"md-nav__link" for=
"__nav_7">
1818 <span class=
"md-nav__icon md-icon"></span>
1820 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1821 <label class=
"md-nav__title" for=
"__nav_7">
1822 <span class=
"md-nav__icon md-icon"></span>
1825 <ul class=
"md-nav__list" data-md-scrollfix
>
1832 <li class=
"md-nav__item md-nav__item--nested">
1835 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1837 <label class=
"md-nav__link" for=
"__nav_7_1">
1839 <span class=
"md-nav__icon md-icon"></span>
1841 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1842 <label class=
"md-nav__title" for=
"__nav_7_1">
1843 <span class=
"md-nav__icon md-icon"></span>
1846 <ul class=
"md-nav__list" data-md-scrollfix
>
1852 <li class=
"md-nav__item">
1853 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1864 <li class=
"md-nav__item">
1865 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1876 <li class=
"md-nav__item">
1877 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1888 <li class=
"md-nav__item">
1889 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1916 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1917 <div class=
"md-sidebar__scrollwrap">
1918 <div class=
"md-sidebar__inner">
1920 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1926 <label class=
"md-nav__title" for=
"__toc">
1927 <span class=
"md-nav__icon md-icon"></span>
1930 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1932 <li class=
"md-nav__item">
1933 <a href=
"#components" class=
"md-nav__link">
1937 <nav class=
"md-nav" aria-label=
"Components">
1938 <ul class=
"md-nav__list">
1940 <li class=
"md-nav__item">
1941 <a href=
"#pagetype" class=
"md-nav__link">
1945 <nav class=
"md-nav" aria-label=
"<pageType>">
1946 <ul class=
"md-nav__list">
1948 <li class=
"md-nav__item">
1949 <a href=
"#system" class=
"md-nav__link">
1955 <li class=
"md-nav__item">
1956 <a href=
"#html-text-or-tpl" class=
"md-nav__link">
1967 <li class=
"md-nav__item">
1968 <a href=
"#controller" class=
"md-nav__link">
1974 <li class=
"md-nav__item">
1975 <a href=
"#handler" class=
"md-nav__link">
1981 <li class=
"md-nav__item">
1982 <a href=
"#name" class=
"md-nav__link">
1988 <li class=
"md-nav__item">
1989 <a href=
"#parent" class=
"md-nav__link">
1995 <li class=
"md-nav__item">
1996 <a href=
"#hasfixedparent" class=
"md-nav__link">
1997 <hasFixedParent
>
2002 <li class=
"md-nav__item">
2003 <a href=
"#permissions" class=
"md-nav__link">
2009 <li class=
"md-nav__item">
2010 <a href=
"#options" class=
"md-nav__link">
2016 <li class=
"md-nav__item">
2017 <a href=
"#excludefromlandingpage" class=
"md-nav__link">
2018 <excludeFromLandingPage
>
2023 <li class=
"md-nav__item">
2024 <a href=
"#content" class=
"md-nav__link">
2028 <nav class=
"md-nav" aria-label=
"<content>">
2029 <ul class=
"md-nav__list">
2031 <li class=
"md-nav__item">
2032 <a href=
"#title" class=
"md-nav__link">
2038 <li class=
"md-nav__item">
2039 <a href=
"#content_1" class=
"md-nav__link">
2055 <li class=
"md-nav__item">
2056 <a href=
"#example" class=
"md-nav__link">
2070 <div class=
"md-content" data-md-component=
"content">
2071 <article class=
"md-content__inner md-typeset">
2075 <h1 id=
"page-package-installation-plugin">Page Package Installation Plugin
<a class=
"headerlink" href=
"#page-package-installation-plugin" title=
"Permanent link">#
</a></h1>
2076 <p>Registers page controllers, making them available for selection and configuration, including but not limited to boxes and menus.
</p>
2077 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
2078 <p>Each item is described as a
<code><page
></code> element with the mandatory attribute
<code>identifier
</code> that should follow the naming pattern
<code><packageIdentifier
>.
<PageName
></code>, e.g.
<code>com.woltlab.wcf.MembersList
</code>.
</p>
2079 <h3 id=
"pagetype"><code><pageType
></code><a class=
"headerlink" href=
"#pagetype" title=
"Permanent link">#
</a></h3>
2080 <h4 id=
"system"><code>system
</code><a class=
"headerlink" href=
"#system" title=
"Permanent link">#
</a></h4>
2081 <p>The special
<code>system
</code> type is reserved for pages that pull their properties and content from a registered PHP class. Requires the
<code><controller
></code> element.
</p>
2082 <h4 id=
"html-text-or-tpl"><code>html
</code>,
<code>text
</code> or
<code>tpl
</code><a class=
"headerlink" href=
"#html-text-or-tpl" title=
"Permanent link">#
</a></h4>
2083 <p>Provide arbitrary content, requires the
<code><content
></code> element.
</p>
2084 <h3 id=
"controller"><code><controller
></code><a class=
"headerlink" href=
"#controller" title=
"Permanent link">#
</a></h3>
2085 <p>Fully qualified class name for the controller, must implement
<code>wcf\page\IPage
</code> or
<code>wcf\form\IForm
</code>.
</p>
2086 <h3 id=
"handler"><code><handler
></code><a class=
"headerlink" href=
"#handler" title=
"Permanent link">#
</a></h3>
2087 <p>Fully qualified class name that can be optionally set to provide additional methods, such as displaying a badge for unread content and verifying permissions per page object id.
</p>
2088 <h3 id=
"name"><code><name
></code><a class=
"headerlink" href=
"#name" title=
"Permanent link">#
</a></h3>
2089 <div class=
"admonition info">
2090 <p class=
"admonition-title">The
<code>language
</code> attribute is required and should specify the
<a href=
"https://en.wikipedia.org/wiki/ISO_639-1">ISO-
639-
1</a> language code.
</p>
2092 <p>The internal name displayed in the admin panel only, can be fully customized by the administrator and is immutable. Only one value is accepted and will be picked based on the site's default language, but you can provide localized values by including multiple
<code><name
></code> elements.
</p>
2093 <h3 id=
"parent"><code><parent
></code><a class=
"headerlink" href=
"#parent" title=
"Permanent link">#
</a></h3>
2094 <p>Sets the default parent page using its internal identifier, this setting controls the breadcrumbs and active menu item hierarchy.
</p>
2095 <h3 id=
"hasfixedparent"><code><hasFixedParent
></code><a class=
"headerlink" href=
"#hasfixedparent" title=
"Permanent link">#
</a></h3>
2096 <p>Pages can be assigned any other page as parent page by default, set to
<code>1</code> to make the parent setting immutable.
</p>
2097 <h3 id=
"permissions"><code><permissions
></code><a class=
"headerlink" href=
"#permissions" title=
"Permanent link">#
</a></h3>
2098 <div class=
"admonition warning">
2099 <p class=
"admonition-title">The comma represents a logical
<code>or
</code>, the check is successful if at least one permission is set.
</p>
2101 <p>Comma separated list of permission names that will be checked one after another until at least one permission is set.
</p>
2102 <h3 id=
"options"><code><options
></code><a class=
"headerlink" href=
"#options" title=
"Permanent link">#
</a></h3>
2103 <div class=
"admonition warning">
2104 <p class=
"admonition-title">The comma represents a logical
<code>or
</code>, the check is successful if at least one option is enabled.
</p>
2106 <p>Comma separated list of options that will be checked one after another until at least one option is set.
</p>
2107 <h3 id=
"excludefromlandingpage"><code><excludeFromLandingPage
></code><a class=
"headerlink" href=
"#excludefromlandingpage" title=
"Permanent link">#
</a></h3>
2108 <p>Some pages should not be used as landing page, because they may not always be
2109 available and/or accessible to the user. For example, the account management
2110 page is available to logged-in users only and any guest attempting to visit that
2111 page would be presented with a permission denied message.
</p>
2112 <p>Set this to
<code>1</code> to prevent this page from becoming a landing page ever.
</p>
2113 <h3 id=
"content"><code><content
></code><a class=
"headerlink" href=
"#content" title=
"Permanent link">#
</a></h3>
2114 <div class=
"admonition info">
2115 <p class=
"admonition-title">The
<code>language
</code> attribute is required and should specify the
<a href=
"https://en.wikipedia.org/wiki/ISO_639-1">ISO-
639-
1</a> language code.
</p>
2117 <h4 id=
"title"><code><title
></code><a class=
"headerlink" href=
"#title" title=
"Permanent link">#
</a></h4>
2118 <p>The title element is required and controls the page title shown to the end users.
</p>
2119 <h4 id=
"content_1"><code><content
></code><a class=
"headerlink" href=
"#content_1" title=
"Permanent link">#
</a></h4>
2120 <p>The content that should be used to populate the page, only used and required if the
<code>pageType
</code> equals
<code>text
</code>,
<code>html
</code> and
<code>tpl
</code>.
</p>
2121 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
2122 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
2123 <span class=
"nt"><data
</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/
2019/page.xsd
"</span><span class=
"nt">></span>
2124 <span class=
"nt"><import
></span>
2125 <span class=
"nt"><page
</span> <span class=
"na">identifier=
</span><span class=
"s">"com.woltlab.wcf.MembersList
"</span><span class=
"nt">></span>
2126 <span class=
"nt"><pageType
></span>system
<span class=
"nt"></pageType
></span>
2127 <span class=
"nt"><controller
></span>wcf\page\MembersListPage
<span class=
"nt"></controller
></span>
2128 <span class=
"nt"><name
</span> <span class=
"na">language=
</span><span class=
"s">"de
"</span><span class=
"nt">></span>Mitglieder
<span class=
"nt"></name
></span>
2129 <span class=
"nt"><name
</span> <span class=
"na">language=
</span><span class=
"s">"en
"</span><span class=
"nt">></span>Members
<span class=
"nt"></name
></span>
2130 <span class=
"nt"><permissions
></span>user.profile.canViewMembersList
<span class=
"nt"></permissions
></span>
2131 <span class=
"nt"><options
></span>module_members_list
<span class=
"nt"></options
></span>
2133 <span class=
"nt"><content
</span> <span class=
"na">language=
</span><span class=
"s">"en
"</span><span class=
"nt">></span>
2134 <span class=
"nt"><title
></span>Members
<span class=
"nt"></title
></span>
2135 <span class=
"nt"></content
></span>
2136 <span class=
"nt"><content
</span> <span class=
"na">language=
</span><span class=
"s">"de
"</span><span class=
"nt">></span>
2137 <span class=
"nt"><title
></span>Mitglieder
<span class=
"nt"></title
></span>
2138 <span class=
"nt"></content
></span>
2139 <span class=
"nt"></page
></span>
2140 <span class=
"nt"></import
></span>
2142 <span class=
"nt"><delete
></span>
2143 <span class=
"nt"><page
</span> <span class=
"na">identifier=
</span><span class=
"s">"com.woltlab.wcf.MembersList
"</span> <span class=
"nt">/
></span>
2144 <span class=
"nt"></delete
></span>
2145 <span class=
"nt"></data
></span>
2160 <footer class=
"md-footer">
2162 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2164 <a href=
"../option/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2165 <div class=
"md-footer__button md-icon">
2166 <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>
2168 <div class=
"md-footer__title">
2169 <div class=
"md-ellipsis">
2170 <span class=
"md-footer__direction">
2179 <a href=
"../pip/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2180 <div class=
"md-footer__title">
2181 <div class=
"md-ellipsis">
2182 <span class=
"md-footer__direction">
2188 <div class=
"md-footer__button md-icon">
2189 <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>
2195 <div class=
"md-footer-meta md-typeset">
2196 <div class=
"md-footer-meta__inner md-grid">
2197 <div class=
"md-footer-copyright">
2199 <div class=
"md-footer-copyright__highlight">
2200 Copyright ©
2020 WoltLab GmbH
2204 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2208 <div class=
"md-footer-copyright">
2209 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2210 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2217 <div class=
"md-dialog" data-md-component=
"dialog">
2218 <div class=
"md-dialog__inner md-typeset"></div>
2220 <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>
2223 <script src=
"../../../assets/javascripts/bundle.ca5457b8.min.js"></script>