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>package.xml - 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=
"#packagexml" 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>
145 <div class=
"md-container" data-md-component=
"container">
150 <main class=
"md-main" data-md-component=
"main">
151 <div class=
"md-main__inner md-grid">
155 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
156 <div class=
"md-sidebar__scrollwrap">
157 <div class=
"md-sidebar__inner">
163 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
164 <label class=
"md-nav__title" for=
"__drawer">
165 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
167 <img src=
"../../assets/logo.png" alt=
"logo">
170 WoltLab Suite Documentation
173 <ul class=
"md-nav__list" data-md-scrollfix
>
182 <li class=
"md-nav__item">
183 <a href=
"../../getting-started/" class=
"md-nav__link">
198 <li class=
"md-nav__item md-nav__item--nested">
201 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
203 <label class=
"md-nav__link" for=
"__nav_2">
205 <span class=
"md-nav__icon md-icon"></span>
207 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
208 <label class=
"md-nav__title" for=
"__nav_2">
209 <span class=
"md-nav__icon md-icon"></span>
212 <ul class=
"md-nav__list" data-md-scrollfix
>
218 <li class=
"md-nav__item">
219 <a href=
"../../php/pages/" class=
"md-nav__link">
230 <li class=
"md-nav__item">
231 <a href=
"../../php/database-objects/" class=
"md-nav__link">
242 <li class=
"md-nav__item">
243 <a href=
"../../php/database-access/" class=
"md-nav__link">
254 <li class=
"md-nav__item">
255 <a href=
"../../php/exceptions/" class=
"md-nav__link">
267 <li class=
"md-nav__item md-nav__item--nested">
270 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
272 <label class=
"md-nav__link" for=
"__nav_2_5">
274 <span class=
"md-nav__icon md-icon"></span>
276 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
277 <label class=
"md-nav__title" for=
"__nav_2_5">
278 <span class=
"md-nav__icon md-icon"></span>
281 <ul class=
"md-nav__list" data-md-scrollfix
>
287 <li class=
"md-nav__item">
288 <a href=
"../../php/api/caches/" class=
"md-nav__link">
299 <li class=
"md-nav__item">
300 <a href=
"../../php/api/comments/" class=
"md-nav__link">
311 <li class=
"md-nav__item">
312 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
323 <li class=
"md-nav__item">
324 <a href=
"../../php/api/events/" class=
"md-nav__link">
336 <li class=
"md-nav__item md-nav__item--nested">
339 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
341 <label class=
"md-nav__link" for=
"__nav_2_5_5">
343 <span class=
"md-nav__icon md-icon"></span>
345 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
346 <label class=
"md-nav__title" for=
"__nav_2_5_5">
347 <span class=
"md-nav__icon md-icon"></span>
350 <ul class=
"md-nav__list" data-md-scrollfix
>
356 <li class=
"md-nav__item">
357 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
368 <li class=
"md-nav__item">
369 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
380 <li class=
"md-nav__item">
381 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
392 <li class=
"md-nav__item">
393 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
404 <li class=
"md-nav__item">
405 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
422 <li class=
"md-nav__item">
423 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
424 Package Installation Plugins
434 <li class=
"md-nav__item">
435 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
446 <li class=
"md-nav__item">
447 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
458 <li class=
"md-nav__item">
459 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
476 <li class=
"md-nav__item">
477 <a href=
"../../php/code-style/" class=
"md-nav__link">
488 <li class=
"md-nav__item">
489 <a href=
"../../php/apps/" class=
"md-nav__link">
500 <li class=
"md-nav__item">
501 <a href=
"../../php/gdpr/" class=
"md-nav__link">
522 <li class=
"md-nav__item md-nav__item--nested">
525 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
527 <label class=
"md-nav__link" for=
"__nav_3">
528 Languages, Templates & CSS
529 <span class=
"md-nav__icon md-icon"></span>
531 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
532 <label class=
"md-nav__title" for=
"__nav_3">
533 <span class=
"md-nav__icon md-icon"></span>
534 Languages, Templates & CSS
536 <ul class=
"md-nav__list" data-md-scrollfix
>
542 <li class=
"md-nav__item">
543 <a href=
"../../view/languages/" class=
"md-nav__link">
554 <li class=
"md-nav__item">
555 <a href=
"../../view/templates/" class=
"md-nav__link">
566 <li class=
"md-nav__item">
567 <a href=
"../../view/css/" class=
"md-nav__link">
588 <li class=
"md-nav__item md-nav__item--nested">
591 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
593 <label class=
"md-nav__link" for=
"__nav_4">
595 <span class=
"md-nav__icon md-icon"></span>
597 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
598 <label class=
"md-nav__title" for=
"__nav_4">
599 <span class=
"md-nav__icon md-icon"></span>
602 <ul class=
"md-nav__list" data-md-scrollfix
>
608 <li class=
"md-nav__item">
609 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
621 <li class=
"md-nav__item md-nav__item--nested">
624 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
626 <label class=
"md-nav__link" for=
"__nav_4_2">
628 <span class=
"md-nav__icon md-icon"></span>
630 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
631 <label class=
"md-nav__title" for=
"__nav_4_2">
632 <span class=
"md-nav__icon md-icon"></span>
635 <ul class=
"md-nav__list" data-md-scrollfix
>
641 <li class=
"md-nav__item">
642 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
653 <li class=
"md-nav__item">
654 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
665 <li class=
"md-nav__item">
666 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
677 <li class=
"md-nav__item">
678 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
689 <li class=
"md-nav__item">
690 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
701 <li class=
"md-nav__item">
702 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
713 <li class=
"md-nav__item">
714 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
725 <li class=
"md-nav__item">
726 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
727 Browser and Screen Sizes
737 <li class=
"md-nav__item">
738 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
755 <li class=
"md-nav__item">
756 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
767 <li class=
"md-nav__item">
768 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
779 <li class=
"md-nav__item">
780 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
803 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
806 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
808 <label class=
"md-nav__link" for=
"__nav_5">
810 <span class=
"md-nav__icon md-icon"></span>
812 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
813 <label class=
"md-nav__title" for=
"__nav_5">
814 <span class=
"md-nav__icon md-icon"></span>
817 <ul class=
"md-nav__list" data-md-scrollfix
>
825 <li class=
"md-nav__item md-nav__item--active">
827 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
832 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
834 <span class=
"md-nav__icon md-icon"></span>
837 <a href=
"./" class=
"md-nav__link md-nav__link--active">
842 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
848 <label class=
"md-nav__title" for=
"__toc">
849 <span class=
"md-nav__icon md-icon"></span>
852 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
854 <li class=
"md-nav__item">
855 <a href=
"#example" class=
"md-nav__link">
861 <li class=
"md-nav__item">
862 <a href=
"#elements" class=
"md-nav__link">
866 <nav class=
"md-nav" aria-label=
"Elements">
867 <ul class=
"md-nav__list">
869 <li class=
"md-nav__item">
870 <a href=
"#package" class=
"md-nav__link">
876 <li class=
"md-nav__item">
877 <a href=
"#packageinformation" class=
"md-nav__link">
878 <packageinformation
>
881 <nav class=
"md-nav" aria-label=
"<packageinformation>">
882 <ul class=
"md-nav__list">
884 <li class=
"md-nav__item">
885 <a href=
"#packagename" class=
"md-nav__link">
891 <li class=
"md-nav__item">
892 <a href=
"#packagedescription" class=
"md-nav__link">
893 <packagedescription
>
898 <li class=
"md-nav__item">
899 <a href=
"#version" class=
"md-nav__link">
905 <li class=
"md-nav__item">
906 <a href=
"#date" class=
"md-nav__link">
917 <li class=
"md-nav__item">
918 <a href=
"#authorinformation" class=
"md-nav__link">
919 <authorinformation
>
922 <nav class=
"md-nav" aria-label=
"<authorinformation>">
923 <ul class=
"md-nav__list">
925 <li class=
"md-nav__item">
926 <a href=
"#author" class=
"md-nav__link">
932 <li class=
"md-nav__item">
933 <a href=
"#authorurl" class=
"md-nav__link">
944 <li class=
"md-nav__item">
945 <a href=
"#requiredpackages" class=
"md-nav__link">
946 <requiredpackages
>
949 <nav class=
"md-nav" aria-label=
"<requiredpackages>">
950 <ul class=
"md-nav__list">
952 <li class=
"md-nav__item">
953 <a href=
"#requiredpackage" class=
"md-nav__link">
954 <requiredpackage
>
964 <li class=
"md-nav__item">
965 <a href=
"#optionalpackage" class=
"md-nav__link">
966 <optionalpackage
>
969 <nav class=
"md-nav" aria-label=
"<optionalpackage>">
970 <ul class=
"md-nav__list">
972 <li class=
"md-nav__item">
973 <a href=
"#optionalpackage_1" class=
"md-nav__link">
974 <optionalpackage
>
984 <li class=
"md-nav__item">
985 <a href=
"#excludedpackages" class=
"md-nav__link">
986 <excludedpackages
>
989 <nav class=
"md-nav" aria-label=
"<excludedpackages>">
990 <ul class=
"md-nav__list">
992 <li class=
"md-nav__item">
993 <a href=
"#excludedpackage" class=
"md-nav__link">
994 <excludedpackage
>
1004 <li class=
"md-nav__item">
1005 <a href=
"#compatibility" class=
"md-nav__link">
1006 <compatibility
>
1009 <nav class=
"md-nav" aria-label=
"<compatibility>">
1010 <ul class=
"md-nav__list">
1012 <li class=
"md-nav__item">
1013 <a href=
"#existing-api-versions" class=
"md-nav__link">
1014 Existing API versions
1024 <li class=
"md-nav__item">
1025 <a href=
"#instructions" class=
"md-nav__link">
1026 <instructions
>
1029 <nav class=
"md-nav" aria-label=
"<instructions>">
1030 <ul class=
"md-nav__list">
1032 <li class=
"md-nav__item">
1033 <a href=
"#instructions-typeinstall" class=
"md-nav__link">
1034 <instructions
type=
"install">
1039 <li class=
"md-nav__item">
1040 <a href=
"#instructions-typeupdate-fromversion" class=
"md-nav__link">
1041 <instructions
type=
"update" fromversion=
"…">
1046 <li class=
"md-nav__item">
1047 <a href=
"#instruction" class=
"md-nav__link">
1053 <li class=
"md-nav__item">
1054 <a href=
"#void" class=
"md-nav__link">
1083 <li class=
"md-nav__item md-nav__item--nested">
1086 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1088 <label class=
"md-nav__link" for=
"__nav_5_2">
1090 <span class=
"md-nav__icon md-icon"></span>
1092 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1093 <label class=
"md-nav__title" for=
"__nav_5_2">
1094 <span class=
"md-nav__icon md-icon"></span>
1097 <ul class=
"md-nav__list" data-md-scrollfix
>
1103 <li class=
"md-nav__item">
1104 <a href=
"../pip/" class=
"md-nav__link">
1115 <li class=
"md-nav__item">
1116 <a href=
"../pip/acl-option/" class=
"md-nav__link">
1127 <li class=
"md-nav__item">
1128 <a href=
"../pip/acp-menu/" class=
"md-nav__link">
1139 <li class=
"md-nav__item">
1140 <a href=
"../pip/acp-search-provider/" class=
"md-nav__link">
1151 <li class=
"md-nav__item">
1152 <a href=
"../pip/acp-template/" class=
"md-nav__link">
1163 <li class=
"md-nav__item">
1164 <a href=
"../pip/bbcode/" class=
"md-nav__link">
1175 <li class=
"md-nav__item">
1176 <a href=
"../pip/box/" class=
"md-nav__link">
1187 <li class=
"md-nav__item">
1188 <a href=
"../pip/clipboard-action/" class=
"md-nav__link">
1199 <li class=
"md-nav__item">
1200 <a href=
"../pip/core-object/" class=
"md-nav__link">
1211 <li class=
"md-nav__item">
1212 <a href=
"../pip/cronjob/" class=
"md-nav__link">
1223 <li class=
"md-nav__item">
1224 <a href=
"../pip/event-listener/" class=
"md-nav__link">
1235 <li class=
"md-nav__item">
1236 <a href=
"../pip/file/" class=
"md-nav__link">
1247 <li class=
"md-nav__item">
1248 <a href=
"../pip/language/" class=
"md-nav__link">
1259 <li class=
"md-nav__item">
1260 <a href=
"../pip/media-provider/" class=
"md-nav__link">
1271 <li class=
"md-nav__item">
1272 <a href=
"../pip/menu/" class=
"md-nav__link">
1283 <li class=
"md-nav__item">
1284 <a href=
"../pip/menu-item/" class=
"md-nav__link">
1295 <li class=
"md-nav__item">
1296 <a href=
"../pip/object-type/" class=
"md-nav__link">
1307 <li class=
"md-nav__item">
1308 <a href=
"../pip/object-type-definition/" class=
"md-nav__link">
1309 objectTypeDefinition
1319 <li class=
"md-nav__item">
1320 <a href=
"../pip/option/" class=
"md-nav__link">
1331 <li class=
"md-nav__item">
1332 <a href=
"../pip/page/" class=
"md-nav__link">
1343 <li class=
"md-nav__item">
1344 <a href=
"../pip/pip/" class=
"md-nav__link">
1355 <li class=
"md-nav__item">
1356 <a href=
"../pip/script/" class=
"md-nav__link">
1367 <li class=
"md-nav__item">
1368 <a href=
"../pip/smiley/" class=
"md-nav__link">
1379 <li class=
"md-nav__item">
1380 <a href=
"../pip/sql/" class=
"md-nav__link">
1391 <li class=
"md-nav__item">
1392 <a href=
"../pip/style/" class=
"md-nav__link">
1403 <li class=
"md-nav__item">
1404 <a href=
"../pip/template/" class=
"md-nav__link">
1415 <li class=
"md-nav__item">
1416 <a href=
"../pip/template-listener/" class=
"md-nav__link">
1427 <li class=
"md-nav__item">
1428 <a href=
"../pip/user-group-option/" class=
"md-nav__link">
1439 <li class=
"md-nav__item">
1440 <a href=
"../pip/user-menu/" class=
"md-nav__link">
1451 <li class=
"md-nav__item">
1452 <a href=
"../pip/user-notification-event/" class=
"md-nav__link">
1453 userNotificationEvent
1463 <li class=
"md-nav__item">
1464 <a href=
"../pip/user-option/" class=
"md-nav__link">
1475 <li class=
"md-nav__item">
1476 <a href=
"../pip/user-profile-menu/" class=
"md-nav__link">
1493 <li class=
"md-nav__item">
1494 <a href=
"../database-php-api/" class=
"md-nav__link">
1515 <li class=
"md-nav__item md-nav__item--nested">
1518 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1520 <label class=
"md-nav__link" for=
"__nav_6">
1522 <span class=
"md-nav__icon md-icon"></span>
1524 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1525 <label class=
"md-nav__title" for=
"__nav_6">
1526 <span class=
"md-nav__icon md-icon"></span>
1529 <ul class=
"md-nav__list" data-md-scrollfix
>
1536 <li class=
"md-nav__item md-nav__item--nested">
1539 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1541 <label class=
"md-nav__link" for=
"__nav_6_1">
1542 Migrating from WSC
5.3
1543 <span class=
"md-nav__icon md-icon"></span>
1545 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1546 <label class=
"md-nav__title" for=
"__nav_6_1">
1547 <span class=
"md-nav__icon md-icon"></span>
1548 Migrating from WSC
5.3
1550 <ul class=
"md-nav__list" data-md-scrollfix
>
1556 <li class=
"md-nav__item">
1557 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1568 <li class=
"md-nav__item">
1569 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1570 Session Handling and Authentication
1580 <li class=
"md-nav__item">
1581 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1592 <li class=
"md-nav__item">
1593 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1604 <li class=
"md-nav__item">
1605 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1606 Third Party Libraries
1623 <li class=
"md-nav__item md-nav__item--nested">
1626 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1628 <label class=
"md-nav__link" for=
"__nav_6_2">
1629 Migrating from WSC
5.2
1630 <span class=
"md-nav__icon md-icon"></span>
1632 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1633 <label class=
"md-nav__title" for=
"__nav_6_2">
1634 <span class=
"md-nav__icon md-icon"></span>
1635 Migrating from WSC
5.2
1637 <ul class=
"md-nav__list" data-md-scrollfix
>
1643 <li class=
"md-nav__item">
1644 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1655 <li class=
"md-nav__item">
1656 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1657 Templates and Languages
1667 <li class=
"md-nav__item">
1668 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1669 Third Party Libraries
1686 <li class=
"md-nav__item md-nav__item--nested">
1689 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1691 <label class=
"md-nav__link" for=
"__nav_6_3">
1692 Migrating from WSC
3.1
1693 <span class=
"md-nav__icon md-icon"></span>
1695 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1696 <label class=
"md-nav__title" for=
"__nav_6_3">
1697 <span class=
"md-nav__icon md-icon"></span>
1698 Migrating from WSC
3.1
1700 <ul class=
"md-nav__list" data-md-scrollfix
>
1706 <li class=
"md-nav__item">
1707 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1725 <li class=
"md-nav__item md-nav__item--nested">
1728 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1730 <label class=
"md-nav__link" for=
"__nav_6_4">
1731 Migrating from WSC
3.0
1732 <span class=
"md-nav__icon md-icon"></span>
1734 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1735 <label class=
"md-nav__title" for=
"__nav_6_4">
1736 <span class=
"md-nav__icon md-icon"></span>
1737 Migrating from WSC
3.0
1739 <ul class=
"md-nav__list" data-md-scrollfix
>
1745 <li class=
"md-nav__item">
1746 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1757 <li class=
"md-nav__item">
1758 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1769 <li class=
"md-nav__item">
1770 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1781 <li class=
"md-nav__item">
1782 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1793 <li class=
"md-nav__item">
1794 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1812 <li class=
"md-nav__item md-nav__item--nested">
1815 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1817 <label class=
"md-nav__link" for=
"__nav_6_5">
1818 Migrating from WCF
2.1
1819 <span class=
"md-nav__icon md-icon"></span>
1821 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1822 <label class=
"md-nav__title" for=
"__nav_6_5">
1823 <span class=
"md-nav__icon md-icon"></span>
1824 Migrating from WCF
2.1
1826 <ul class=
"md-nav__list" data-md-scrollfix
>
1832 <li class=
"md-nav__item">
1833 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1844 <li class=
"md-nav__item">
1845 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1856 <li class=
"md-nav__item">
1857 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1868 <li class=
"md-nav__item">
1869 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1896 <li class=
"md-nav__item md-nav__item--nested">
1899 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1901 <label class=
"md-nav__link" for=
"__nav_7">
1903 <span class=
"md-nav__icon md-icon"></span>
1905 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1906 <label class=
"md-nav__title" for=
"__nav_7">
1907 <span class=
"md-nav__icon md-icon"></span>
1910 <ul class=
"md-nav__list" data-md-scrollfix
>
1917 <li class=
"md-nav__item md-nav__item--nested">
1920 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1922 <label class=
"md-nav__link" for=
"__nav_7_1">
1924 <span class=
"md-nav__icon md-icon"></span>
1926 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1927 <label class=
"md-nav__title" for=
"__nav_7_1">
1928 <span class=
"md-nav__icon md-icon"></span>
1931 <ul class=
"md-nav__list" data-md-scrollfix
>
1937 <li class=
"md-nav__item">
1938 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1949 <li class=
"md-nav__item">
1950 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1961 <li class=
"md-nav__item">
1962 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1973 <li class=
"md-nav__item">
1974 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
2001 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2002 <div class=
"md-sidebar__scrollwrap">
2003 <div class=
"md-sidebar__inner">
2005 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2011 <label class=
"md-nav__title" for=
"__toc">
2012 <span class=
"md-nav__icon md-icon"></span>
2015 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2017 <li class=
"md-nav__item">
2018 <a href=
"#example" class=
"md-nav__link">
2024 <li class=
"md-nav__item">
2025 <a href=
"#elements" class=
"md-nav__link">
2029 <nav class=
"md-nav" aria-label=
"Elements">
2030 <ul class=
"md-nav__list">
2032 <li class=
"md-nav__item">
2033 <a href=
"#package" class=
"md-nav__link">
2039 <li class=
"md-nav__item">
2040 <a href=
"#packageinformation" class=
"md-nav__link">
2041 <packageinformation
>
2044 <nav class=
"md-nav" aria-label=
"<packageinformation>">
2045 <ul class=
"md-nav__list">
2047 <li class=
"md-nav__item">
2048 <a href=
"#packagename" class=
"md-nav__link">
2054 <li class=
"md-nav__item">
2055 <a href=
"#packagedescription" class=
"md-nav__link">
2056 <packagedescription
>
2061 <li class=
"md-nav__item">
2062 <a href=
"#version" class=
"md-nav__link">
2068 <li class=
"md-nav__item">
2069 <a href=
"#date" class=
"md-nav__link">
2080 <li class=
"md-nav__item">
2081 <a href=
"#authorinformation" class=
"md-nav__link">
2082 <authorinformation
>
2085 <nav class=
"md-nav" aria-label=
"<authorinformation>">
2086 <ul class=
"md-nav__list">
2088 <li class=
"md-nav__item">
2089 <a href=
"#author" class=
"md-nav__link">
2095 <li class=
"md-nav__item">
2096 <a href=
"#authorurl" class=
"md-nav__link">
2107 <li class=
"md-nav__item">
2108 <a href=
"#requiredpackages" class=
"md-nav__link">
2109 <requiredpackages
>
2112 <nav class=
"md-nav" aria-label=
"<requiredpackages>">
2113 <ul class=
"md-nav__list">
2115 <li class=
"md-nav__item">
2116 <a href=
"#requiredpackage" class=
"md-nav__link">
2117 <requiredpackage
>
2127 <li class=
"md-nav__item">
2128 <a href=
"#optionalpackage" class=
"md-nav__link">
2129 <optionalpackage
>
2132 <nav class=
"md-nav" aria-label=
"<optionalpackage>">
2133 <ul class=
"md-nav__list">
2135 <li class=
"md-nav__item">
2136 <a href=
"#optionalpackage_1" class=
"md-nav__link">
2137 <optionalpackage
>
2147 <li class=
"md-nav__item">
2148 <a href=
"#excludedpackages" class=
"md-nav__link">
2149 <excludedpackages
>
2152 <nav class=
"md-nav" aria-label=
"<excludedpackages>">
2153 <ul class=
"md-nav__list">
2155 <li class=
"md-nav__item">
2156 <a href=
"#excludedpackage" class=
"md-nav__link">
2157 <excludedpackage
>
2167 <li class=
"md-nav__item">
2168 <a href=
"#compatibility" class=
"md-nav__link">
2169 <compatibility
>
2172 <nav class=
"md-nav" aria-label=
"<compatibility>">
2173 <ul class=
"md-nav__list">
2175 <li class=
"md-nav__item">
2176 <a href=
"#existing-api-versions" class=
"md-nav__link">
2177 Existing API versions
2187 <li class=
"md-nav__item">
2188 <a href=
"#instructions" class=
"md-nav__link">
2189 <instructions
>
2192 <nav class=
"md-nav" aria-label=
"<instructions>">
2193 <ul class=
"md-nav__list">
2195 <li class=
"md-nav__item">
2196 <a href=
"#instructions-typeinstall" class=
"md-nav__link">
2197 <instructions
type=
"install">
2202 <li class=
"md-nav__item">
2203 <a href=
"#instructions-typeupdate-fromversion" class=
"md-nav__link">
2204 <instructions
type=
"update" fromversion=
"…">
2209 <li class=
"md-nav__item">
2210 <a href=
"#instruction" class=
"md-nav__link">
2216 <li class=
"md-nav__item">
2217 <a href=
"#void" class=
"md-nav__link">
2241 <div class=
"md-content" data-md-component=
"content">
2242 <article class=
"md-content__inner md-typeset">
2246 <h1 id=
"packagexml">package.xml
<a class=
"headerlink" href=
"#packagexml" title=
"Permanent link">#
</a></h1>
2247 <p>The
<code>package.xml
</code> is the core component of every package.
2248 It provides the meta data (e.g. package name, description, author) and the instruction set for a new installation and/or updating from a previous version.
</p>
2249 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
2250 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
2251 <span class=
"nt"><package
</span> <span class=
"na">name=
</span><span class=
"s">"com.example.package
"</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/
2019/package.xsd
"</span><span class=
"nt">></span>
2252 <span class=
"nt"><packageinformation
></span>
2253 <span class=
"nt"><packagename
></span>Simple Package
<span class=
"nt"></packagename
></span>
2254 <span class=
"nt"><packagedescription
></span>A simple package to demonstrate the package system of WoltLab Suite Core
<span class=
"nt"></packagedescription
></span>
2255 <span class=
"nt"><version
></span>1.0.0<span class=
"nt"></version
></span>
2256 <span class=
"nt"><date
></span>2016-
12-
18<span class=
"nt"></date
></span>
2257 <span class=
"nt"></packageinformation
></span>
2259 <span class=
"nt"><authorinformation
></span>
2260 <span class=
"nt"><author
></span>YOUR NAME
<span class=
"nt"></author
></span>
2261 <span class=
"nt"><authorurl
></span>http://www.example.com
<span class=
"nt"></authorurl
></span>
2262 <span class=
"nt"></authorinformation
></span>
2264 <span class=
"nt"><requiredpackages
></span>
2265 <span class=
"nt"><requiredpackage
</span> <span class=
"na">minversion=
</span><span class=
"s">"3.0.0"</span><span class=
"nt">></span>com.woltlab.wcf
<span class=
"nt"></requiredpackage
></span>
2266 <span class=
"nt"></requiredpackages
></span>
2268 <span class=
"nt"><excludedpackages
></span>
2269 <span class=
"nt"><excludedpackage
</span> <span class=
"na">version=
</span><span class=
"s">"6.0.0 Alpha
1"</span><span class=
"nt">></span>com.woltlab.wcf
<span class=
"nt"></excludedpackage
></span>
2270 <span class=
"nt"></excludedpackages
></span>
2272 <span class=
"nt"><instructions
</span> <span class=
"na">type=
</span><span class=
"s">"install
"</span><span class=
"nt">></span>
2273 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"file
"</span> <span class=
"nt">/
></span>
2274 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"template
"</span><span class=
"nt">></span>templates.tar
<span class=
"nt"></instruction
></span>
2275 <span class=
"nt"></instructions
></span>
2276 <span class=
"nt"></package
></span>
2278 <h2 id=
"elements">Elements
<a class=
"headerlink" href=
"#elements" title=
"Permanent link">#
</a></h2>
2279 <h3 id=
"package"><code><package
></code><a class=
"headerlink" href=
"#package" title=
"Permanent link">#
</a></h3>
2280 <p>The root node of every
<code>package.xml
</code> it contains the reference to the namespace and the location of the XML Schema Definition (XSD).
</p>
2281 <p>The attribute
<code>name
</code> is the most important part, it holds the unique package identifier and is mandatory.
2282 It is based upon your domain name and the package name of your choice.
</p>
2283 <p>For example WoltLab Suite Forum (formerly know an WoltLab Burning Board and usually abbreviated as
<code>wbb
</code>) is created by WoltLab which owns the domain
<code>woltlab.com
</code>.
2284 The resulting package identifier is
<code>com.woltlab.wbb
</code> (
<code><tld
>.
<domain
>.
<packageName
></code>).
</p>
2285 <h3 id=
"packageinformation"><code><packageinformation
></code><a class=
"headerlink" href=
"#packageinformation" title=
"Permanent link">#
</a></h3>
2286 <p>Holds the entire meta data of the package.
</p>
2287 <h4 id=
"packagename"><code><packagename
></code><a class=
"headerlink" href=
"#packagename" title=
"Permanent link">#
</a></h4>
2288 <p>This is the actual package name displayed to the end user, this can be anything you want, try to keep it short.
2289 It supports the attribute
<code>languagecode
</code> which allows you to provide the package name in different languages, please be aware that if it is not present,
<code>en
</code> (English) is assumed:
</p>
2290 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><packageinformation
></span>
2291 <span class=
"nt"><packagename
></span>Simple Package
<span class=
"nt"></packagename
></span>
2292 <span class=
"nt"><packagename
</span> <span class=
"na">languagecode=
</span><span class=
"s">"de
"</span><span class=
"nt">></span>Einfaches Paket
<span class=
"nt"></packagename
></span>
2293 <span class=
"nt"></packageinformation
></span>
2295 <h4 id=
"packagedescription"><code><packagedescription
></code><a class=
"headerlink" href=
"#packagedescription" title=
"Permanent link">#
</a></h4>
2296 <p>Brief summary of the package, use it to explain what it does since the package name might not always be clear enough.
2297 The attribute
<code>languagecode
</code> is available here too, please reference to
<a href=
"#packageName"><code><packagename
></code></a> for details.
</p>
2298 <h4 id=
"version"><code><version
></code><a class=
"headerlink" href=
"#version" title=
"Permanent link">#
</a></h4>
2299 <p>The package's version number, this is a string consisting of three numbers separated with a dot and optionally followed by a keyword (must be followed with another number).
</p>
2300 <p>The possible keywords are:
</p>
2302 <li>Alpha/dev (both is regarded to be the same)
</li>
2304 <li>RC (release candidate)
</li>
2305 <li>pl (patch level)
</li>
2307 <p>Valid examples:
</p>
2310 <li>1.12.13 Alpha
19</li>
2313 <p>Invalid examples:
</p>
2315 <li>1.0.0 Beta (keyword Beta must be followed by a number)
</li>
2316 <li>2.0 RC
3 (version number must consists of
3 blocks of numbers)
</li>
2317 <li>1.2.3 dev
4.5 (
4.5 is not an integer,
4 or
5 would be valid but not the fraction)
</li>
2319 <h4 id=
"date"><code><date
></code><a class=
"headerlink" href=
"#date" title=
"Permanent link">#
</a></h4>
2320 <p>Must be a valid
<a href=
"http://en.wikipedia.org/wiki/ISO_8601">ISO
8601</a> date, e.g.
<code>2013-
12-
27</code>.
</p>
2321 <h3 id=
"authorinformation"><code><authorinformation
></code><a class=
"headerlink" href=
"#authorinformation" title=
"Permanent link">#
</a></h3>
2322 <p>Holds meta data regarding the package's author.
</p>
2323 <h4 id=
"author"><code><author
></code><a class=
"headerlink" href=
"#author" title=
"Permanent link">#
</a></h4>
2324 <p>Can be anything you want.
</p>
2325 <h4 id=
"authorurl"><code><authorurl
></code><a class=
"headerlink" href=
"#authorurl" title=
"Permanent link">#
</a></h4>
2329 <p>URL to the author's website.
</p>
2330 <h3 id=
"requiredpackages"><code><requiredpackages
></code><a class=
"headerlink" href=
"#requiredpackages" title=
"Permanent link">#
</a></h3>
2331 <p>A list of packages including their version required for this package to work.
</p>
2332 <h4 id=
"requiredpackage"><code><requiredpackage
></code><a class=
"headerlink" href=
"#requiredpackage" title=
"Permanent link">#
</a></h4>
2334 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><requiredpackage
</span> <span class=
"na">minversion=
</span><span class=
"s">"2.0.0"</span> <span class=
"na">file=
</span><span class=
"s">"requirements/com.woltlab.wcf.tar
"</span><span class=
"nt">></span>com.woltlab.wcf
<span class=
"nt"></requiredpackage
></span>
2336 <p>The attribute
<code>minversion
</code> must be a valid version number as described in
<a href=
"#version"><code><version
></code></a>.
2337 The
<code>file
</code> attribute is optional and specifies the location of the required package's archive relative to the
<code>package.xml
</code>.
</p>
2338 <h3 id=
"optionalpackage"><code><optionalpackage
></code><a class=
"headerlink" href=
"#optionalpackage" title=
"Permanent link">#
</a></h3>
2339 <p>A list of optional packages which can be selected by the user at the very end of the installation process.
</p>
2340 <h4 id=
"optionalpackage_1"><code><optionalpackage
></code><a class=
"headerlink" href=
"#optionalpackage_1" title=
"Permanent link">#
</a></h4>
2342 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><optionalpackage
</span> <span class=
"na">file=
</span><span class=
"s">"optionals/com.woltlab.wcf.moderatedUserGroup.tar
"</span><span class=
"nt">></span>com.woltlab.wcf.moderatedUserGroup
<span class=
"nt"></optionalpackage
></span>
2344 <p>The
<code>file
</code> attribute specifies the location of the optional package's archive relative to the
<code>package.xml
</code>.
</p>
2345 <h3 id=
"excludedpackages"><code><excludedpackages
></code><a class=
"headerlink" href=
"#excludedpackages" title=
"Permanent link">#
</a></h3>
2346 <p>List of packages which conflict with this package. It is not possible to install it if any of the specified packages is installed. In return you cannot install an excluded package if this package is installed.
</p>
2347 <h4 id=
"excludedpackage"><code><excludedpackage
></code><a class=
"headerlink" href=
"#excludedpackage" title=
"Permanent link">#
</a></h4>
2349 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><excludedpackage
</span> <span class=
"na">version=
</span><span class=
"s">"3.1.0 Alpha
1"</span><span class=
"nt">></span>com.woltlab.wcf
<span class=
"nt"></excludedpackage
></span>
2351 <p>The attribute
<code>version
</code> must be a valid version number as described in the
<a href=
"#version">\
<version
></a> section. In the example above it will be impossible to install this package in WoltLab Suite Core
3.1.0 Alpha
1 or higher.
</p>
2352 <h3 id=
"compatibility"><code><compatibility
></code><a class=
"headerlink" href=
"#compatibility" title=
"Permanent link">#
</a></h3>
2353 <div class=
"admonition info">
2354 <p class=
"admonition-title">Available since WoltLab Suite
3.1</p>
2356 <div class=
"admonition warning">
2357 <p class=
"admonition-title">With the release of WoltLab Suite
5.2 the API versions were abolished. Instead of using API versions packages should exclude version
<code>6.0.0 Alpha
1</code> of
<code>com.woltlab.wcf
</code> going forward.
</p>
2359 <p>WoltLab Suite
3.1 introduced a new versioning system that focused around the API compatibility and is intended to replace the
<code><excludedpackage
></code> instruction for the Core for most plugins.
</p>
2360 <p>The
<code><compatibility
></code>-tag holds a list of compatible API versions, and while only a single version is available at the time of writing, future versions will add more versions with backwards-compatibility in mind.
</p>
2362 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><compatibility
></span>
2363 <span class=
"nt"><api
</span> <span class=
"na">version=
</span><span class=
"s">"2018"</span> <span class=
"nt">/
></span>
2364 <span class=
"nt"></compatibility
></span>
2366 <h4 id=
"existing-api-versions">Existing API versions
<a class=
"headerlink" href=
"#existing-api-versions" title=
"Permanent link">#
</a></h4>
2370 <th>WoltLab Suite Core
</th>
2371 <th>API-Version
</th>
2372 <th>Backwards-Compatible to API-Version
</th>
2383 <h3 id=
"instructions"><code><instructions
></code><a class=
"headerlink" href=
"#instructions" title=
"Permanent link">#
</a></h3>
2384 <p>List of instructions to be executed upon install or update. The order is important, the topmost
<code><instruction
></code> will be executed first.
</p>
2385 <h4 id=
"instructions-typeinstall"><code><instructions
type=
"install"></code><a class=
"headerlink" href=
"#instructions-typeinstall" title=
"Permanent link">#
</a></h4>
2386 <p>List of instructions for a new installation of this package.
</p>
2387 <h4 id=
"instructions-typeupdate-fromversion"><code><instructions
type=
"update" fromversion=
"…"></code><a class=
"headerlink" href=
"#instructions-typeupdate-fromversion" title=
"Permanent link">#
</a></h4>
2388 <p>The attribute
<code>fromversion
</code> must be a valid version number as described in the
<a href=
"#version">\
<version
></a> section and specifies a possible update from that very version to the package's version.
</p>
2389 <div class=
"admonition warning">
2390 <p class=
"admonition-title">The installation process will pick exactly one update instruction, ignoring everything else. Please read the explanation below!
</p>
2394 <li>Installed version:
<code>1.0.0</code></li>
2395 <li>Package version:
<code>1.0.2</code></li>
2397 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><instructions
</span> <span class=
"na">type=
</span><span class=
"s">"update
"</span> <span class=
"na">fromversion=
</span><span class=
"s">"1.0.0"</span><span class=
"nt">></span>
2398 <span class=
"c"><!-- … --
></span>
2399 <span class=
"nt"></instructions
></span>
2400 <span class=
"nt"><instructions
</span> <span class=
"na">type=
</span><span class=
"s">"update
"</span> <span class=
"na">fromversion=
</span><span class=
"s">"1.0.1"</span><span class=
"nt">></span>
2401 <span class=
"c"><!-- … --
></span>
2402 <span class=
"nt"></instructions
></span>
2404 <p>In this example WoltLab Suite Core will pick the first update block since it allows an update from
<code>1.0.0 -
> 1.0.2</code>.
2405 The other block is not considered, since the currently installed version is
<code>1.0.0</code>. After applying the update block (
<code>fromversion=
"1.0.0"</code>), the version now reads
<code>1.0.2</code>.
</p>
2406 <h4 id=
"instruction"><code><instruction
></code><a class=
"headerlink" href=
"#instruction" title=
"Permanent link">#
</a></h4>
2408 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"objectTypeDefinition
"</span><span class=
"nt">></span>objectTypeDefinition.xml
<span class=
"nt"></instruction
></span>
2410 <p>The attribute
<code>type
</code> specifies the instruction type which is used to determine the package installation plugin (PIP) invoked to handle its value.
2411 The value must be a valid file relative to the location of
<code>package.xml
</code>.
2412 Many PIPs provide default file names which are used if no value is given:
</p>
2413 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"objectTypeDefinition
"</span> <span class=
"nt">/
></span>
2415 <p>There is a
<a href=
"../pip/">list of all default PIPs
</a> available.
</p>
2416 <div class=
"admonition warning">
2417 <p class=
"admonition-title">Both the
<code>type
</code>-attribute and the element value are case-sensitive. Windows does not care if the file is called
<code>objecttypedefinition.xml
</code> but was referenced as
<code>objectTypeDefinition.xml
</code>, but both Linux and Mac systems will be unable to find the file.
</p>
2419 <p>In addition to the
<code>type
</code> attribute, an optional
<code>run
</code> attribute (with
<code>standalone
</code> as the only valid value) is supported which forces the installation to execute this PIP in an isolated request, allowing a single, resource-heavy PIP to execute without encountering restrictions such as PHP’s
<code>memory_limit
</code> or
<code>max_execution_time
</code>:
</p>
2420 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"file
"</span> <span class=
"na">run=
</span><span class=
"s">"standalone
"</span> <span class=
"nt">/
></span>
2422 <h4 id=
"void"><code><void/
></code><a class=
"headerlink" href=
"#void" title=
"Permanent link">#
</a></h4>
2423 <p>Sometimes a package update should only adjust the metadata of the package, for example, an optional package was added.
2424 However, WoltLab Suite Core requires that the list of
<code><instructions
></code> is non-empty.
2425 Instead of using a dummy
<code><instruction
></code> that idempotently updates some PIP, the
<code><void/
></code> tag can be used for this use-case.
</p>
2426 <p>Using the
<code><void/
></code> tag is only valid for
<code><instructions
type=
"update"></code> and must not be accompanied by other
<code><instruction
></code> tags.
</p>
2428 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><instructions
</span> <span class=
"na">type=
</span><span class=
"s">"update
"</span> <span class=
"na">fromversion=
</span><span class=
"s">"1.0.0"</span><span class=
"nt">></span>
2429 <span class=
"nt"><void/
></span>
2430 <span class=
"nt"></instructions
></span>
2445 <footer class=
"md-footer">
2447 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2449 <a href=
"../../javascript/code-snippets/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2450 <div class=
"md-footer__button md-icon">
2451 <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>
2453 <div class=
"md-footer__title">
2454 <div class=
"md-ellipsis">
2455 <span class=
"md-footer__direction">
2464 <a href=
"../pip/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2465 <div class=
"md-footer__title">
2466 <div class=
"md-ellipsis">
2467 <span class=
"md-footer__direction">
2473 <div class=
"md-footer__button md-icon">
2474 <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>
2480 <div class=
"md-footer-meta md-typeset">
2481 <div class=
"md-footer-meta__inner md-grid">
2482 <div class=
"md-footer-copyright">
2484 <div class=
"md-footer-copyright__highlight">
2485 Copyright ©
2020 WoltLab GmbH
2489 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2494 <div class=
"md-footer-copyright">
2495 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2496 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2503 <div class=
"md-dialog" data-md-component=
"dialog">
2504 <div class=
"md-dialog__inner md-typeset"></div>
2506 <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>
2509 <script src=
"../../assets/javascripts/bundle.5cf3e710.min.js"></script>