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/package/pip/page/">
14 <link rel=
"prev" href=
"../option/">
17 <link rel=
"next" href=
"../pip/">
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>page - 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=
"#page-package-installation-plugin" 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">
1121 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1126 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5" checked
>
1130 <label class=
"md-nav__link" for=
"__nav_5" id=
"__nav_5_label" tabindex=
"0">
1132 <span class=
"md-nav__icon md-icon"></span>
1135 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_5_label" aria-expanded=
"true">
1136 <label class=
"md-nav__title" for=
"__nav_5">
1137 <span class=
"md-nav__icon md-icon"></span>
1140 <ul class=
"md-nav__list" data-md-scrollfix
>
1147 <li class=
"md-nav__item">
1148 <a href=
"../../package-xml/" class=
"md-nav__link">
1164 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1169 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5_2" checked
>
1173 <label class=
"md-nav__link" for=
"__nav_5_2" id=
"__nav_5_2_label" tabindex=
"0">
1175 <span class=
"md-nav__icon md-icon"></span>
1178 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_5_2_label" aria-expanded=
"true">
1179 <label class=
"md-nav__title" for=
"__nav_5_2">
1180 <span class=
"md-nav__icon md-icon"></span>
1183 <ul class=
"md-nav__list" data-md-scrollfix
>
1190 <li class=
"md-nav__item">
1191 <a href=
"../" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../acl-option/" class=
"md-nav__link">
1218 <li class=
"md-nav__item">
1219 <a href=
"../acp-menu/" class=
"md-nav__link">
1232 <li class=
"md-nav__item">
1233 <a href=
"../acp-search-provider/" class=
"md-nav__link">
1246 <li class=
"md-nav__item">
1247 <a href=
"../acp-template/" class=
"md-nav__link">
1260 <li class=
"md-nav__item">
1261 <a href=
"../acp-template-delete/" class=
"md-nav__link">
1274 <li class=
"md-nav__item">
1275 <a href=
"../bbcode/" class=
"md-nav__link">
1288 <li class=
"md-nav__item">
1289 <a href=
"../box/" class=
"md-nav__link">
1302 <li class=
"md-nav__item">
1303 <a href=
"../clipboard-action/" class=
"md-nav__link">
1316 <li class=
"md-nav__item">
1317 <a href=
"../core-object/" class=
"md-nav__link">
1330 <li class=
"md-nav__item">
1331 <a href=
"../cronjob/" class=
"md-nav__link">
1344 <li class=
"md-nav__item">
1345 <a href=
"../database/" class=
"md-nav__link">
1358 <li class=
"md-nav__item">
1359 <a href=
"../event-listener/" class=
"md-nav__link">
1372 <li class=
"md-nav__item">
1373 <a href=
"../file/" class=
"md-nav__link">
1386 <li class=
"md-nav__item">
1387 <a href=
"../file-delete/" class=
"md-nav__link">
1400 <li class=
"md-nav__item">
1401 <a href=
"../language/" class=
"md-nav__link">
1414 <li class=
"md-nav__item">
1415 <a href=
"../media-provider/" class=
"md-nav__link">
1428 <li class=
"md-nav__item">
1429 <a href=
"../menu/" class=
"md-nav__link">
1442 <li class=
"md-nav__item">
1443 <a href=
"../menu-item/" class=
"md-nav__link">
1456 <li class=
"md-nav__item">
1457 <a href=
"../object-type/" class=
"md-nav__link">
1470 <li class=
"md-nav__item">
1471 <a href=
"../object-type-definition/" class=
"md-nav__link">
1472 objectTypeDefinition
1484 <li class=
"md-nav__item">
1485 <a href=
"../option/" class=
"md-nav__link">
1500 <li class=
"md-nav__item md-nav__item--active">
1502 <input class=
"md-nav__toggle md-toggle" type=
"checkbox" id=
"__toc">
1508 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1510 <span class=
"md-nav__icon md-icon"></span>
1513 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1519 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1526 <label class=
"md-nav__title" for=
"__toc">
1527 <span class=
"md-nav__icon md-icon"></span>
1530 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1532 <li class=
"md-nav__item">
1533 <a href=
"#components" class=
"md-nav__link">
1537 <nav class=
"md-nav" aria-label=
"Components">
1538 <ul class=
"md-nav__list">
1540 <li class=
"md-nav__item">
1541 <a href=
"#pagetype" class=
"md-nav__link">
1545 <nav class=
"md-nav" aria-label=
"<pageType>">
1546 <ul class=
"md-nav__list">
1548 <li class=
"md-nav__item">
1549 <a href=
"#system" class=
"md-nav__link">
1555 <li class=
"md-nav__item">
1556 <a href=
"#html-text-or-tpl" class=
"md-nav__link">
1567 <li class=
"md-nav__item">
1568 <a href=
"#controller" class=
"md-nav__link">
1574 <li class=
"md-nav__item">
1575 <a href=
"#handler" class=
"md-nav__link">
1581 <li class=
"md-nav__item">
1582 <a href=
"#name" class=
"md-nav__link">
1588 <li class=
"md-nav__item">
1589 <a href=
"#parent" class=
"md-nav__link">
1595 <li class=
"md-nav__item">
1596 <a href=
"#hasfixedparent" class=
"md-nav__link">
1597 <hasFixedParent
>
1602 <li class=
"md-nav__item">
1603 <a href=
"#permissions" class=
"md-nav__link">
1609 <li class=
"md-nav__item">
1610 <a href=
"#options" class=
"md-nav__link">
1616 <li class=
"md-nav__item">
1617 <a href=
"#excludefromlandingpage" class=
"md-nav__link">
1618 <excludeFromLandingPage
>
1623 <li class=
"md-nav__item">
1624 <a href=
"#requireobjectid" class=
"md-nav__link">
1625 <requireObjectID
>
1630 <li class=
"md-nav__item">
1631 <a href=
"#availableduringofflinemode" class=
"md-nav__link">
1632 <availableDuringOfflineMode
>
1637 <li class=
"md-nav__item">
1638 <a href=
"#allowspiderstoindex" class=
"md-nav__link">
1639 <allowSpidersToIndex
>
1644 <li class=
"md-nav__item">
1645 <a href=
"#cssclassname" class=
"md-nav__link">
1646 <cssClassName
>
1651 <li class=
"md-nav__item">
1652 <a href=
"#content" class=
"md-nav__link">
1656 <nav class=
"md-nav" aria-label=
"<content>">
1657 <ul class=
"md-nav__list">
1659 <li class=
"md-nav__item">
1660 <a href=
"#title" class=
"md-nav__link">
1666 <li class=
"md-nav__item">
1667 <a href=
"#content_1" class=
"md-nav__link">
1683 <li class=
"md-nav__item">
1684 <a href=
"#example" class=
"md-nav__link">
1704 <li class=
"md-nav__item">
1705 <a href=
"../pip/" class=
"md-nav__link">
1718 <li class=
"md-nav__item">
1719 <a href=
"../script/" class=
"md-nav__link">
1732 <li class=
"md-nav__item">
1733 <a href=
"../smiley/" class=
"md-nav__link">
1746 <li class=
"md-nav__item">
1747 <a href=
"../sql/" class=
"md-nav__link">
1760 <li class=
"md-nav__item">
1761 <a href=
"../style/" class=
"md-nav__link">
1774 <li class=
"md-nav__item">
1775 <a href=
"../template/" class=
"md-nav__link">
1788 <li class=
"md-nav__item">
1789 <a href=
"../template-delete/" class=
"md-nav__link">
1802 <li class=
"md-nav__item">
1803 <a href=
"../template-listener/" class=
"md-nav__link">
1816 <li class=
"md-nav__item">
1817 <a href=
"../user-group-option/" class=
"md-nav__link">
1830 <li class=
"md-nav__item">
1831 <a href=
"../user-menu/" class=
"md-nav__link">
1844 <li class=
"md-nav__item">
1845 <a href=
"../user-notification-event/" class=
"md-nav__link">
1846 userNotificationEvent
1858 <li class=
"md-nav__item">
1859 <a href=
"../user-option/" class=
"md-nav__link">
1872 <li class=
"md-nav__item">
1873 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1893 <li class=
"md-nav__item">
1894 <a href=
"../../database-php-api/" class=
"md-nav__link">
1916 <li class=
"md-nav__item md-nav__item--nested">
1921 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6" >
1925 <label class=
"md-nav__link" for=
"__nav_6" id=
"__nav_6_label" tabindex=
"0">
1927 <span class=
"md-nav__icon md-icon"></span>
1930 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_6_label" aria-expanded=
"false">
1931 <label class=
"md-nav__title" for=
"__nav_6">
1932 <span class=
"md-nav__icon md-icon"></span>
1935 <ul class=
"md-nav__list" data-md-scrollfix
>
1943 <li class=
"md-nav__item md-nav__item--nested">
1948 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_1" >
1952 <label class=
"md-nav__link" for=
"__nav_6_1" id=
"__nav_6_1_label" tabindex=
"0">
1953 From WoltLab Suite
5.5
1954 <span class=
"md-nav__icon md-icon"></span>
1957 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_1_label" aria-expanded=
"false">
1958 <label class=
"md-nav__title" for=
"__nav_6_1">
1959 <span class=
"md-nav__icon md-icon"></span>
1960 From WoltLab Suite
5.5
1962 <ul class=
"md-nav__list" data-md-scrollfix
>
1969 <li class=
"md-nav__item">
1970 <a href=
"../../../migration/wsc55/php/" class=
"md-nav__link">
1983 <li class=
"md-nav__item">
1984 <a href=
"../../../migration/wsc55/javascript/" class=
"md-nav__link">
1985 TypeScript and JavaScript
1997 <li class=
"md-nav__item">
1998 <a href=
"../../../migration/wsc55/templates/" class=
"md-nav__link">
2011 <li class=
"md-nav__item">
2012 <a href=
"../../../migration/wsc55/icons/" class=
"md-nav__link">
2025 <li class=
"md-nav__item">
2026 <a href=
"../../../migration/wsc55/dialogs/" class=
"md-nav__link">
2039 <li class=
"md-nav__item">
2040 <a href=
"../../../migration/wsc55/libraries/" class=
"md-nav__link">
2041 Third Party Libraries
2053 <li class=
"md-nav__item">
2054 <a href=
"../../../migration/wsc55/deprecations_removals/" class=
"md-nav__link">
2055 Deprecations and Removals
2075 <li class=
"md-nav__item md-nav__item--nested">
2080 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_2" >
2084 <label class=
"md-nav__link" for=
"__nav_6_2" id=
"__nav_6_2_label" tabindex=
"0">
2085 From WoltLab Suite
5.4
2086 <span class=
"md-nav__icon md-icon"></span>
2089 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_2_label" aria-expanded=
"false">
2090 <label class=
"md-nav__title" for=
"__nav_6_2">
2091 <span class=
"md-nav__icon md-icon"></span>
2092 From WoltLab Suite
5.4
2094 <ul class=
"md-nav__list" data-md-scrollfix
>
2101 <li class=
"md-nav__item">
2102 <a href=
"../../../migration/wsc54/php/" class=
"md-nav__link">
2115 <li class=
"md-nav__item">
2116 <a href=
"../../../migration/wsc54/javascript/" class=
"md-nav__link">
2117 TypeScript and JavaScript
2129 <li class=
"md-nav__item">
2130 <a href=
"../../../migration/wsc54/templates/" class=
"md-nav__link">
2143 <li class=
"md-nav__item">
2144 <a href=
"../../../migration/wsc54/libraries/" class=
"md-nav__link">
2145 Third Party Libraries
2157 <li class=
"md-nav__item">
2158 <a href=
"../../../migration/wsc54/deprecations_removals/" class=
"md-nav__link">
2159 Deprecations and Removals
2179 <li class=
"md-nav__item md-nav__item--nested">
2184 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_3" >
2188 <label class=
"md-nav__link" for=
"__nav_6_3" id=
"__nav_6_3_label" tabindex=
"0">
2189 From WoltLab Suite
5.3
2190 <span class=
"md-nav__icon md-icon"></span>
2193 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_3_label" aria-expanded=
"false">
2194 <label class=
"md-nav__title" for=
"__nav_6_3">
2195 <span class=
"md-nav__icon md-icon"></span>
2196 From WoltLab Suite
5.3
2198 <ul class=
"md-nav__list" data-md-scrollfix
>
2205 <li class=
"md-nav__item">
2206 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
2219 <li class=
"md-nav__item">
2220 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
2221 Session Handling and Authentication
2233 <li class=
"md-nav__item">
2234 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
2235 TypeScript and JavaScript
2247 <li class=
"md-nav__item">
2248 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
2261 <li class=
"md-nav__item">
2262 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
2263 Third Party Libraries
2283 <li class=
"md-nav__item md-nav__item--nested">
2288 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_4" >
2292 <label class=
"md-nav__link" for=
"__nav_6_4" id=
"__nav_6_4_label" tabindex=
"0">
2293 From WoltLab Suite
5.2
2294 <span class=
"md-nav__icon md-icon"></span>
2297 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_4_label" aria-expanded=
"false">
2298 <label class=
"md-nav__title" for=
"__nav_6_4">
2299 <span class=
"md-nav__icon md-icon"></span>
2300 From WoltLab Suite
5.2
2302 <ul class=
"md-nav__list" data-md-scrollfix
>
2309 <li class=
"md-nav__item">
2310 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
2323 <li class=
"md-nav__item">
2324 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
2325 Templates and Languages
2337 <li class=
"md-nav__item">
2338 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
2339 Third Party Libraries
2359 <li class=
"md-nav__item md-nav__item--nested">
2364 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_5" >
2368 <label class=
"md-nav__link" for=
"__nav_6_5" id=
"__nav_6_5_label" tabindex=
"0">
2369 From WoltLab Suite
3.1
2370 <span class=
"md-nav__icon md-icon"></span>
2373 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_5_label" aria-expanded=
"false">
2374 <label class=
"md-nav__title" for=
"__nav_6_5">
2375 <span class=
"md-nav__icon md-icon"></span>
2376 From WoltLab Suite
3.1
2378 <ul class=
"md-nav__list" data-md-scrollfix
>
2385 <li class=
"md-nav__item">
2386 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
2407 <li class=
"md-nav__item md-nav__item--nested">
2412 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_6" >
2416 <label class=
"md-nav__link" for=
"__nav_6_6" id=
"__nav_6_6_label" tabindex=
"0">
2417 From WoltLab Suite
3.0
2418 <span class=
"md-nav__icon md-icon"></span>
2421 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_6_label" aria-expanded=
"false">
2422 <label class=
"md-nav__title" for=
"__nav_6_6">
2423 <span class=
"md-nav__icon md-icon"></span>
2424 From WoltLab Suite
3.0
2426 <ul class=
"md-nav__list" data-md-scrollfix
>
2433 <li class=
"md-nav__item">
2434 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
2447 <li class=
"md-nav__item">
2448 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
2461 <li class=
"md-nav__item">
2462 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
2475 <li class=
"md-nav__item">
2476 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
2489 <li class=
"md-nav__item">
2490 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
2511 <li class=
"md-nav__item md-nav__item--nested">
2516 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_7" >
2520 <label class=
"md-nav__link" for=
"__nav_6_7" id=
"__nav_6_7_label" tabindex=
"0">
2522 <span class=
"md-nav__icon md-icon"></span>
2525 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_7_label" aria-expanded=
"false">
2526 <label class=
"md-nav__title" for=
"__nav_6_7">
2527 <span class=
"md-nav__icon md-icon"></span>
2530 <ul class=
"md-nav__list" data-md-scrollfix
>
2537 <li class=
"md-nav__item">
2538 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
2551 <li class=
"md-nav__item">
2552 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
2565 <li class=
"md-nav__item">
2566 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
2579 <li class=
"md-nav__item">
2580 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
2609 <li class=
"md-nav__item md-nav__item--nested">
2614 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7" >
2618 <label class=
"md-nav__link" for=
"__nav_7" id=
"__nav_7_label" tabindex=
"0">
2620 <span class=
"md-nav__icon md-icon"></span>
2623 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_7_label" aria-expanded=
"false">
2624 <label class=
"md-nav__title" for=
"__nav_7">
2625 <span class=
"md-nav__icon md-icon"></span>
2628 <ul class=
"md-nav__list" data-md-scrollfix
>
2636 <li class=
"md-nav__item md-nav__item--nested">
2641 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7_1" >
2645 <label class=
"md-nav__link" for=
"__nav_7_1" id=
"__nav_7_1_label" tabindex=
"0">
2647 <span class=
"md-nav__icon md-icon"></span>
2650 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_7_1_label" aria-expanded=
"false">
2651 <label class=
"md-nav__title" for=
"__nav_7_1">
2652 <span class=
"md-nav__icon md-icon"></span>
2655 <ul class=
"md-nav__list" data-md-scrollfix
>
2662 <li class=
"md-nav__item">
2663 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
2676 <li class=
"md-nav__item">
2677 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
2690 <li class=
"md-nav__item">
2691 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
2704 <li class=
"md-nav__item">
2705 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
2718 <li class=
"md-nav__item">
2719 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
2732 <li class=
"md-nav__item">
2733 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
2746 <li class=
"md-nav__item">
2747 <a href=
"../../../tutorial/series/part_6/" class=
"md-nav__link">
2776 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2777 <div class=
"md-sidebar__scrollwrap">
2778 <div class=
"md-sidebar__inner">
2781 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2788 <label class=
"md-nav__title" for=
"__toc">
2789 <span class=
"md-nav__icon md-icon"></span>
2792 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2794 <li class=
"md-nav__item">
2795 <a href=
"#components" class=
"md-nav__link">
2799 <nav class=
"md-nav" aria-label=
"Components">
2800 <ul class=
"md-nav__list">
2802 <li class=
"md-nav__item">
2803 <a href=
"#pagetype" class=
"md-nav__link">
2807 <nav class=
"md-nav" aria-label=
"<pageType>">
2808 <ul class=
"md-nav__list">
2810 <li class=
"md-nav__item">
2811 <a href=
"#system" class=
"md-nav__link">
2817 <li class=
"md-nav__item">
2818 <a href=
"#html-text-or-tpl" class=
"md-nav__link">
2829 <li class=
"md-nav__item">
2830 <a href=
"#controller" class=
"md-nav__link">
2836 <li class=
"md-nav__item">
2837 <a href=
"#handler" class=
"md-nav__link">
2843 <li class=
"md-nav__item">
2844 <a href=
"#name" class=
"md-nav__link">
2850 <li class=
"md-nav__item">
2851 <a href=
"#parent" class=
"md-nav__link">
2857 <li class=
"md-nav__item">
2858 <a href=
"#hasfixedparent" class=
"md-nav__link">
2859 <hasFixedParent
>
2864 <li class=
"md-nav__item">
2865 <a href=
"#permissions" class=
"md-nav__link">
2871 <li class=
"md-nav__item">
2872 <a href=
"#options" class=
"md-nav__link">
2878 <li class=
"md-nav__item">
2879 <a href=
"#excludefromlandingpage" class=
"md-nav__link">
2880 <excludeFromLandingPage
>
2885 <li class=
"md-nav__item">
2886 <a href=
"#requireobjectid" class=
"md-nav__link">
2887 <requireObjectID
>
2892 <li class=
"md-nav__item">
2893 <a href=
"#availableduringofflinemode" class=
"md-nav__link">
2894 <availableDuringOfflineMode
>
2899 <li class=
"md-nav__item">
2900 <a href=
"#allowspiderstoindex" class=
"md-nav__link">
2901 <allowSpidersToIndex
>
2906 <li class=
"md-nav__item">
2907 <a href=
"#cssclassname" class=
"md-nav__link">
2908 <cssClassName
>
2913 <li class=
"md-nav__item">
2914 <a href=
"#content" class=
"md-nav__link">
2918 <nav class=
"md-nav" aria-label=
"<content>">
2919 <ul class=
"md-nav__list">
2921 <li class=
"md-nav__item">
2922 <a href=
"#title" class=
"md-nav__link">
2928 <li class=
"md-nav__item">
2929 <a href=
"#content_1" class=
"md-nav__link">
2945 <li class=
"md-nav__item">
2946 <a href=
"#example" class=
"md-nav__link">
2961 <div class=
"md-content" data-md-component=
"content">
2962 <article class=
"md-content__inner md-typeset">
2970 <h1 id=
"page-package-installation-plugin">Page Package Installation Plugin
<a class=
"headerlink" href=
"#page-package-installation-plugin" title=
"Permanent link">#
</a></h1>
2971 <p>Registers page controllers, making them available for selection and configuration, including but not limited to boxes and menus.
</p>
2972 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
2973 <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>
2974 <h3 id=
"pagetype"><code><pageType
></code><a class=
"headerlink" href=
"#pagetype" title=
"Permanent link">#
</a></h3>
2975 <h4 id=
"system"><code>system
</code><a class=
"headerlink" href=
"#system" title=
"Permanent link">#
</a></h4>
2976 <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>
2977 <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>
2978 <p>Provide arbitrary content, requires the
<code><content
></code> element.
</p>
2979 <h3 id=
"controller"><code><controller
></code><a class=
"headerlink" href=
"#controller" title=
"Permanent link">#
</a></h3>
2980 <p>Fully qualified class name for the controller, must implement
<code>wcf\page\IPage
</code> or
<code>wcf\form\IForm
</code>.
</p>
2981 <h3 id=
"handler"><code><handler
></code><a class=
"headerlink" href=
"#handler" title=
"Permanent link">#
</a></h3>
2982 <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>
2983 <h3 id=
"name"><code><name
></code><a class=
"headerlink" href=
"#name" title=
"Permanent link">#
</a></h3>
2984 <div class=
"admonition info">
2985 <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>
2987 <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>
2988 <h3 id=
"parent"><code><parent
></code><a class=
"headerlink" href=
"#parent" title=
"Permanent link">#
</a></h3>
2989 <p>Sets the default parent page using its internal identifier, this setting controls the breadcrumbs and active menu item hierarchy.
</p>
2990 <h3 id=
"hasfixedparent"><code><hasFixedParent
></code><a class=
"headerlink" href=
"#hasfixedparent" title=
"Permanent link">#
</a></h3>
2991 <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>
2992 <h3 id=
"permissions"><code><permissions
></code><a class=
"headerlink" href=
"#permissions" title=
"Permanent link">#
</a></h3>
2993 <div class=
"admonition warning">
2994 <p class=
"admonition-title">The comma represents a logical
<code>or
</code>, the check is successful if at least one permission is set.
</p>
2996 <p>Comma separated list of permission names that will be checked one after another until at least one permission is set.
</p>
2997 <h3 id=
"options"><code><options
></code><a class=
"headerlink" href=
"#options" title=
"Permanent link">#
</a></h3>
2998 <div class=
"admonition warning">
2999 <p class=
"admonition-title">The comma represents a logical
<code>or
</code>, the check is successful if at least one option is enabled.
</p>
3001 <p>Comma separated list of options that will be checked one after another until at least one option is set.
</p>
3002 <h3 id=
"excludefromlandingpage"><code><excludeFromLandingPage
></code><a class=
"headerlink" href=
"#excludefromlandingpage" title=
"Permanent link">#
</a></h3>
3003 <p>Some pages should not be used as landing page, because they may not always be
3004 available and/or accessible to the user. For example, the account management
3005 page is available to logged-in users only and any guest attempting to visit that
3006 page would be presented with a permission denied message.
</p>
3007 <p>Set this to
<code>1</code> to prevent this page from becoming a landing page ever.
</p>
3008 <h3 id=
"requireobjectid"><code><requireObjectID
></code><a class=
"headerlink" href=
"#requireobjectid" title=
"Permanent link">#
</a></h3>
3009 <p>If the page requires an id of a specific object, like the user profile page requires the id of the user whose profile page is requested,
<code><requireObjectID
>1</requireObjectID
></code> has to be added.
3010 If this item is not present,
<code>requireObjectID
</code> defaults to
<code>0</code>.
</p>
3011 <h3 id=
"availableduringofflinemode"><code><availableDuringOfflineMode
></code><a class=
"headerlink" href=
"#availableduringofflinemode" title=
"Permanent link">#
</a></h3>
3012 <p>During offline mode, most pages should generally not be available.
3013 Certain pages, however, might still have to be accessible due to, for example, legal reasons.
3014 To make a page available during offline mode,
<code><availableDuringOfflineMode
>1</availableDuringOfflineMode
></code> has to be added.
3015 If this item is not present,
<code>availableDuringOfflineMode
</code> defaults to
<code>0</code>.
</p>
3016 <h3 id=
"allowspiderstoindex"><code><allowSpidersToIndex
></code><a class=
"headerlink" href=
"#allowspiderstoindex" title=
"Permanent link">#
</a></h3>
3017 <p>Administrators are able to set in the admin panel for each page, whether or not spiders are allowed to index it.
3018 The default value for this option can be set with the
<code>allowSpidersToIndex
</code> item whose value defaults to
<code>0</code>.
</p>
3019 <h3 id=
"cssclassname"><code><cssClassName
></code><a class=
"headerlink" href=
"#cssclassname" title=
"Permanent link">#
</a></h3>
3020 <p>To add custom CSS classes to a page’s
<code><body
></code> HTML element, you can specify them via the
<code>cssClassName
</code> item.
</p>
3021 <div class=
"admonition info">
3022 <p class=
"admonition-title">If you want to add multiple CSS classes, separate them with spaces!
</p>
3024 <h3 id=
"content"><code><content
></code><a class=
"headerlink" href=
"#content" title=
"Permanent link">#
</a></h3>
3025 <div class=
"admonition info">
3026 <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>
3028 <h4 id=
"title"><code><title
></code><a class=
"headerlink" href=
"#title" title=
"Permanent link">#
</a></h4>
3029 <p>The title element is required and controls the page title shown to the end users.
</p>
3030 <h4 id=
"content_1"><code><content
></code><a class=
"headerlink" href=
"#content_1" title=
"Permanent link">#
</a></h4>
3031 <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>
3032 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
3033 <div class=
"highlight"><table class=
"highlighttable"><tr><th colspan=
"2" class=
"filename"><span class=
"filename">page.xml
<a class=
"codeBoxTitleGitHubLink" href=
"https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/package/pip/page.xml" title=
"View on GitHub"><span class=
"twemoji"><svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal"> 1</span>
3034 <span class=
"normal"> 2</span>
3035 <span class=
"normal"> 3</span>
3036 <span class=
"normal"> 4</span>
3037 <span class=
"normal"> 5</span>
3038 <span class=
"normal"> 6</span>
3039 <span class=
"normal"> 7</span>
3040 <span class=
"normal"> 8</span>
3041 <span class=
"normal"> 9</span>
3042 <span class=
"normal">10</span>
3043 <span class=
"normal">11</span>
3044 <span class=
"normal">12</span>
3045 <span class=
"normal">13</span>
3046 <span class=
"normal">14</span>
3047 <span class=
"normal">15</span>
3048 <span class=
"normal">16</span>
3049 <span class=
"normal">17</span>
3050 <span class=
"normal">18</span>
3051 <span class=
"normal">19</span>
3052 <span class=
"normal">20</span>
3053 <span class=
"normal">21</span>
3054 <span class=
"normal">22</span>
3055 <span class=
"normal">23</span>
3056 <span class=
"normal">24</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
3057 <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/
2019/page.xsd
"</span><span class=
"nt">></span>
3058 <span class=
"w"> </span><span class=
"nt"><import
></span>
3059 <span class=
"w"> </span><span class=
"nt"><page
</span><span class=
"w"> </span><span class=
"na">identifier=
</span><span class=
"s">"com.woltlab.wcf.MembersList
"</span><span class=
"nt">></span>
3060 <span class=
"w"> </span><span class=
"nt"><pageType
></span>system
<span class=
"nt"></pageType
></span>
3061 <span class=
"w"> </span><span class=
"nt"><controller
></span>wcf\page\MembersListPage
<span class=
"nt"></controller
></span>
3062 <span class=
"w"> </span><span class=
"nt"><name
</span><span class=
"w"> </span><span class=
"na">language=
</span><span class=
"s">"de
"</span><span class=
"nt">></span>Mitglieder
<span class=
"nt"></name
></span>
3063 <span class=
"w"> </span><span class=
"nt"><name
</span><span class=
"w"> </span><span class=
"na">language=
</span><span class=
"s">"en
"</span><span class=
"nt">></span>Members
<span class=
"nt"></name
></span>
3064 <span class=
"w"> </span><span class=
"nt"><options
></span>module_members_list
<span class=
"nt"></options
></span>
3065 <span class=
"w"> </span><span class=
"nt"><permissions
></span>user.profile.canViewMembersList
<span class=
"nt"></permissions
></span>
3066 <span class=
"w"> </span><span class=
"nt"><allowSpidersToIndex
></span>1<span class=
"nt"></allowSpidersToIndex
></span>
3067 <span class=
"w"> </span><span class=
"nt"><content
</span><span class=
"w"> </span><span class=
"na">language=
</span><span class=
"s">"en
"</span><span class=
"nt">></span>
3068 <span class=
"w"> </span><span class=
"nt"><title
></span>Members
<span class=
"nt"></title
></span>
3069 <span class=
"w"> </span><span class=
"nt"></content
></span>
3070 <span class=
"w"> </span><span class=
"nt"><content
</span><span class=
"w"> </span><span class=
"na">language=
</span><span class=
"s">"de
"</span><span class=
"nt">></span>
3071 <span class=
"w"> </span><span class=
"nt"><title
></span>Mitglieder
<span class=
"nt"></title
></span>
3072 <span class=
"w"> </span><span class=
"nt"></content
></span>
3073 <span class=
"w"> </span><span class=
"nt"></page
></span>
3074 <span class=
"w"> </span><span class=
"nt"></import
></span>
3076 <span class=
"w"> </span><span class=
"nt"><delete
></span>
3077 <span class=
"w"> </span><span class=
"nt"><page
</span><span class=
"w"> </span><span class=
"na">identifier=
</span><span class=
"s">"com.woltlab.wcf.MembersList
"</span><span class=
"w"> </span><span class=
"nt">/
></span>
3078 <span class=
"w"> </span><span class=
"nt"></delete
></span>
3079 <span class=
"nt"></data
></span>
3080 </code></pre></div></td></tr></table></div>
3083 <div class=
"md-source-file">
3105 <footer class=
"md-footer">
3107 <div class=
"md-footer-meta md-typeset">
3108 <div class=
"md-footer-meta__inner md-grid">
3109 <div class=
"md-copyright">
3111 <div class=
"md-copyright__highlight">
3112 Copyright ©
2020 WoltLab GmbH
3117 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
3123 <div class=
"md-copyright">
3124 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
3125 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
3133 <div class=
"md-dialog" data-md-component=
"dialog">
3134 <div class=
"md-dialog__inner md-typeset"></div>
3137 <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>
3140 <script src=
"../../../assets/javascripts/bundle.b4d07000.min.js"></script>