3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"shortcut icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.0.5">
17 <title>file - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.77f3fd56.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.7fa14f5b.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=
"">
56 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
57 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
58 <label class=
"md-overlay" for=
"__drawer"></label>
59 <div data-md-component=
"skip">
62 <a href=
"#file-package-installation-plugin" class=
"md-skip">
67 <div data-md-component=
"announce">
69 <aside class=
"md-announce">
70 <div class=
"md-announce__inner md-grid md-typeset">
72 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
81 <header class=
"md-header" data-md-component=
"header">
82 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
83 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation">
85 <img src=
"../../../assets/logo.png" alt=
"logo">
88 <label class=
"md-header__button md-icon" for=
"__drawer">
89 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
91 <div class=
"md-header__title" data-md-component=
"header-title">
92 <div class=
"md-header__ellipsis">
93 <div class=
"md-header__topic">
94 <span class=
"md-ellipsis">
95 WoltLab Suite Documentation
98 <div class=
"md-header__topic" data-md-component=
"header-topic">
99 <span class=
"md-ellipsis">
107 <div class=
"md-header__options">
111 <label class=
"md-header__button md-icon" for=
"__search">
112 <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>
115 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
116 <label class=
"md-search__overlay" for=
"__search"></label>
117 <div class=
"md-search__inner" role=
"search">
118 <form class=
"md-search__form" name=
"search">
119 <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
>
120 <label class=
"md-search__icon 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>
122 <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>
124 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
125 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
128 <div class=
"md-search__output">
129 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
130 <div class=
"md-search-result" data-md-component=
"search-result">
131 <div class=
"md-search-result__meta">
134 <ol class=
"md-search-result__list"></ol>
142 <div class=
"md-header__source">
144 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
145 <div class=
"md-source__icon md-icon">
147 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 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>
149 <div class=
"md-source__repository">
158 <div class=
"md-container" data-md-component=
"container">
163 <main class=
"md-main" data-md-component=
"main">
164 <div class=
"md-main__inner md-grid">
168 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
169 <div class=
"md-sidebar__scrollwrap">
170 <div class=
"md-sidebar__inner">
176 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
177 <label class=
"md-nav__title" for=
"__drawer">
178 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
180 <img src=
"../../../assets/logo.png" alt=
"logo">
183 WoltLab Suite Documentation
186 <div class=
"md-nav__source">
188 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
189 <div class=
"md-source__icon md-icon">
191 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 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>
193 <div class=
"md-source__repository">
199 <ul class=
"md-nav__list" data-md-scrollfix
>
208 <li class=
"md-nav__item">
209 <a href=
"../../../getting-started/" class=
"md-nav__link">
224 <li class=
"md-nav__item md-nav__item--nested">
227 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
229 <label class=
"md-nav__link" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
233 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
234 <label class=
"md-nav__title" for=
"__nav_2">
235 <span class=
"md-nav__icon md-icon"></span>
238 <ul class=
"md-nav__list" data-md-scrollfix
>
244 <li class=
"md-nav__item">
245 <a href=
"../../../php/pages/" class=
"md-nav__link">
256 <li class=
"md-nav__item">
257 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
268 <li class=
"md-nav__item">
269 <a href=
"../../../php/database-access/" class=
"md-nav__link">
280 <li class=
"md-nav__item">
281 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
293 <li class=
"md-nav__item md-nav__item--nested">
296 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
298 <label class=
"md-nav__link" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
302 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
303 <label class=
"md-nav__title" for=
"__nav_2_5">
304 <span class=
"md-nav__icon md-icon"></span>
307 <ul class=
"md-nav__list" data-md-scrollfix
>
313 <li class=
"md-nav__item">
314 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
325 <li class=
"md-nav__item">
326 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
337 <li class=
"md-nav__item">
338 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
349 <li class=
"md-nav__item">
350 <a href=
"../../../php/api/events/" class=
"md-nav__link">
362 <li class=
"md-nav__item md-nav__item--nested">
365 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
367 <label class=
"md-nav__link" for=
"__nav_2_5_5">
369 <span class=
"md-nav__icon md-icon"></span>
371 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
372 <label class=
"md-nav__title" for=
"__nav_2_5_5">
373 <span class=
"md-nav__icon md-icon"></span>
376 <ul class=
"md-nav__list" data-md-scrollfix
>
382 <li class=
"md-nav__item">
383 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
394 <li class=
"md-nav__item">
395 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
406 <li class=
"md-nav__item">
407 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
418 <li class=
"md-nav__item">
419 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
430 <li class=
"md-nav__item">
431 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
448 <li class=
"md-nav__item">
449 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
450 Package Installation Plugins
460 <li class=
"md-nav__item">
461 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
472 <li class=
"md-nav__item">
473 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
484 <li class=
"md-nav__item">
485 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
502 <li class=
"md-nav__item">
503 <a href=
"../../../php/code-style/" class=
"md-nav__link">
514 <li class=
"md-nav__item">
515 <a href=
"../../../php/apps/" class=
"md-nav__link">
526 <li class=
"md-nav__item">
527 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
548 <li class=
"md-nav__item md-nav__item--nested">
551 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
553 <label class=
"md-nav__link" for=
"__nav_3">
554 Languages, Templates & CSS
555 <span class=
"md-nav__icon md-icon"></span>
557 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
558 <label class=
"md-nav__title" for=
"__nav_3">
559 <span class=
"md-nav__icon md-icon"></span>
560 Languages, Templates & CSS
562 <ul class=
"md-nav__list" data-md-scrollfix
>
568 <li class=
"md-nav__item">
569 <a href=
"../../../view/languages/" class=
"md-nav__link">
580 <li class=
"md-nav__item">
581 <a href=
"../../../view/templates/" class=
"md-nav__link">
592 <li class=
"md-nav__item">
593 <a href=
"../../../view/css/" class=
"md-nav__link">
614 <li class=
"md-nav__item md-nav__item--nested">
617 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
619 <label class=
"md-nav__link" for=
"__nav_4">
621 <span class=
"md-nav__icon md-icon"></span>
623 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
624 <label class=
"md-nav__title" for=
"__nav_4">
625 <span class=
"md-nav__icon md-icon"></span>
628 <ul class=
"md-nav__list" data-md-scrollfix
>
634 <li class=
"md-nav__item">
635 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
647 <li class=
"md-nav__item md-nav__item--nested">
650 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
652 <label class=
"md-nav__link" for=
"__nav_4_2">
654 <span class=
"md-nav__icon md-icon"></span>
656 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
657 <label class=
"md-nav__title" for=
"__nav_4_2">
658 <span class=
"md-nav__icon md-icon"></span>
661 <ul class=
"md-nav__list" data-md-scrollfix
>
667 <li class=
"md-nav__item">
668 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
679 <li class=
"md-nav__item">
680 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
691 <li class=
"md-nav__item">
692 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
703 <li class=
"md-nav__item">
704 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
715 <li class=
"md-nav__item">
716 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
727 <li class=
"md-nav__item">
728 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
739 <li class=
"md-nav__item">
740 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
751 <li class=
"md-nav__item">
752 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
753 Browser and Screen Sizes
763 <li class=
"md-nav__item">
764 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
781 <li class=
"md-nav__item">
782 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
793 <li class=
"md-nav__item">
794 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
805 <li class=
"md-nav__item">
806 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
829 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
832 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
834 <label class=
"md-nav__link" for=
"__nav_5">
836 <span class=
"md-nav__icon md-icon"></span>
838 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
839 <label class=
"md-nav__title" for=
"__nav_5">
840 <span class=
"md-nav__icon md-icon"></span>
843 <ul class=
"md-nav__list" data-md-scrollfix
>
849 <li class=
"md-nav__item">
850 <a href=
"../../package-xml/" class=
"md-nav__link">
864 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
867 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
869 <label class=
"md-nav__link" for=
"__nav_5_2">
871 <span class=
"md-nav__icon md-icon"></span>
873 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
874 <label class=
"md-nav__title" for=
"__nav_5_2">
875 <span class=
"md-nav__icon md-icon"></span>
878 <ul class=
"md-nav__list" data-md-scrollfix
>
884 <li class=
"md-nav__item">
885 <a href=
"../" class=
"md-nav__link">
896 <li class=
"md-nav__item">
897 <a href=
"../acl-option/" class=
"md-nav__link">
908 <li class=
"md-nav__item">
909 <a href=
"../acp-menu/" class=
"md-nav__link">
920 <li class=
"md-nav__item">
921 <a href=
"../acp-search-provider/" class=
"md-nav__link">
932 <li class=
"md-nav__item">
933 <a href=
"../acp-template/" class=
"md-nav__link">
944 <li class=
"md-nav__item">
945 <a href=
"../bbcode/" class=
"md-nav__link">
956 <li class=
"md-nav__item">
957 <a href=
"../box/" class=
"md-nav__link">
968 <li class=
"md-nav__item">
969 <a href=
"../clipboard-action/" class=
"md-nav__link">
980 <li class=
"md-nav__item">
981 <a href=
"../core-object/" class=
"md-nav__link">
992 <li class=
"md-nav__item">
993 <a href=
"../cronjob/" class=
"md-nav__link">
1004 <li class=
"md-nav__item">
1005 <a href=
"../event-listener/" class=
"md-nav__link">
1018 <li class=
"md-nav__item md-nav__item--active">
1020 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1025 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1027 <span class=
"md-nav__icon md-icon"></span>
1030 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1035 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1041 <label class=
"md-nav__title" for=
"__toc">
1042 <span class=
"md-nav__icon md-icon"></span>
1045 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1047 <li class=
"md-nav__item">
1048 <a href=
"#archive" class=
"md-nav__link">
1054 <li class=
"md-nav__item">
1055 <a href=
"#example-in-packagexml" class=
"md-nav__link">
1056 Example in package.xml
1073 <li class=
"md-nav__item">
1074 <a href=
"../language/" class=
"md-nav__link">
1085 <li class=
"md-nav__item">
1086 <a href=
"../media-provider/" class=
"md-nav__link">
1097 <li class=
"md-nav__item">
1098 <a href=
"../menu/" class=
"md-nav__link">
1109 <li class=
"md-nav__item">
1110 <a href=
"../menu-item/" class=
"md-nav__link">
1121 <li class=
"md-nav__item">
1122 <a href=
"../object-type/" class=
"md-nav__link">
1133 <li class=
"md-nav__item">
1134 <a href=
"../object-type-definition/" class=
"md-nav__link">
1135 objectTypeDefinition
1145 <li class=
"md-nav__item">
1146 <a href=
"../option/" class=
"md-nav__link">
1157 <li class=
"md-nav__item">
1158 <a href=
"../page/" class=
"md-nav__link">
1169 <li class=
"md-nav__item">
1170 <a href=
"../pip/" class=
"md-nav__link">
1181 <li class=
"md-nav__item">
1182 <a href=
"../script/" class=
"md-nav__link">
1193 <li class=
"md-nav__item">
1194 <a href=
"../smiley/" class=
"md-nav__link">
1205 <li class=
"md-nav__item">
1206 <a href=
"../sql/" class=
"md-nav__link">
1217 <li class=
"md-nav__item">
1218 <a href=
"../style/" class=
"md-nav__link">
1229 <li class=
"md-nav__item">
1230 <a href=
"../template/" class=
"md-nav__link">
1241 <li class=
"md-nav__item">
1242 <a href=
"../template-listener/" class=
"md-nav__link">
1253 <li class=
"md-nav__item">
1254 <a href=
"../user-group-option/" class=
"md-nav__link">
1265 <li class=
"md-nav__item">
1266 <a href=
"../user-menu/" class=
"md-nav__link">
1277 <li class=
"md-nav__item">
1278 <a href=
"../user-notification-event/" class=
"md-nav__link">
1279 userNotificationEvent
1289 <li class=
"md-nav__item">
1290 <a href=
"../user-option/" class=
"md-nav__link">
1301 <li class=
"md-nav__item">
1302 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1319 <li class=
"md-nav__item">
1320 <a href=
"../../database-php-api/" class=
"md-nav__link">
1341 <li class=
"md-nav__item md-nav__item--nested">
1344 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1346 <label class=
"md-nav__link" for=
"__nav_6">
1348 <span class=
"md-nav__icon md-icon"></span>
1350 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1351 <label class=
"md-nav__title" for=
"__nav_6">
1352 <span class=
"md-nav__icon md-icon"></span>
1355 <ul class=
"md-nav__list" data-md-scrollfix
>
1362 <li class=
"md-nav__item md-nav__item--nested">
1365 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1367 <label class=
"md-nav__link" for=
"__nav_6_1">
1368 Migrating from WSC
5.3
1369 <span class=
"md-nav__icon md-icon"></span>
1371 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1372 <label class=
"md-nav__title" for=
"__nav_6_1">
1373 <span class=
"md-nav__icon md-icon"></span>
1374 Migrating from WSC
5.3
1376 <ul class=
"md-nav__list" data-md-scrollfix
>
1382 <li class=
"md-nav__item">
1383 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1394 <li class=
"md-nav__item">
1395 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1396 Session Handling and Authentication
1406 <li class=
"md-nav__item">
1407 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1418 <li class=
"md-nav__item">
1419 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1430 <li class=
"md-nav__item">
1431 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1432 Third Party Libraries
1449 <li class=
"md-nav__item md-nav__item--nested">
1452 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1454 <label class=
"md-nav__link" for=
"__nav_6_2">
1455 Migrating from WSC
5.2
1456 <span class=
"md-nav__icon md-icon"></span>
1458 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1459 <label class=
"md-nav__title" for=
"__nav_6_2">
1460 <span class=
"md-nav__icon md-icon"></span>
1461 Migrating from WSC
5.2
1463 <ul class=
"md-nav__list" data-md-scrollfix
>
1469 <li class=
"md-nav__item">
1470 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1481 <li class=
"md-nav__item">
1482 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1483 Templates and Languages
1493 <li class=
"md-nav__item">
1494 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1495 Third Party Libraries
1512 <li class=
"md-nav__item md-nav__item--nested">
1515 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1517 <label class=
"md-nav__link" for=
"__nav_6_3">
1518 Migrating from WSC
3.1
1519 <span class=
"md-nav__icon md-icon"></span>
1521 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1522 <label class=
"md-nav__title" for=
"__nav_6_3">
1523 <span class=
"md-nav__icon md-icon"></span>
1524 Migrating from WSC
3.1
1526 <ul class=
"md-nav__list" data-md-scrollfix
>
1532 <li class=
"md-nav__item">
1533 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1551 <li class=
"md-nav__item md-nav__item--nested">
1554 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1556 <label class=
"md-nav__link" for=
"__nav_6_4">
1557 Migrating from WSC
3.0
1558 <span class=
"md-nav__icon md-icon"></span>
1560 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1561 <label class=
"md-nav__title" for=
"__nav_6_4">
1562 <span class=
"md-nav__icon md-icon"></span>
1563 Migrating from WSC
3.0
1565 <ul class=
"md-nav__list" data-md-scrollfix
>
1571 <li class=
"md-nav__item">
1572 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1583 <li class=
"md-nav__item">
1584 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1595 <li class=
"md-nav__item">
1596 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1607 <li class=
"md-nav__item">
1608 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1619 <li class=
"md-nav__item">
1620 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1638 <li class=
"md-nav__item md-nav__item--nested">
1641 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1643 <label class=
"md-nav__link" for=
"__nav_6_5">
1644 Migrating from WCF
2.1
1645 <span class=
"md-nav__icon md-icon"></span>
1647 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1648 <label class=
"md-nav__title" for=
"__nav_6_5">
1649 <span class=
"md-nav__icon md-icon"></span>
1650 Migrating from WCF
2.1
1652 <ul class=
"md-nav__list" data-md-scrollfix
>
1658 <li class=
"md-nav__item">
1659 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1670 <li class=
"md-nav__item">
1671 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1682 <li class=
"md-nav__item">
1683 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1694 <li class=
"md-nav__item">
1695 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1722 <li class=
"md-nav__item md-nav__item--nested">
1725 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1727 <label class=
"md-nav__link" for=
"__nav_7">
1729 <span class=
"md-nav__icon md-icon"></span>
1731 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1732 <label class=
"md-nav__title" for=
"__nav_7">
1733 <span class=
"md-nav__icon md-icon"></span>
1736 <ul class=
"md-nav__list" data-md-scrollfix
>
1743 <li class=
"md-nav__item md-nav__item--nested">
1746 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1748 <label class=
"md-nav__link" for=
"__nav_7_1">
1750 <span class=
"md-nav__icon md-icon"></span>
1752 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1753 <label class=
"md-nav__title" for=
"__nav_7_1">
1754 <span class=
"md-nav__icon md-icon"></span>
1757 <ul class=
"md-nav__list" data-md-scrollfix
>
1763 <li class=
"md-nav__item">
1764 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1775 <li class=
"md-nav__item">
1776 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1787 <li class=
"md-nav__item">
1788 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1799 <li class=
"md-nav__item">
1800 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1827 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1828 <div class=
"md-sidebar__scrollwrap">
1829 <div class=
"md-sidebar__inner">
1831 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1837 <label class=
"md-nav__title" for=
"__toc">
1838 <span class=
"md-nav__icon md-icon"></span>
1841 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1843 <li class=
"md-nav__item">
1844 <a href=
"#archive" class=
"md-nav__link">
1850 <li class=
"md-nav__item">
1851 <a href=
"#example-in-packagexml" class=
"md-nav__link">
1852 Example in package.xml
1865 <div class=
"md-content" data-md-component=
"content">
1866 <article class=
"md-content__inner md-typeset">
1869 <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">
1870 <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>
1874 <h1 id=
"file-package-installation-plugin">File Package Installation Plugin
<a class=
"headerlink" href=
"#file-package-installation-plugin" title=
"Permanent link">#
</a></h1>
1875 <p>Adds any type of files with the exception of templates.
</p>
1876 <div class=
"admonition warning">
1877 <p class=
"admonition-title">You cannot overwrite files provided by other packages.
</p>
1879 <p>The
<code>application
</code> attribute behaves like it does for
<a href=
"../acp-template/#application">acp templates
</a>.
</p>
1880 <h2 id=
"archive">Archive
<a class=
"headerlink" href=
"#archive" title=
"Permanent link">#
</a></h2>
1881 <p>The
<code>acpTemplate
</code> package installation plugins expects a
<code>.tar
</code> (recommended) or
<code>.tar.gz
</code> archive.
1882 The file path given in the
<code>instruction
</code> element as its value must be relative to the
<code>package.xml
</code> file.
</p>
1883 <h2 id=
"example-in-packagexml">Example in
<code>package.xml
</code><a class=
"headerlink" href=
"#example-in-packagexml" title=
"Permanent link">#
</a></h2>
1884 <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>
1885 <span class=
"c"><!-- is the same as --
></span>
1886 <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>
1888 <span class=
"c"><!-- if an application
"com.woltlab.example
" is being installed, the following lines are equivalent --
></span>
1889 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"file
"</span> <span class=
"nt">/
></span>
1890 <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>
1892 <span class=
"c"><!-- if the same application wants to install additional files, in WoltLab Suite Core
's directory: --
></span>
1893 <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>
1900 <div class=
"md-source-date">
1903 Last update:
2021-
01-
08
1921 <footer class=
"md-footer">
1923 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
1925 <a href=
"../event-listener/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
1926 <div class=
"md-footer__button md-icon">
1927 <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>
1929 <div class=
"md-footer__title">
1930 <div class=
"md-ellipsis">
1931 <span class=
"md-footer__direction">
1940 <a href=
"../language/" class=
"md-footer__link md-footer__link--next" rel=
"next">
1941 <div class=
"md-footer__title">
1942 <div class=
"md-ellipsis">
1943 <span class=
"md-footer__direction">
1949 <div class=
"md-footer__button md-icon">
1950 <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>
1956 <div class=
"md-footer-meta md-typeset">
1957 <div class=
"md-footer-meta__inner md-grid">
1958 <div class=
"md-footer-copyright">
1960 <div class=
"md-footer-copyright__highlight">
1961 Copyright ©
2020 WoltLab GmbH
1965 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
1970 <div class=
"md-footer-copyright">
1971 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
1972 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
1979 <div class=
"md-dialog" data-md-component=
"dialog">
1980 <div class=
"md-dialog__inner md-typeset"></div>
1982 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../../assets/javascripts/workers/search.fb4a9340.min.js",
"version": {
"provider":
"mike"}}
</script>
1985 <script src=
"../../../assets/javascripts/bundle.5cf3e710.min.js"></script>