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/template/">
14 <link rel=
"prev" href=
"../style/">
17 <link rel=
"next" href=
"../template-delete/">
19 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
20 <meta name=
"generator" content=
"mkdocs-1.4.3, mkdocs-material-9.1.17">
24 <title>template - 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=
"#template-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">
1498 <li class=
"md-nav__item">
1499 <a href=
"../page/" class=
"md-nav__link">
1512 <li class=
"md-nav__item">
1513 <a href=
"../pip/" class=
"md-nav__link">
1526 <li class=
"md-nav__item">
1527 <a href=
"../script/" class=
"md-nav__link">
1540 <li class=
"md-nav__item">
1541 <a href=
"../smiley/" class=
"md-nav__link">
1554 <li class=
"md-nav__item">
1555 <a href=
"../sql/" class=
"md-nav__link">
1568 <li class=
"md-nav__item">
1569 <a href=
"../style/" class=
"md-nav__link">
1584 <li class=
"md-nav__item md-nav__item--active">
1586 <input class=
"md-nav__toggle md-toggle" type=
"checkbox" id=
"__toc">
1592 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1606 <li class=
"md-nav__item">
1607 <a href=
"../template-delete/" class=
"md-nav__link">
1620 <li class=
"md-nav__item">
1621 <a href=
"../template-listener/" class=
"md-nav__link">
1634 <li class=
"md-nav__item">
1635 <a href=
"../user-group-option/" class=
"md-nav__link">
1648 <li class=
"md-nav__item">
1649 <a href=
"../user-menu/" class=
"md-nav__link">
1662 <li class=
"md-nav__item">
1663 <a href=
"../user-notification-event/" class=
"md-nav__link">
1664 userNotificationEvent
1676 <li class=
"md-nav__item">
1677 <a href=
"../user-option/" class=
"md-nav__link">
1690 <li class=
"md-nav__item">
1691 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1711 <li class=
"md-nav__item">
1712 <a href=
"../../database-php-api/" class=
"md-nav__link">
1734 <li class=
"md-nav__item md-nav__item--nested">
1739 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6" >
1743 <label class=
"md-nav__link" for=
"__nav_6" id=
"__nav_6_label" tabindex=
"0">
1745 <span class=
"md-nav__icon md-icon"></span>
1748 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_6_label" aria-expanded=
"false">
1749 <label class=
"md-nav__title" for=
"__nav_6">
1750 <span class=
"md-nav__icon md-icon"></span>
1753 <ul class=
"md-nav__list" data-md-scrollfix
>
1761 <li class=
"md-nav__item md-nav__item--nested">
1766 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_1" >
1770 <label class=
"md-nav__link" for=
"__nav_6_1" id=
"__nav_6_1_label" tabindex=
"0">
1771 From WoltLab Suite
5.5
1772 <span class=
"md-nav__icon md-icon"></span>
1775 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_1_label" aria-expanded=
"false">
1776 <label class=
"md-nav__title" for=
"__nav_6_1">
1777 <span class=
"md-nav__icon md-icon"></span>
1778 From WoltLab Suite
5.5
1780 <ul class=
"md-nav__list" data-md-scrollfix
>
1787 <li class=
"md-nav__item">
1788 <a href=
"../../../migration/wsc55/php/" class=
"md-nav__link">
1801 <li class=
"md-nav__item">
1802 <a href=
"../../../migration/wsc55/javascript/" class=
"md-nav__link">
1803 TypeScript and JavaScript
1815 <li class=
"md-nav__item">
1816 <a href=
"../../../migration/wsc55/templates/" class=
"md-nav__link">
1829 <li class=
"md-nav__item">
1830 <a href=
"../../../migration/wsc55/icons/" class=
"md-nav__link">
1843 <li class=
"md-nav__item">
1844 <a href=
"../../../migration/wsc55/dialogs/" class=
"md-nav__link">
1857 <li class=
"md-nav__item">
1858 <a href=
"../../../migration/wsc55/libraries/" class=
"md-nav__link">
1859 Third Party Libraries
1871 <li class=
"md-nav__item">
1872 <a href=
"../../../migration/wsc55/deprecations_removals/" class=
"md-nav__link">
1873 Deprecations and Removals
1893 <li class=
"md-nav__item md-nav__item--nested">
1898 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_2" >
1902 <label class=
"md-nav__link" for=
"__nav_6_2" id=
"__nav_6_2_label" tabindex=
"0">
1903 From WoltLab Suite
5.4
1904 <span class=
"md-nav__icon md-icon"></span>
1907 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_2_label" aria-expanded=
"false">
1908 <label class=
"md-nav__title" for=
"__nav_6_2">
1909 <span class=
"md-nav__icon md-icon"></span>
1910 From WoltLab Suite
5.4
1912 <ul class=
"md-nav__list" data-md-scrollfix
>
1919 <li class=
"md-nav__item">
1920 <a href=
"../../../migration/wsc54/php/" class=
"md-nav__link">
1933 <li class=
"md-nav__item">
1934 <a href=
"../../../migration/wsc54/javascript/" class=
"md-nav__link">
1935 TypeScript and JavaScript
1947 <li class=
"md-nav__item">
1948 <a href=
"../../../migration/wsc54/templates/" class=
"md-nav__link">
1961 <li class=
"md-nav__item">
1962 <a href=
"../../../migration/wsc54/libraries/" class=
"md-nav__link">
1963 Third Party Libraries
1975 <li class=
"md-nav__item">
1976 <a href=
"../../../migration/wsc54/deprecations_removals/" class=
"md-nav__link">
1977 Deprecations and Removals
1997 <li class=
"md-nav__item md-nav__item--nested">
2002 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_3" >
2006 <label class=
"md-nav__link" for=
"__nav_6_3" id=
"__nav_6_3_label" tabindex=
"0">
2007 From WoltLab Suite
5.3
2008 <span class=
"md-nav__icon md-icon"></span>
2011 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_3_label" aria-expanded=
"false">
2012 <label class=
"md-nav__title" for=
"__nav_6_3">
2013 <span class=
"md-nav__icon md-icon"></span>
2014 From WoltLab Suite
5.3
2016 <ul class=
"md-nav__list" data-md-scrollfix
>
2023 <li class=
"md-nav__item">
2024 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
2037 <li class=
"md-nav__item">
2038 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
2039 Session Handling and Authentication
2051 <li class=
"md-nav__item">
2052 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
2053 TypeScript and JavaScript
2065 <li class=
"md-nav__item">
2066 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
2079 <li class=
"md-nav__item">
2080 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
2081 Third Party Libraries
2101 <li class=
"md-nav__item md-nav__item--nested">
2106 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_4" >
2110 <label class=
"md-nav__link" for=
"__nav_6_4" id=
"__nav_6_4_label" tabindex=
"0">
2111 From WoltLab Suite
5.2
2112 <span class=
"md-nav__icon md-icon"></span>
2115 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_4_label" aria-expanded=
"false">
2116 <label class=
"md-nav__title" for=
"__nav_6_4">
2117 <span class=
"md-nav__icon md-icon"></span>
2118 From WoltLab Suite
5.2
2120 <ul class=
"md-nav__list" data-md-scrollfix
>
2127 <li class=
"md-nav__item">
2128 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
2141 <li class=
"md-nav__item">
2142 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
2143 Templates and Languages
2155 <li class=
"md-nav__item">
2156 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
2157 Third Party Libraries
2177 <li class=
"md-nav__item md-nav__item--nested">
2182 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_5" >
2186 <label class=
"md-nav__link" for=
"__nav_6_5" id=
"__nav_6_5_label" tabindex=
"0">
2187 From WoltLab Suite
3.1
2188 <span class=
"md-nav__icon md-icon"></span>
2191 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_5_label" aria-expanded=
"false">
2192 <label class=
"md-nav__title" for=
"__nav_6_5">
2193 <span class=
"md-nav__icon md-icon"></span>
2194 From WoltLab Suite
3.1
2196 <ul class=
"md-nav__list" data-md-scrollfix
>
2203 <li class=
"md-nav__item">
2204 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
2225 <li class=
"md-nav__item md-nav__item--nested">
2230 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_6" >
2234 <label class=
"md-nav__link" for=
"__nav_6_6" id=
"__nav_6_6_label" tabindex=
"0">
2235 From WoltLab Suite
3.0
2236 <span class=
"md-nav__icon md-icon"></span>
2239 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_6_label" aria-expanded=
"false">
2240 <label class=
"md-nav__title" for=
"__nav_6_6">
2241 <span class=
"md-nav__icon md-icon"></span>
2242 From WoltLab Suite
3.0
2244 <ul class=
"md-nav__list" data-md-scrollfix
>
2251 <li class=
"md-nav__item">
2252 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
2265 <li class=
"md-nav__item">
2266 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
2279 <li class=
"md-nav__item">
2280 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
2293 <li class=
"md-nav__item">
2294 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
2307 <li class=
"md-nav__item">
2308 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
2329 <li class=
"md-nav__item md-nav__item--nested">
2334 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_7" >
2338 <label class=
"md-nav__link" for=
"__nav_6_7" id=
"__nav_6_7_label" tabindex=
"0">
2340 <span class=
"md-nav__icon md-icon"></span>
2343 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_7_label" aria-expanded=
"false">
2344 <label class=
"md-nav__title" for=
"__nav_6_7">
2345 <span class=
"md-nav__icon md-icon"></span>
2348 <ul class=
"md-nav__list" data-md-scrollfix
>
2355 <li class=
"md-nav__item">
2356 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
2369 <li class=
"md-nav__item">
2370 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
2383 <li class=
"md-nav__item">
2384 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
2397 <li class=
"md-nav__item">
2398 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
2427 <li class=
"md-nav__item md-nav__item--nested">
2432 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7" >
2436 <label class=
"md-nav__link" for=
"__nav_7" id=
"__nav_7_label" tabindex=
"0">
2438 <span class=
"md-nav__icon md-icon"></span>
2441 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_7_label" aria-expanded=
"false">
2442 <label class=
"md-nav__title" for=
"__nav_7">
2443 <span class=
"md-nav__icon md-icon"></span>
2446 <ul class=
"md-nav__list" data-md-scrollfix
>
2454 <li class=
"md-nav__item md-nav__item--nested">
2459 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7_1" >
2463 <label class=
"md-nav__link" for=
"__nav_7_1" id=
"__nav_7_1_label" tabindex=
"0">
2465 <span class=
"md-nav__icon md-icon"></span>
2468 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_7_1_label" aria-expanded=
"false">
2469 <label class=
"md-nav__title" for=
"__nav_7_1">
2470 <span class=
"md-nav__icon md-icon"></span>
2473 <ul class=
"md-nav__list" data-md-scrollfix
>
2480 <li class=
"md-nav__item">
2481 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
2494 <li class=
"md-nav__item">
2495 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
2508 <li class=
"md-nav__item">
2509 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
2522 <li class=
"md-nav__item">
2523 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
2536 <li class=
"md-nav__item">
2537 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
2550 <li class=
"md-nav__item">
2551 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
2564 <li class=
"md-nav__item">
2565 <a href=
"../../../tutorial/series/part_6/" class=
"md-nav__link">
2594 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2595 <div class=
"md-sidebar__scrollwrap">
2596 <div class=
"md-sidebar__inner">
2599 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2613 <div class=
"md-content" data-md-component=
"content">
2614 <article class=
"md-content__inner md-typeset">
2622 <h1 id=
"template-package-installation-plugin">Template Package Installation Plugin
<a class=
"headerlink" href=
"#template-package-installation-plugin" title=
"Permanent link">#
</a></h1>
2623 <p>Add templates for frontend pages and forms by providing an archive containing the template files.
</p>
2624 <div class=
"admonition warning">
2625 <p class=
"admonition-title">You cannot overwrite templates provided by other packages.
</p>
2627 <p>This package installation plugin behaves exactly like the
<a href=
"../acp-template/">acpTemplate package installation plugin
</a> except for installing frontend templates instead of backend/acp templates.
</p>
2630 <div class=
"md-source-file">
2652 <footer class=
"md-footer">
2654 <div class=
"md-footer-meta md-typeset">
2655 <div class=
"md-footer-meta__inner md-grid">
2656 <div class=
"md-copyright">
2658 <div class=
"md-copyright__highlight">
2659 Copyright ©
2020 WoltLab GmbH
2664 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2670 <div class=
"md-copyright">
2671 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2672 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2680 <div class=
"md-dialog" data-md-component=
"dialog">
2681 <div class=
"md-dialog__inner md-typeset"></div>
2684 <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>
2687 <script src=
"../../../assets/javascripts/bundle.b425cdc4.min.js"></script>