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/acp-template/">
13 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
14 <meta name=
"generator" content=
"mkdocs-1.3.1, mkdocs-material-8.4.2">
18 <title>acpTemplate - WoltLab Suite Documentation
</title>
22 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.69437709.min.css">
25 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.cbb835fc.min.css">
29 <meta name=
"theme-color" content=
"#009485">
39 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
41 <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>
55 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
59 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
60 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
61 <label class=
"md-overlay" for=
"__drawer"></label>
62 <div data-md-component=
"skip">
65 <a href=
"#acp-template-installation-plugin" class=
"md-skip">
70 <div data-md-component=
"announce">
72 <aside class=
"md-banner">
73 <div class=
"md-banner__inner md-grid md-typeset">
76 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
84 <div data-md-component=
"outdated" hidden
>
91 <header class=
"md-header" data-md-component=
"header">
92 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
93 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
95 <img src=
"../../../assets/logo.png" alt=
"logo">
98 <label class=
"md-header__button md-icon" for=
"__drawer">
99 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
101 <div class=
"md-header__title" data-md-component=
"header-title">
102 <div class=
"md-header__ellipsis">
103 <div class=
"md-header__topic">
104 <span class=
"md-ellipsis">
105 WoltLab Suite Documentation
108 <div class=
"md-header__topic" data-md-component=
"header-topic">
109 <span class=
"md-ellipsis">
120 <label class=
"md-header__button md-icon" for=
"__search">
121 <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>
123 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
124 <label class=
"md-search__overlay" for=
"__search"></label>
125 <div class=
"md-search__inner" role=
"search">
126 <form class=
"md-search__form" name=
"search">
127 <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
>
128 <label class=
"md-search__icon md-icon" for=
"__search">
129 <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 <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>
132 <nav class=
"md-search__options" aria-label=
"Search">
134 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
135 <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>
140 <div class=
"md-search__output">
141 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
142 <div class=
"md-search-result" data-md-component=
"search-result">
143 <div class=
"md-search-result__meta">
146 <ol class=
"md-search-result__list"></ol>
154 <div class=
"md-header__source">
155 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
156 <div class=
"md-source__icon md-icon">
158 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.1.2 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 2022 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>
160 <div class=
"md-source__repository">
170 <div class=
"md-container" data-md-component=
"container">
177 <main class=
"md-main" data-md-component=
"main">
178 <div class=
"md-main__inner md-grid">
182 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
183 <div class=
"md-sidebar__scrollwrap">
184 <div class=
"md-sidebar__inner">
188 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
189 <label class=
"md-nav__title" for=
"__drawer">
190 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
192 <img src=
"../../../assets/logo.png" alt=
"logo">
195 WoltLab Suite Documentation
198 <div class=
"md-nav__source">
199 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
200 <div class=
"md-source__icon md-icon">
202 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.1.2 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 2022 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>
204 <div class=
"md-source__repository">
210 <ul class=
"md-nav__list" data-md-scrollfix
>
219 <li class=
"md-nav__item">
220 <a href=
"../../../getting-started/" class=
"md-nav__link">
235 <li class=
"md-nav__item md-nav__item--nested">
238 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
243 <label class=
"md-nav__link" for=
"__nav_2">
245 <span class=
"md-nav__icon md-icon"></span>
248 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
249 <label class=
"md-nav__title" for=
"__nav_2">
250 <span class=
"md-nav__icon md-icon"></span>
253 <ul class=
"md-nav__list" data-md-scrollfix
>
260 <li class=
"md-nav__item">
261 <a href=
"../../../php/pages/" class=
"md-nav__link">
274 <li class=
"md-nav__item">
275 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
288 <li class=
"md-nav__item">
289 <a href=
"../../../php/database-access/" class=
"md-nav__link">
302 <li class=
"md-nav__item">
303 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
317 <li class=
"md-nav__item md-nav__item--nested">
320 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
325 <label class=
"md-nav__link" for=
"__nav_2_5">
327 <span class=
"md-nav__icon md-icon"></span>
330 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
331 <label class=
"md-nav__title" for=
"__nav_2_5">
332 <span class=
"md-nav__icon md-icon"></span>
335 <ul class=
"md-nav__list" data-md-scrollfix
>
343 <li class=
"md-nav__item md-nav__item--nested">
346 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
351 <label class=
"md-nav__link" for=
"__nav_2_5_1">
353 <span class=
"md-nav__icon md-icon"></span>
356 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
357 <label class=
"md-nav__title" for=
"__nav_2_5_1">
358 <span class=
"md-nav__icon md-icon"></span>
361 <ul class=
"md-nav__list" data-md-scrollfix
>
368 <li class=
"md-nav__item">
369 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
382 <li class=
"md-nav__item">
383 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
417 <li class=
"md-nav__item">
418 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
431 <li class=
"md-nav__item">
432 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
445 <li class=
"md-nav__item">
446 <a href=
"../../../php/api/events/" class=
"md-nav__link">
460 <li class=
"md-nav__item md-nav__item--nested">
463 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
468 <label class=
"md-nav__link" for=
"__nav_2_5_5">
470 <span class=
"md-nav__icon md-icon"></span>
473 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
474 <label class=
"md-nav__title" for=
"__nav_2_5_5">
475 <span class=
"md-nav__icon md-icon"></span>
478 <ul class=
"md-nav__list" data-md-scrollfix
>
485 <li class=
"md-nav__item">
486 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
499 <li class=
"md-nav__item">
500 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
513 <li class=
"md-nav__item">
514 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
527 <li class=
"md-nav__item">
528 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
541 <li class=
"md-nav__item">
542 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
562 <li class=
"md-nav__item">
563 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
564 Package Installation Plugins
576 <li class=
"md-nav__item">
577 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
590 <li class=
"md-nav__item">
591 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
604 <li class=
"md-nav__item">
605 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
625 <li class=
"md-nav__item">
626 <a href=
"../../../php/code-style/" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"../../../php/apps/" class=
"md-nav__link">
653 <li class=
"md-nav__item">
654 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
676 <li class=
"md-nav__item md-nav__item--nested">
679 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
684 <label class=
"md-nav__link" for=
"__nav_3">
685 Languages, Templates & CSS
686 <span class=
"md-nav__icon md-icon"></span>
689 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
690 <label class=
"md-nav__title" for=
"__nav_3">
691 <span class=
"md-nav__icon md-icon"></span>
692 Languages, Templates & CSS
694 <ul class=
"md-nav__list" data-md-scrollfix
>
701 <li class=
"md-nav__item">
702 <a href=
"../../../view/languages/" class=
"md-nav__link">
715 <li class=
"md-nav__item">
716 <a href=
"../../../view/templates/" class=
"md-nav__link">
729 <li class=
"md-nav__item">
730 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
743 <li class=
"md-nav__item">
744 <a href=
"../../../view/css/" class=
"md-nav__link">
766 <li class=
"md-nav__item md-nav__item--nested">
769 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
774 <label class=
"md-nav__link" for=
"__nav_4">
775 TypeScript and JavaScript API
776 <span class=
"md-nav__icon md-icon"></span>
779 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
780 <label class=
"md-nav__title" for=
"__nav_4">
781 <span class=
"md-nav__icon md-icon"></span>
782 TypeScript and JavaScript API
784 <ul class=
"md-nav__list" data-md-scrollfix
>
791 <li class=
"md-nav__item">
792 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
805 <li class=
"md-nav__item">
806 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
820 <li class=
"md-nav__item md-nav__item--nested">
823 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
828 <label class=
"md-nav__link" for=
"__nav_4_3">
830 <span class=
"md-nav__icon md-icon"></span>
833 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
834 <label class=
"md-nav__title" for=
"__nav_4_3">
835 <span class=
"md-nav__icon md-icon"></span>
838 <ul class=
"md-nav__list" data-md-scrollfix
>
845 <li class=
"md-nav__item">
846 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
859 <li class=
"md-nav__item">
860 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
873 <li class=
"md-nav__item">
874 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
887 <li class=
"md-nav__item">
888 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
901 <li class=
"md-nav__item">
902 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
915 <li class=
"md-nav__item">
916 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
929 <li class=
"md-nav__item">
930 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
943 <li class=
"md-nav__item">
944 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
945 Browser and Screen Sizes
957 <li class=
"md-nav__item">
958 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
978 <li class=
"md-nav__item">
979 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
992 <li class=
"md-nav__item">
993 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
1006 <li class=
"md-nav__item">
1007 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
1031 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1034 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
1039 <label class=
"md-nav__link" for=
"__nav_5">
1041 <span class=
"md-nav__icon md-icon"></span>
1044 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1045 <label class=
"md-nav__title" for=
"__nav_5">
1046 <span class=
"md-nav__icon md-icon"></span>
1049 <ul class=
"md-nav__list" data-md-scrollfix
>
1056 <li class=
"md-nav__item">
1057 <a href=
"../../package-xml/" class=
"md-nav__link">
1073 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1076 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
1081 <label class=
"md-nav__link" for=
"__nav_5_2">
1083 <span class=
"md-nav__icon md-icon"></span>
1086 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1087 <label class=
"md-nav__title" for=
"__nav_5_2">
1088 <span class=
"md-nav__icon md-icon"></span>
1091 <ul class=
"md-nav__list" data-md-scrollfix
>
1098 <li class=
"md-nav__item">
1099 <a href=
"../" class=
"md-nav__link">
1112 <li class=
"md-nav__item">
1113 <a href=
"../acl-option/" class=
"md-nav__link">
1126 <li class=
"md-nav__item">
1127 <a href=
"../acp-menu/" class=
"md-nav__link">
1140 <li class=
"md-nav__item">
1141 <a href=
"../acp-search-provider/" class=
"md-nav__link">
1156 <li class=
"md-nav__item md-nav__item--active">
1158 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1164 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1166 <span class=
"md-nav__icon md-icon"></span>
1169 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1175 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1182 <label class=
"md-nav__title" for=
"__toc">
1183 <span class=
"md-nav__icon md-icon"></span>
1186 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1188 <li class=
"md-nav__item">
1189 <a href=
"#archive" class=
"md-nav__link">
1195 <li class=
"md-nav__item">
1196 <a href=
"#attributes" class=
"md-nav__link">
1200 <nav class=
"md-nav" aria-label=
"Attributes">
1201 <ul class=
"md-nav__list">
1203 <li class=
"md-nav__item">
1204 <a href=
"#application" class=
"md-nav__link">
1215 <li class=
"md-nav__item">
1216 <a href=
"#example-in-packagexml" class=
"md-nav__link">
1217 Example in package.xml
1236 <li class=
"md-nav__item">
1237 <a href=
"../acp-template-delete/" class=
"md-nav__link">
1250 <li class=
"md-nav__item">
1251 <a href=
"../bbcode/" class=
"md-nav__link">
1264 <li class=
"md-nav__item">
1265 <a href=
"../box/" class=
"md-nav__link">
1278 <li class=
"md-nav__item">
1279 <a href=
"../clipboard-action/" class=
"md-nav__link">
1292 <li class=
"md-nav__item">
1293 <a href=
"../core-object/" class=
"md-nav__link">
1306 <li class=
"md-nav__item">
1307 <a href=
"../cronjob/" class=
"md-nav__link">
1320 <li class=
"md-nav__item">
1321 <a href=
"../database/" class=
"md-nav__link">
1334 <li class=
"md-nav__item">
1335 <a href=
"../event-listener/" class=
"md-nav__link">
1348 <li class=
"md-nav__item">
1349 <a href=
"../file/" class=
"md-nav__link">
1362 <li class=
"md-nav__item">
1363 <a href=
"../file-delete/" class=
"md-nav__link">
1376 <li class=
"md-nav__item">
1377 <a href=
"../language/" class=
"md-nav__link">
1390 <li class=
"md-nav__item">
1391 <a href=
"../media-provider/" class=
"md-nav__link">
1404 <li class=
"md-nav__item">
1405 <a href=
"../menu/" class=
"md-nav__link">
1418 <li class=
"md-nav__item">
1419 <a href=
"../menu-item/" class=
"md-nav__link">
1432 <li class=
"md-nav__item">
1433 <a href=
"../object-type/" class=
"md-nav__link">
1446 <li class=
"md-nav__item">
1447 <a href=
"../object-type-definition/" class=
"md-nav__link">
1448 objectTypeDefinition
1460 <li class=
"md-nav__item">
1461 <a href=
"../option/" class=
"md-nav__link">
1474 <li class=
"md-nav__item">
1475 <a href=
"../page/" class=
"md-nav__link">
1488 <li class=
"md-nav__item">
1489 <a href=
"../pip/" class=
"md-nav__link">
1502 <li class=
"md-nav__item">
1503 <a href=
"../script/" class=
"md-nav__link">
1516 <li class=
"md-nav__item">
1517 <a href=
"../smiley/" class=
"md-nav__link">
1530 <li class=
"md-nav__item">
1531 <a href=
"../sql/" class=
"md-nav__link">
1544 <li class=
"md-nav__item">
1545 <a href=
"../style/" class=
"md-nav__link">
1558 <li class=
"md-nav__item">
1559 <a href=
"../template/" class=
"md-nav__link">
1572 <li class=
"md-nav__item">
1573 <a href=
"../template-delete/" class=
"md-nav__link">
1586 <li class=
"md-nav__item">
1587 <a href=
"../template-listener/" class=
"md-nav__link">
1600 <li class=
"md-nav__item">
1601 <a href=
"../user-group-option/" class=
"md-nav__link">
1614 <li class=
"md-nav__item">
1615 <a href=
"../user-menu/" class=
"md-nav__link">
1628 <li class=
"md-nav__item">
1629 <a href=
"../user-notification-event/" class=
"md-nav__link">
1630 userNotificationEvent
1642 <li class=
"md-nav__item">
1643 <a href=
"../user-option/" class=
"md-nav__link">
1656 <li class=
"md-nav__item">
1657 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1677 <li class=
"md-nav__item">
1678 <a href=
"../../database-php-api/" class=
"md-nav__link">
1700 <li class=
"md-nav__item md-nav__item--nested">
1703 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1708 <label class=
"md-nav__link" for=
"__nav_6">
1710 <span class=
"md-nav__icon md-icon"></span>
1713 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1714 <label class=
"md-nav__title" for=
"__nav_6">
1715 <span class=
"md-nav__icon md-icon"></span>
1718 <ul class=
"md-nav__list" data-md-scrollfix
>
1726 <li class=
"md-nav__item md-nav__item--nested">
1729 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1734 <label class=
"md-nav__link" for=
"__nav_6_1">
1735 From WoltLab Suite
5.5
1736 <span class=
"md-nav__icon md-icon"></span>
1739 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 5.5" data-md-level=
"2">
1740 <label class=
"md-nav__title" for=
"__nav_6_1">
1741 <span class=
"md-nav__icon md-icon"></span>
1742 From WoltLab Suite
5.5
1744 <ul class=
"md-nav__list" data-md-scrollfix
>
1751 <li class=
"md-nav__item">
1752 <a href=
"../../../migration/wsc55/php/" class=
"md-nav__link">
1765 <li class=
"md-nav__item">
1766 <a href=
"../../../migration/wsc55/javascript/" class=
"md-nav__link">
1767 TypeScript and JavaScript
1779 <li class=
"md-nav__item">
1780 <a href=
"../../../migration/wsc55/templates/" class=
"md-nav__link">
1793 <li class=
"md-nav__item">
1794 <a href=
"../../../migration/wsc55/libraries/" class=
"md-nav__link">
1795 Third Party Libraries
1807 <li class=
"md-nav__item">
1808 <a href=
"../../../migration/wsc55/deprecations_removals/" class=
"md-nav__link">
1809 Deprecations and Removals
1829 <li class=
"md-nav__item md-nav__item--nested">
1832 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1837 <label class=
"md-nav__link" for=
"__nav_6_2">
1838 From WoltLab Suite
5.4
1839 <span class=
"md-nav__icon md-icon"></span>
1842 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 5.4" data-md-level=
"2">
1843 <label class=
"md-nav__title" for=
"__nav_6_2">
1844 <span class=
"md-nav__icon md-icon"></span>
1845 From WoltLab Suite
5.4
1847 <ul class=
"md-nav__list" data-md-scrollfix
>
1854 <li class=
"md-nav__item">
1855 <a href=
"../../../migration/wsc54/php/" class=
"md-nav__link">
1868 <li class=
"md-nav__item">
1869 <a href=
"../../../migration/wsc54/javascript/" class=
"md-nav__link">
1870 TypeScript and JavaScript
1882 <li class=
"md-nav__item">
1883 <a href=
"../../../migration/wsc54/templates/" class=
"md-nav__link">
1896 <li class=
"md-nav__item">
1897 <a href=
"../../../migration/wsc54/libraries/" class=
"md-nav__link">
1898 Third Party Libraries
1910 <li class=
"md-nav__item">
1911 <a href=
"../../../migration/wsc54/deprecations_removals/" class=
"md-nav__link">
1912 Deprecations and Removals
1932 <li class=
"md-nav__item md-nav__item--nested">
1935 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1940 <label class=
"md-nav__link" for=
"__nav_6_3">
1941 From WoltLab Suite
5.3
1942 <span class=
"md-nav__icon md-icon"></span>
1945 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 5.3" data-md-level=
"2">
1946 <label class=
"md-nav__title" for=
"__nav_6_3">
1947 <span class=
"md-nav__icon md-icon"></span>
1948 From WoltLab Suite
5.3
1950 <ul class=
"md-nav__list" data-md-scrollfix
>
1957 <li class=
"md-nav__item">
1958 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1971 <li class=
"md-nav__item">
1972 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1973 Session Handling and Authentication
1985 <li class=
"md-nav__item">
1986 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1987 TypeScript and JavaScript
1999 <li class=
"md-nav__item">
2000 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
2013 <li class=
"md-nav__item">
2014 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
2015 Third Party Libraries
2035 <li class=
"md-nav__item md-nav__item--nested">
2038 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
2043 <label class=
"md-nav__link" for=
"__nav_6_4">
2044 From WoltLab Suite
5.2
2045 <span class=
"md-nav__icon md-icon"></span>
2048 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 5.2" data-md-level=
"2">
2049 <label class=
"md-nav__title" for=
"__nav_6_4">
2050 <span class=
"md-nav__icon md-icon"></span>
2051 From WoltLab Suite
5.2
2053 <ul class=
"md-nav__list" data-md-scrollfix
>
2060 <li class=
"md-nav__item">
2061 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
2074 <li class=
"md-nav__item">
2075 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
2076 Templates and Languages
2088 <li class=
"md-nav__item">
2089 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
2090 Third Party Libraries
2110 <li class=
"md-nav__item md-nav__item--nested">
2113 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
2118 <label class=
"md-nav__link" for=
"__nav_6_5">
2119 From WoltLab Suite
3.1
2120 <span class=
"md-nav__icon md-icon"></span>
2123 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 3.1" data-md-level=
"2">
2124 <label class=
"md-nav__title" for=
"__nav_6_5">
2125 <span class=
"md-nav__icon md-icon"></span>
2126 From WoltLab Suite
3.1
2128 <ul class=
"md-nav__list" data-md-scrollfix
>
2135 <li class=
"md-nav__item">
2136 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
2157 <li class=
"md-nav__item md-nav__item--nested">
2160 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_6" type=
"checkbox" id=
"__nav_6_6" >
2165 <label class=
"md-nav__link" for=
"__nav_6_6">
2166 From WoltLab Suite
3.0
2167 <span class=
"md-nav__icon md-icon"></span>
2170 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 3.0" data-md-level=
"2">
2171 <label class=
"md-nav__title" for=
"__nav_6_6">
2172 <span class=
"md-nav__icon md-icon"></span>
2173 From WoltLab Suite
3.0
2175 <ul class=
"md-nav__list" data-md-scrollfix
>
2182 <li class=
"md-nav__item">
2183 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
2196 <li class=
"md-nav__item">
2197 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
2210 <li class=
"md-nav__item">
2211 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
2224 <li class=
"md-nav__item">
2225 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
2238 <li class=
"md-nav__item">
2239 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
2260 <li class=
"md-nav__item md-nav__item--nested">
2263 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_7" type=
"checkbox" id=
"__nav_6_7" >
2268 <label class=
"md-nav__link" for=
"__nav_6_7">
2270 <span class=
"md-nav__icon md-icon"></span>
2273 <nav class=
"md-nav" aria-label=
"From WCF 2.1" data-md-level=
"2">
2274 <label class=
"md-nav__title" for=
"__nav_6_7">
2275 <span class=
"md-nav__icon md-icon"></span>
2278 <ul class=
"md-nav__list" data-md-scrollfix
>
2285 <li class=
"md-nav__item">
2286 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
2299 <li class=
"md-nav__item">
2300 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
2313 <li class=
"md-nav__item">
2314 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
2327 <li class=
"md-nav__item">
2328 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
2357 <li class=
"md-nav__item md-nav__item--nested">
2360 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
2365 <label class=
"md-nav__link" for=
"__nav_7">
2367 <span class=
"md-nav__icon md-icon"></span>
2370 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
2371 <label class=
"md-nav__title" for=
"__nav_7">
2372 <span class=
"md-nav__icon md-icon"></span>
2375 <ul class=
"md-nav__list" data-md-scrollfix
>
2383 <li class=
"md-nav__item md-nav__item--nested">
2386 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
2391 <label class=
"md-nav__link" for=
"__nav_7_1">
2393 <span class=
"md-nav__icon md-icon"></span>
2396 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
2397 <label class=
"md-nav__title" for=
"__nav_7_1">
2398 <span class=
"md-nav__icon md-icon"></span>
2401 <ul class=
"md-nav__list" data-md-scrollfix
>
2408 <li class=
"md-nav__item">
2409 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
2422 <li class=
"md-nav__item">
2423 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
2436 <li class=
"md-nav__item">
2437 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
2450 <li class=
"md-nav__item">
2451 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
2464 <li class=
"md-nav__item">
2465 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
2478 <li class=
"md-nav__item">
2479 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
2492 <li class=
"md-nav__item">
2493 <a href=
"../../../tutorial/series/part_6/" class=
"md-nav__link">
2522 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2523 <div class=
"md-sidebar__scrollwrap">
2524 <div class=
"md-sidebar__inner">
2527 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2534 <label class=
"md-nav__title" for=
"__toc">
2535 <span class=
"md-nav__icon md-icon"></span>
2538 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2540 <li class=
"md-nav__item">
2541 <a href=
"#archive" class=
"md-nav__link">
2547 <li class=
"md-nav__item">
2548 <a href=
"#attributes" class=
"md-nav__link">
2552 <nav class=
"md-nav" aria-label=
"Attributes">
2553 <ul class=
"md-nav__list">
2555 <li class=
"md-nav__item">
2556 <a href=
"#application" class=
"md-nav__link">
2567 <li class=
"md-nav__item">
2568 <a href=
"#example-in-packagexml" class=
"md-nav__link">
2569 Example in package.xml
2582 <div class=
"md-content" data-md-component=
"content">
2583 <article class=
"md-content__inner md-typeset">
2586 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/6.0/docs/package/pip/acp-template.md" title=
"Edit this page" class=
"md-content__button md-icon">
2587 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z"/></svg>
2592 <h1 id=
"acp-template-installation-plugin">ACP Template Installation Plugin
<a class=
"headerlink" href=
"#acp-template-installation-plugin" title=
"Permanent link">#
</a></h1>
2593 <p>Add templates for acp pages and forms by providing an archive containing the template files.
</p>
2594 <div class=
"admonition warning">
2595 <p class=
"admonition-title">You cannot overwrite acp templates provided by other packages.
</p>
2597 <h2 id=
"archive">Archive
<a class=
"headerlink" href=
"#archive" title=
"Permanent link">#
</a></h2>
2598 <p>The
<code>acpTemplate
</code> package installation plugins expects a
<code>.tar
</code> (recommended) or
<code>.tar.gz
</code> archive.
2599 The templates must all be in the root of the archive.
2600 Do not include any directories in the archive.
2601 The file path given in the
<code>instruction
</code> element as its value must be relative to the
<code>package.xml
</code> file.
</p>
2602 <h2 id=
"attributes">Attributes
<a class=
"headerlink" href=
"#attributes" title=
"Permanent link">#
</a></h2>
2603 <h3 id=
"application"><code>application
</code><a class=
"headerlink" href=
"#application" title=
"Permanent link">#
</a></h3>
2604 <p>The
<code>application
</code> attribute determines to which application the installed acp templates belong and thus in which directory the templates are installed.
2605 The value of the
<code>application
</code> attribute has to be the abbreviation of an installed application.
2606 If no
<code>application
</code> attribute is given, the following rules are applied:
</p>
2608 <li>If the package installing the acp templates is an application, then the templates will be installed in this application's directory.
</li>
2609 <li>If the package installing the acp templates is no application, then the templates will be installed in WoltLab Suite Core's directory.
</li>
2611 <h2 id=
"example-in-packagexml">Example in
<code>package.xml
</code><a class=
"headerlink" href=
"#example-in-packagexml" title=
"Permanent link">#
</a></h2>
2612 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2613 <span class=
"normal">2</span>
2614 <span class=
"normal">3</span>
2615 <span class=
"normal">4</span>
2616 <span class=
"normal">5</span>
2617 <span class=
"normal">6</span>
2618 <span class=
"normal">7</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"acpTemplate
"</span> <span class=
"nt">/
></span>
2619 <span class=
"cm"><!-- is the same as --
></span>
2620 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"acpTemplate
"</span><span class=
"nt">></span>acptemplates.tar
<span class=
"nt"></instruction
></span>
2622 <span class=
"cm"><!-- if an application
"com.woltlab.example
" is being installed, the following lines are equivalent --
></span>
2623 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"acpTemplate
"</span> <span class=
"nt">/
></span>
2624 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"acpTemplate
"</span> <span class=
"na">application=
</span><span class=
"s">"example
"</span> <span class=
"nt">/
></span>
2625 </code></pre></div></td></tr></table></div>
2628 <div class=
"md-source-file">
2648 <footer class=
"md-footer">
2651 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer" >
2654 <a href=
"../acp-search-provider/" class=
"md-footer__link md-footer__link--prev" aria-label=
"Previous: acpSearchProvider" rel=
"prev">
2655 <div class=
"md-footer__button md-icon">
2656 <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>
2658 <div class=
"md-footer__title">
2659 <div class=
"md-ellipsis">
2660 <span class=
"md-footer__direction">
2670 <a href=
"../acp-template-delete/" class=
"md-footer__link md-footer__link--next" aria-label=
"Next: acpTemplateDelete" rel=
"next">
2671 <div class=
"md-footer__title">
2672 <div class=
"md-ellipsis">
2673 <span class=
"md-footer__direction">
2679 <div class=
"md-footer__button md-icon">
2680 <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>
2686 <div class=
"md-footer-meta md-typeset">
2687 <div class=
"md-footer-meta__inner md-grid">
2688 <div class=
"md-copyright">
2690 <div class=
"md-copyright__highlight">
2691 Copyright ©
2020 WoltLab GmbH
2696 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2702 <div class=
"md-copyright">
2703 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2704 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2712 <div class=
"md-dialog" data-md-component=
"dialog">
2713 <div class=
"md-dialog__inner md-typeset"></div>
2716 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [
"navigation.tracking"],
"search":
"../../../assets/javascripts/workers/search.ecf98df9.min.js",
"translations": {
"clipboard.copied":
"Copied to clipboard",
"clipboard.copy":
"Copy to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"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.title":
"Select version"},
"version": {
"provider":
"mike"}}
</script>
2719 <script src=
"../../../assets/javascripts/bundle.9c69f0bc.min.js"></script>