3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>file - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ef6f36e2.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <script>function __prefix(e){return new URL(
"../../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
57 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
58 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
59 <label class=
"md-overlay" for=
"__drawer"></label>
60 <div data-md-component=
"skip">
63 <a href=
"#file-package-installation-plugin" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
84 <img src=
"../../../assets/logo.png" alt=
"logo">
87 <label class=
"md-header__button md-icon" for=
"__drawer">
88 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 <div class=
"md-header__title" data-md-component=
"header-title">
91 <div class=
"md-header__ellipsis">
92 <div class=
"md-header__topic">
93 <span class=
"md-ellipsis">
94 WoltLab Suite Documentation
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
109 <label class=
"md-header__button md-icon" for=
"__search">
110 <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>
113 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
114 <label class=
"md-search__overlay" for=
"__search"></label>
115 <div class=
"md-search__inner" role=
"search">
116 <form class=
"md-search__form" name=
"search">
117 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
118 <label class=
"md-search__icon md-icon" for=
"__search">
119 <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>
120 <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>
122 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
123 <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>
126 <div class=
"md-search__output">
127 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
128 <div class=
"md-search-result" data-md-component=
"search-result">
129 <div class=
"md-search-result__meta">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
142 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
143 <div class=
"md-source__icon md-icon">
145 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><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>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
166 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
167 <div class=
"md-sidebar__scrollwrap">
168 <div class=
"md-sidebar__inner">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
184 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
185 <div class=
"md-source__icon md-icon">
187 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><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>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
229 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
230 <label class=
"md-nav__title" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
298 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
299 <label class=
"md-nav__title" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
310 <li class=
"md-nav__item md-nav__item--nested">
313 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
315 <label class=
"md-nav__link" for=
"__nav_2_5_1">
317 <span class=
"md-nav__icon md-icon"></span>
319 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
320 <label class=
"md-nav__title" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
324 <ul class=
"md-nav__list" data-md-scrollfix
>
330 <li class=
"md-nav__item">
331 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
342 <li class=
"md-nav__item">
343 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
354 <li class=
"md-nav__item">
355 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
372 <li class=
"md-nav__item">
373 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../../php/api/events/" class=
"md-nav__link">
409 <li class=
"md-nav__item md-nav__item--nested">
412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
414 <label class=
"md-nav__link" for=
"__nav_2_5_5">
416 <span class=
"md-nav__icon md-icon"></span>
418 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
419 <label class=
"md-nav__title" for=
"__nav_2_5_5">
420 <span class=
"md-nav__icon md-icon"></span>
423 <ul class=
"md-nav__list" data-md-scrollfix
>
429 <li class=
"md-nav__item">
430 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
453 <li class=
"md-nav__item">
454 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
465 <li class=
"md-nav__item">
466 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
495 <li class=
"md-nav__item">
496 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
497 Package Installation Plugins
507 <li class=
"md-nav__item">
508 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
549 <li class=
"md-nav__item">
550 <a href=
"../../../php/code-style/" class=
"md-nav__link">
561 <li class=
"md-nav__item">
562 <a href=
"../../../php/apps/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
595 <li class=
"md-nav__item md-nav__item--nested">
598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
600 <label class=
"md-nav__link" for=
"__nav_3">
601 Languages, Templates & CSS
602 <span class=
"md-nav__icon md-icon"></span>
604 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
605 <label class=
"md-nav__title" for=
"__nav_3">
606 <span class=
"md-nav__icon md-icon"></span>
607 Languages, Templates & CSS
609 <ul class=
"md-nav__list" data-md-scrollfix
>
615 <li class=
"md-nav__item">
616 <a href=
"../../../view/languages/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../../../view/templates/" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"../../../view/css/" class=
"md-nav__link">
673 <li class=
"md-nav__item md-nav__item--nested">
676 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
678 <label class=
"md-nav__link" for=
"__nav_4">
679 TypeScript and JavaScript API
680 <span class=
"md-nav__icon md-icon"></span>
682 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
683 <label class=
"md-nav__title" for=
"__nav_4">
684 <span class=
"md-nav__icon md-icon"></span>
685 TypeScript and JavaScript API
687 <ul class=
"md-nav__list" data-md-scrollfix
>
693 <li class=
"md-nav__item">
694 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
705 <li class=
"md-nav__item">
706 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
718 <li class=
"md-nav__item md-nav__item--nested">
721 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
723 <label class=
"md-nav__link" for=
"__nav_4_3">
725 <span class=
"md-nav__icon md-icon"></span>
727 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
728 <label class=
"md-nav__title" for=
"__nav_4_3">
729 <span class=
"md-nav__icon md-icon"></span>
732 <ul class=
"md-nav__list" data-md-scrollfix
>
738 <li class=
"md-nav__item">
739 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
750 <li class=
"md-nav__item">
751 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
762 <li class=
"md-nav__item">
763 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
774 <li class=
"md-nav__item">
775 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
786 <li class=
"md-nav__item">
787 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
798 <li class=
"md-nav__item">
799 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
810 <li class=
"md-nav__item">
811 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
822 <li class=
"md-nav__item">
823 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
824 Browser and Screen Sizes
834 <li class=
"md-nav__item">
835 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
852 <li class=
"md-nav__item">
853 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
864 <li class=
"md-nav__item">
865 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
876 <li class=
"md-nav__item">
877 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
900 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
903 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
905 <label class=
"md-nav__link" for=
"__nav_5">
907 <span class=
"md-nav__icon md-icon"></span>
909 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
910 <label class=
"md-nav__title" for=
"__nav_5">
911 <span class=
"md-nav__icon md-icon"></span>
914 <ul class=
"md-nav__list" data-md-scrollfix
>
920 <li class=
"md-nav__item">
921 <a href=
"../../package-xml/" class=
"md-nav__link">
935 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
938 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
940 <label class=
"md-nav__link" for=
"__nav_5_2">
942 <span class=
"md-nav__icon md-icon"></span>
944 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
945 <label class=
"md-nav__title" for=
"__nav_5_2">
946 <span class=
"md-nav__icon md-icon"></span>
949 <ul class=
"md-nav__list" data-md-scrollfix
>
955 <li class=
"md-nav__item">
956 <a href=
"../" class=
"md-nav__link">
967 <li class=
"md-nav__item">
968 <a href=
"../acl-option/" class=
"md-nav__link">
979 <li class=
"md-nav__item">
980 <a href=
"../acp-menu/" class=
"md-nav__link">
991 <li class=
"md-nav__item">
992 <a href=
"../acp-search-provider/" class=
"md-nav__link">
1003 <li class=
"md-nav__item">
1004 <a href=
"../acp-template/" class=
"md-nav__link">
1015 <li class=
"md-nav__item">
1016 <a href=
"../bbcode/" class=
"md-nav__link">
1027 <li class=
"md-nav__item">
1028 <a href=
"../box/" class=
"md-nav__link">
1039 <li class=
"md-nav__item">
1040 <a href=
"../clipboard-action/" class=
"md-nav__link">
1051 <li class=
"md-nav__item">
1052 <a href=
"../core-object/" class=
"md-nav__link">
1063 <li class=
"md-nav__item">
1064 <a href=
"../cronjob/" class=
"md-nav__link">
1075 <li class=
"md-nav__item">
1076 <a href=
"../database/" class=
"md-nav__link">
1087 <li class=
"md-nav__item">
1088 <a href=
"../event-listener/" class=
"md-nav__link">
1101 <li class=
"md-nav__item md-nav__item--active">
1103 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1108 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1110 <span class=
"md-nav__icon md-icon"></span>
1113 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1118 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1124 <label class=
"md-nav__title" for=
"__toc">
1125 <span class=
"md-nav__icon md-icon"></span>
1128 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1130 <li class=
"md-nav__item">
1131 <a href=
"#archive" class=
"md-nav__link">
1137 <li class=
"md-nav__item">
1138 <a href=
"#example-in-packagexml" class=
"md-nav__link">
1139 Example in package.xml
1156 <li class=
"md-nav__item">
1157 <a href=
"../language/" class=
"md-nav__link">
1168 <li class=
"md-nav__item">
1169 <a href=
"../media-provider/" class=
"md-nav__link">
1180 <li class=
"md-nav__item">
1181 <a href=
"../menu/" class=
"md-nav__link">
1192 <li class=
"md-nav__item">
1193 <a href=
"../menu-item/" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../object-type/" class=
"md-nav__link">
1216 <li class=
"md-nav__item">
1217 <a href=
"../object-type-definition/" class=
"md-nav__link">
1218 objectTypeDefinition
1228 <li class=
"md-nav__item">
1229 <a href=
"../option/" class=
"md-nav__link">
1240 <li class=
"md-nav__item">
1241 <a href=
"../page/" class=
"md-nav__link">
1252 <li class=
"md-nav__item">
1253 <a href=
"../pip/" class=
"md-nav__link">
1264 <li class=
"md-nav__item">
1265 <a href=
"../script/" class=
"md-nav__link">
1276 <li class=
"md-nav__item">
1277 <a href=
"../smiley/" class=
"md-nav__link">
1288 <li class=
"md-nav__item">
1289 <a href=
"../sql/" class=
"md-nav__link">
1300 <li class=
"md-nav__item">
1301 <a href=
"../style/" class=
"md-nav__link">
1312 <li class=
"md-nav__item">
1313 <a href=
"../template/" class=
"md-nav__link">
1324 <li class=
"md-nav__item">
1325 <a href=
"../template-listener/" class=
"md-nav__link">
1336 <li class=
"md-nav__item">
1337 <a href=
"../user-group-option/" class=
"md-nav__link">
1348 <li class=
"md-nav__item">
1349 <a href=
"../user-menu/" class=
"md-nav__link">
1360 <li class=
"md-nav__item">
1361 <a href=
"../user-notification-event/" class=
"md-nav__link">
1362 userNotificationEvent
1372 <li class=
"md-nav__item">
1373 <a href=
"../user-option/" class=
"md-nav__link">
1384 <li class=
"md-nav__item">
1385 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1402 <li class=
"md-nav__item">
1403 <a href=
"../../database-php-api/" class=
"md-nav__link">
1424 <li class=
"md-nav__item md-nav__item--nested">
1427 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1429 <label class=
"md-nav__link" for=
"__nav_6">
1431 <span class=
"md-nav__icon md-icon"></span>
1433 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1434 <label class=
"md-nav__title" for=
"__nav_6">
1435 <span class=
"md-nav__icon md-icon"></span>
1438 <ul class=
"md-nav__list" data-md-scrollfix
>
1445 <li class=
"md-nav__item md-nav__item--nested">
1448 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1450 <label class=
"md-nav__link" for=
"__nav_6_1">
1451 Migrating from WSC
5.3
1452 <span class=
"md-nav__icon md-icon"></span>
1454 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1455 <label class=
"md-nav__title" for=
"__nav_6_1">
1456 <span class=
"md-nav__icon md-icon"></span>
1457 Migrating from WSC
5.3
1459 <ul class=
"md-nav__list" data-md-scrollfix
>
1465 <li class=
"md-nav__item">
1466 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1477 <li class=
"md-nav__item">
1478 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1479 Session Handling and Authentication
1489 <li class=
"md-nav__item">
1490 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1491 TypeScript and JavaScript
1501 <li class=
"md-nav__item">
1502 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1513 <li class=
"md-nav__item">
1514 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1515 Third Party Libraries
1532 <li class=
"md-nav__item md-nav__item--nested">
1535 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1537 <label class=
"md-nav__link" for=
"__nav_6_2">
1538 Migrating from WSC
5.2
1539 <span class=
"md-nav__icon md-icon"></span>
1541 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1542 <label class=
"md-nav__title" for=
"__nav_6_2">
1543 <span class=
"md-nav__icon md-icon"></span>
1544 Migrating from WSC
5.2
1546 <ul class=
"md-nav__list" data-md-scrollfix
>
1552 <li class=
"md-nav__item">
1553 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1564 <li class=
"md-nav__item">
1565 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1566 Templates and Languages
1576 <li class=
"md-nav__item">
1577 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1578 Third Party Libraries
1595 <li class=
"md-nav__item md-nav__item--nested">
1598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1600 <label class=
"md-nav__link" for=
"__nav_6_3">
1601 Migrating from WSC
3.1
1602 <span class=
"md-nav__icon md-icon"></span>
1604 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1605 <label class=
"md-nav__title" for=
"__nav_6_3">
1606 <span class=
"md-nav__icon md-icon"></span>
1607 Migrating from WSC
3.1
1609 <ul class=
"md-nav__list" data-md-scrollfix
>
1615 <li class=
"md-nav__item">
1616 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1634 <li class=
"md-nav__item md-nav__item--nested">
1637 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1639 <label class=
"md-nav__link" for=
"__nav_6_4">
1640 Migrating from WSC
3.0
1641 <span class=
"md-nav__icon md-icon"></span>
1643 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1644 <label class=
"md-nav__title" for=
"__nav_6_4">
1645 <span class=
"md-nav__icon md-icon"></span>
1646 Migrating from WSC
3.0
1648 <ul class=
"md-nav__list" data-md-scrollfix
>
1654 <li class=
"md-nav__item">
1655 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1666 <li class=
"md-nav__item">
1667 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1678 <li class=
"md-nav__item">
1679 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1690 <li class=
"md-nav__item">
1691 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1702 <li class=
"md-nav__item">
1703 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1721 <li class=
"md-nav__item md-nav__item--nested">
1724 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1726 <label class=
"md-nav__link" for=
"__nav_6_5">
1727 Migrating from WCF
2.1
1728 <span class=
"md-nav__icon md-icon"></span>
1730 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1731 <label class=
"md-nav__title" for=
"__nav_6_5">
1732 <span class=
"md-nav__icon md-icon"></span>
1733 Migrating from WCF
2.1
1735 <ul class=
"md-nav__list" data-md-scrollfix
>
1741 <li class=
"md-nav__item">
1742 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1753 <li class=
"md-nav__item">
1754 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1765 <li class=
"md-nav__item">
1766 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1777 <li class=
"md-nav__item">
1778 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1805 <li class=
"md-nav__item md-nav__item--nested">
1808 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1810 <label class=
"md-nav__link" for=
"__nav_7">
1812 <span class=
"md-nav__icon md-icon"></span>
1814 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1815 <label class=
"md-nav__title" for=
"__nav_7">
1816 <span class=
"md-nav__icon md-icon"></span>
1819 <ul class=
"md-nav__list" data-md-scrollfix
>
1826 <li class=
"md-nav__item md-nav__item--nested">
1829 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1831 <label class=
"md-nav__link" for=
"__nav_7_1">
1833 <span class=
"md-nav__icon md-icon"></span>
1835 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1836 <label class=
"md-nav__title" for=
"__nav_7_1">
1837 <span class=
"md-nav__icon md-icon"></span>
1840 <ul class=
"md-nav__list" data-md-scrollfix
>
1846 <li class=
"md-nav__item">
1847 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1858 <li class=
"md-nav__item">
1859 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1870 <li class=
"md-nav__item">
1871 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1882 <li class=
"md-nav__item">
1883 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1910 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1911 <div class=
"md-sidebar__scrollwrap">
1912 <div class=
"md-sidebar__inner">
1914 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1920 <label class=
"md-nav__title" for=
"__toc">
1921 <span class=
"md-nav__icon md-icon"></span>
1924 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1926 <li class=
"md-nav__item">
1927 <a href=
"#archive" class=
"md-nav__link">
1933 <li class=
"md-nav__item">
1934 <a href=
"#example-in-packagexml" class=
"md-nav__link">
1935 Example in package.xml
1948 <div class=
"md-content" data-md-component=
"content">
1949 <article class=
"md-content__inner md-typeset">
1952 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/file.md" title=
"Edit this page" class=
"md-content__button md-icon">
1953 <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>
1957 <h1 id=
"file-package-installation-plugin">File Package Installation Plugin
<a class=
"headerlink" href=
"#file-package-installation-plugin" title=
"Permanent link">#
</a></h1>
1958 <p>Adds any type of files with the exception of templates.
</p>
1959 <div class=
"admonition warning">
1960 <p class=
"admonition-title">You cannot overwrite files provided by other packages.
</p>
1962 <p>The
<code>application
</code> attribute behaves like it does for
<a href=
"../acp-template/#application">acp templates
</a>.
</p>
1963 <h2 id=
"archive">Archive
<a class=
"headerlink" href=
"#archive" title=
"Permanent link">#
</a></h2>
1964 <p>The
<code>acpTemplate
</code> package installation plugins expects a
<code>.tar
</code> (recommended) or
<code>.tar.gz
</code> archive.
1965 The file path given in the
<code>instruction
</code> element as its value must be relative to the
<code>package.xml
</code> file.
</p>
1966 <h2 id=
"example-in-packagexml">Example in
<code>package.xml
</code><a class=
"headerlink" href=
"#example-in-packagexml" title=
"Permanent link">#
</a></h2>
1967 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"file
"</span> <span class=
"nt">/
></span>
1968 <span class=
"c"><!-- is the same as --
></span>
1969 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"file
"</span><span class=
"nt">></span>files.tar
<span class=
"nt"></instruction
></span>
1971 <span class=
"c"><!-- if an application
"com.woltlab.example
" is being installed, the following lines are equivalent --
></span>
1972 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"file
"</span> <span class=
"nt">/
></span>
1973 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"file
"</span> <span class=
"na">application=
</span><span class=
"s">"example
"</span> <span class=
"nt">/
></span>
1975 <span class=
"c"><!-- if the same application wants to install additional files, in WoltLab Suite Core
's directory: --
></span>
1976 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"file
"</span> <span class=
"na">application=
</span><span class=
"s">"wcf
"</span><span class=
"nt">></span>files_wcf.tar
<span class=
"nt"></instruction
></span>
1983 <div class=
"md-source-date">
1986 Last update:
2021-
01-
08
2005 <footer class=
"md-footer">
2007 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2009 <a href=
"../event-listener/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2010 <div class=
"md-footer__button md-icon">
2011 <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>
2013 <div class=
"md-footer__title">
2014 <div class=
"md-ellipsis">
2015 <span class=
"md-footer__direction">
2024 <a href=
"../language/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2025 <div class=
"md-footer__title">
2026 <div class=
"md-ellipsis">
2027 <span class=
"md-footer__direction">
2033 <div class=
"md-footer__button md-icon">
2034 <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>
2040 <div class=
"md-footer-meta md-typeset">
2041 <div class=
"md-footer-meta__inner md-grid">
2042 <div class=
"md-footer-copyright">
2044 <div class=
"md-footer-copyright__highlight">
2045 Copyright ©
2020 WoltLab GmbH
2049 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2054 <div class=
"md-footer-copyright">
2055 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2056 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2063 <div class=
"md-dialog" data-md-component=
"dialog">
2064 <div class=
"md-dialog__inner md-typeset"></div>
2066 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../../assets/javascripts/workers/search.fe42c31b.min.js",
"version": {
"provider":
"mike"}}
</script>
2069 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>