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>Overview - 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=
"#package-installation-plugins" 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
>
309 <li class=
"md-nav__item">
310 <a href=
"../../php/api/caches/" class=
"md-nav__link">
321 <li class=
"md-nav__item">
322 <a href=
"../../php/api/comments/" class=
"md-nav__link">
333 <li class=
"md-nav__item">
334 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
345 <li class=
"md-nav__item">
346 <a href=
"../../php/api/events/" class=
"md-nav__link">
358 <li class=
"md-nav__item md-nav__item--nested">
361 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
363 <label class=
"md-nav__link" for=
"__nav_2_5_5">
365 <span class=
"md-nav__icon md-icon"></span>
367 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
368 <label class=
"md-nav__title" for=
"__nav_2_5_5">
369 <span class=
"md-nav__icon md-icon"></span>
372 <ul class=
"md-nav__list" data-md-scrollfix
>
378 <li class=
"md-nav__item">
379 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
390 <li class=
"md-nav__item">
391 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
402 <li class=
"md-nav__item">
403 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
414 <li class=
"md-nav__item">
415 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
426 <li class=
"md-nav__item">
427 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
444 <li class=
"md-nav__item">
445 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
446 Package Installation Plugins
456 <li class=
"md-nav__item">
457 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
468 <li class=
"md-nav__item">
469 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
480 <li class=
"md-nav__item">
481 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
498 <li class=
"md-nav__item">
499 <a href=
"../../php/code-style/" class=
"md-nav__link">
510 <li class=
"md-nav__item">
511 <a href=
"../../php/apps/" class=
"md-nav__link">
522 <li class=
"md-nav__item">
523 <a href=
"../../php/gdpr/" class=
"md-nav__link">
544 <li class=
"md-nav__item md-nav__item--nested">
547 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
549 <label class=
"md-nav__link" for=
"__nav_3">
550 Languages, Templates & CSS
551 <span class=
"md-nav__icon md-icon"></span>
553 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
554 <label class=
"md-nav__title" for=
"__nav_3">
555 <span class=
"md-nav__icon md-icon"></span>
556 Languages, Templates & CSS
558 <ul class=
"md-nav__list" data-md-scrollfix
>
564 <li class=
"md-nav__item">
565 <a href=
"../../view/languages/" class=
"md-nav__link">
576 <li class=
"md-nav__item">
577 <a href=
"../../view/templates/" class=
"md-nav__link">
588 <li class=
"md-nav__item">
589 <a href=
"../../view/css/" class=
"md-nav__link">
610 <li class=
"md-nav__item md-nav__item--nested">
613 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
615 <label class=
"md-nav__link" for=
"__nav_4">
617 <span class=
"md-nav__icon md-icon"></span>
619 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
620 <label class=
"md-nav__title" for=
"__nav_4">
621 <span class=
"md-nav__icon md-icon"></span>
624 <ul class=
"md-nav__list" data-md-scrollfix
>
630 <li class=
"md-nav__item">
631 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
643 <li class=
"md-nav__item md-nav__item--nested">
646 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
648 <label class=
"md-nav__link" for=
"__nav_4_2">
650 <span class=
"md-nav__icon md-icon"></span>
652 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
653 <label class=
"md-nav__title" for=
"__nav_4_2">
654 <span class=
"md-nav__icon md-icon"></span>
657 <ul class=
"md-nav__list" data-md-scrollfix
>
663 <li class=
"md-nav__item">
664 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
675 <li class=
"md-nav__item">
676 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
687 <li class=
"md-nav__item">
688 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
699 <li class=
"md-nav__item">
700 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
711 <li class=
"md-nav__item">
712 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
723 <li class=
"md-nav__item">
724 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
735 <li class=
"md-nav__item">
736 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
747 <li class=
"md-nav__item">
748 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
749 Browser and Screen Sizes
759 <li class=
"md-nav__item">
760 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
777 <li class=
"md-nav__item">
778 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
789 <li class=
"md-nav__item">
790 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
801 <li class=
"md-nav__item">
802 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
825 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
828 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
830 <label class=
"md-nav__link" for=
"__nav_5">
832 <span class=
"md-nav__icon md-icon"></span>
834 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
835 <label class=
"md-nav__title" for=
"__nav_5">
836 <span class=
"md-nav__icon md-icon"></span>
839 <ul class=
"md-nav__list" data-md-scrollfix
>
845 <li class=
"md-nav__item">
846 <a href=
"../package-xml/" class=
"md-nav__link">
860 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
863 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
865 <label class=
"md-nav__link" for=
"__nav_5_2">
867 <span class=
"md-nav__icon md-icon"></span>
869 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
870 <label class=
"md-nav__title" for=
"__nav_5_2">
871 <span class=
"md-nav__icon md-icon"></span>
874 <ul class=
"md-nav__list" data-md-scrollfix
>
882 <li class=
"md-nav__item md-nav__item--active">
884 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
889 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
891 <span class=
"md-nav__icon md-icon"></span>
894 <a href=
"./" class=
"md-nav__link md-nav__link--active">
899 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
905 <label class=
"md-nav__title" for=
"__toc">
906 <span class=
"md-nav__icon md-icon"></span>
909 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
911 <li class=
"md-nav__item">
912 <a href=
"#built-in-pips" class=
"md-nav__link">
930 <li class=
"md-nav__item">
931 <a href=
"acl-option/" class=
"md-nav__link">
942 <li class=
"md-nav__item">
943 <a href=
"acp-menu/" class=
"md-nav__link">
954 <li class=
"md-nav__item">
955 <a href=
"acp-search-provider/" class=
"md-nav__link">
966 <li class=
"md-nav__item">
967 <a href=
"acp-template/" class=
"md-nav__link">
978 <li class=
"md-nav__item">
979 <a href=
"bbcode/" class=
"md-nav__link">
990 <li class=
"md-nav__item">
991 <a href=
"box/" class=
"md-nav__link">
1002 <li class=
"md-nav__item">
1003 <a href=
"clipboard-action/" class=
"md-nav__link">
1014 <li class=
"md-nav__item">
1015 <a href=
"core-object/" class=
"md-nav__link">
1026 <li class=
"md-nav__item">
1027 <a href=
"cronjob/" class=
"md-nav__link">
1038 <li class=
"md-nav__item">
1039 <a href=
"event-listener/" class=
"md-nav__link">
1050 <li class=
"md-nav__item">
1051 <a href=
"file/" class=
"md-nav__link">
1062 <li class=
"md-nav__item">
1063 <a href=
"language/" class=
"md-nav__link">
1074 <li class=
"md-nav__item">
1075 <a href=
"media-provider/" class=
"md-nav__link">
1086 <li class=
"md-nav__item">
1087 <a href=
"menu/" class=
"md-nav__link">
1098 <li class=
"md-nav__item">
1099 <a href=
"menu-item/" class=
"md-nav__link">
1110 <li class=
"md-nav__item">
1111 <a href=
"object-type/" class=
"md-nav__link">
1122 <li class=
"md-nav__item">
1123 <a href=
"object-type-definition/" class=
"md-nav__link">
1124 objectTypeDefinition
1134 <li class=
"md-nav__item">
1135 <a href=
"option/" class=
"md-nav__link">
1146 <li class=
"md-nav__item">
1147 <a href=
"page/" class=
"md-nav__link">
1158 <li class=
"md-nav__item">
1159 <a href=
"pip/" class=
"md-nav__link">
1170 <li class=
"md-nav__item">
1171 <a href=
"script/" class=
"md-nav__link">
1182 <li class=
"md-nav__item">
1183 <a href=
"smiley/" class=
"md-nav__link">
1194 <li class=
"md-nav__item">
1195 <a href=
"sql/" class=
"md-nav__link">
1206 <li class=
"md-nav__item">
1207 <a href=
"style/" class=
"md-nav__link">
1218 <li class=
"md-nav__item">
1219 <a href=
"template/" class=
"md-nav__link">
1230 <li class=
"md-nav__item">
1231 <a href=
"template-listener/" class=
"md-nav__link">
1242 <li class=
"md-nav__item">
1243 <a href=
"user-group-option/" class=
"md-nav__link">
1254 <li class=
"md-nav__item">
1255 <a href=
"user-menu/" class=
"md-nav__link">
1266 <li class=
"md-nav__item">
1267 <a href=
"user-notification-event/" class=
"md-nav__link">
1268 userNotificationEvent
1278 <li class=
"md-nav__item">
1279 <a href=
"user-option/" class=
"md-nav__link">
1290 <li class=
"md-nav__item">
1291 <a href=
"user-profile-menu/" class=
"md-nav__link">
1308 <li class=
"md-nav__item">
1309 <a href=
"../database-php-api/" class=
"md-nav__link">
1330 <li class=
"md-nav__item md-nav__item--nested">
1333 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1335 <label class=
"md-nav__link" for=
"__nav_6">
1337 <span class=
"md-nav__icon md-icon"></span>
1339 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1340 <label class=
"md-nav__title" for=
"__nav_6">
1341 <span class=
"md-nav__icon md-icon"></span>
1344 <ul class=
"md-nav__list" data-md-scrollfix
>
1351 <li class=
"md-nav__item md-nav__item--nested">
1354 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1356 <label class=
"md-nav__link" for=
"__nav_6_1">
1357 Migrating from WSC
5.3
1358 <span class=
"md-nav__icon md-icon"></span>
1360 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1361 <label class=
"md-nav__title" for=
"__nav_6_1">
1362 <span class=
"md-nav__icon md-icon"></span>
1363 Migrating from WSC
5.3
1365 <ul class=
"md-nav__list" data-md-scrollfix
>
1371 <li class=
"md-nav__item">
1372 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1383 <li class=
"md-nav__item">
1384 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1385 Session Handling and Authentication
1395 <li class=
"md-nav__item">
1396 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1407 <li class=
"md-nav__item">
1408 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1419 <li class=
"md-nav__item">
1420 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1421 Third Party Libraries
1438 <li class=
"md-nav__item md-nav__item--nested">
1441 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1443 <label class=
"md-nav__link" for=
"__nav_6_2">
1444 Migrating from WSC
5.2
1445 <span class=
"md-nav__icon md-icon"></span>
1447 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1448 <label class=
"md-nav__title" for=
"__nav_6_2">
1449 <span class=
"md-nav__icon md-icon"></span>
1450 Migrating from WSC
5.2
1452 <ul class=
"md-nav__list" data-md-scrollfix
>
1458 <li class=
"md-nav__item">
1459 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1470 <li class=
"md-nav__item">
1471 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1472 Templates and Languages
1482 <li class=
"md-nav__item">
1483 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1484 Third Party Libraries
1501 <li class=
"md-nav__item md-nav__item--nested">
1504 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1506 <label class=
"md-nav__link" for=
"__nav_6_3">
1507 Migrating from WSC
3.1
1508 <span class=
"md-nav__icon md-icon"></span>
1510 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1511 <label class=
"md-nav__title" for=
"__nav_6_3">
1512 <span class=
"md-nav__icon md-icon"></span>
1513 Migrating from WSC
3.1
1515 <ul class=
"md-nav__list" data-md-scrollfix
>
1521 <li class=
"md-nav__item">
1522 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1540 <li class=
"md-nav__item md-nav__item--nested">
1543 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1545 <label class=
"md-nav__link" for=
"__nav_6_4">
1546 Migrating from WSC
3.0
1547 <span class=
"md-nav__icon md-icon"></span>
1549 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1550 <label class=
"md-nav__title" for=
"__nav_6_4">
1551 <span class=
"md-nav__icon md-icon"></span>
1552 Migrating from WSC
3.0
1554 <ul class=
"md-nav__list" data-md-scrollfix
>
1560 <li class=
"md-nav__item">
1561 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1572 <li class=
"md-nav__item">
1573 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1584 <li class=
"md-nav__item">
1585 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1596 <li class=
"md-nav__item">
1597 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1608 <li class=
"md-nav__item">
1609 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1627 <li class=
"md-nav__item md-nav__item--nested">
1630 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1632 <label class=
"md-nav__link" for=
"__nav_6_5">
1633 Migrating from WCF
2.1
1634 <span class=
"md-nav__icon md-icon"></span>
1636 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1637 <label class=
"md-nav__title" for=
"__nav_6_5">
1638 <span class=
"md-nav__icon md-icon"></span>
1639 Migrating from WCF
2.1
1641 <ul class=
"md-nav__list" data-md-scrollfix
>
1647 <li class=
"md-nav__item">
1648 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1659 <li class=
"md-nav__item">
1660 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1671 <li class=
"md-nav__item">
1672 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1683 <li class=
"md-nav__item">
1684 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1711 <li class=
"md-nav__item md-nav__item--nested">
1714 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1716 <label class=
"md-nav__link" for=
"__nav_7">
1718 <span class=
"md-nav__icon md-icon"></span>
1720 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1721 <label class=
"md-nav__title" for=
"__nav_7">
1722 <span class=
"md-nav__icon md-icon"></span>
1725 <ul class=
"md-nav__list" data-md-scrollfix
>
1732 <li class=
"md-nav__item md-nav__item--nested">
1735 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1737 <label class=
"md-nav__link" for=
"__nav_7_1">
1739 <span class=
"md-nav__icon md-icon"></span>
1741 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1742 <label class=
"md-nav__title" for=
"__nav_7_1">
1743 <span class=
"md-nav__icon md-icon"></span>
1746 <ul class=
"md-nav__list" data-md-scrollfix
>
1752 <li class=
"md-nav__item">
1753 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1764 <li class=
"md-nav__item">
1765 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1776 <li class=
"md-nav__item">
1777 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1788 <li class=
"md-nav__item">
1789 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1816 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1817 <div class=
"md-sidebar__scrollwrap">
1818 <div class=
"md-sidebar__inner">
1820 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1826 <label class=
"md-nav__title" for=
"__toc">
1827 <span class=
"md-nav__icon md-icon"></span>
1830 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1832 <li class=
"md-nav__item">
1833 <a href=
"#built-in-pips" class=
"md-nav__link">
1847 <div class=
"md-content" data-md-component=
"content">
1848 <article class=
"md-content__inner md-typeset">
1851 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip.md" title=
"Edit this page" class=
"md-content__button md-icon">
1852 <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>
1856 <h1 id=
"package-installation-plugins">Package Installation Plugins
<a class=
"headerlink" href=
"#package-installation-plugins" title=
"Permanent link">#
</a></h1>
1857 <p>Package Installation Plugins (PIPs) are interfaces to deploy and edit content as well as components.
</p>
1858 <div class=
"admonition info">
1859 <p class=
"admonition-title">For XML-based PIPs:
<code><![CDATA[]]
></code> must be used for language items and page contents. In all other cases it may only be used when necessary.
</p>
1861 <h2 id=
"built-in-pips">Built-In PIPs
<a class=
"headerlink" href=
"#built-in-pips" title=
"Permanent link">#
</a></h2>
1866 <th>Description
</th>
1871 <td><a href=
"acl-option/">aclOption
</a></td>
1872 <td>Customizable permissions for individual objects
</td>
1875 <td><a href=
"acp-menu/">acpMenu
</a></td>
1876 <td>Admin panel menu categories and items
</td>
1879 <td><a href=
"acp-search-provider/">acpSearchProvider
</a></td>
1880 <td>Data provider for the admin panel search
</td>
1883 <td><a href=
"acp-template/">acpTemplate
</a></td>
1884 <td>Admin panel templates
</td>
1887 <td><a href=
"bbcode/">bbcode
</a></td>
1888 <td>BBCodes for rich message formatting
</td>
1891 <td><a href=
"box/">box
</a></td>
1892 <td>Boxes that can be placed anywhere on a page
</td>
1895 <td><a href=
"clipboard-action/">clipboardAction
</a></td>
1896 <td>Perform bulk operations on marked objects
</td>
1899 <td><a href=
"core-object/">coreObject
</a></td>
1900 <td>Access Singletons from within the template
</td>
1903 <td><a href=
"cronjob/">cronjob
</a></td>
1904 <td>Periodically execute code with customizable intervals
</td>
1907 <td><a href=
"database/">database
</a></td>
1908 <td>Updates the database layout using
<a href=
"../database-php-api/">the PHP API
</a></td>
1911 <td><a href=
"event-listener/">eventListener
</a></td>
1912 <td>Register listeners for the event system
</td>
1915 <td><a href=
"file/">file
</a></td>
1916 <td>Deploy any type of files with the exception of templates
</td>
1919 <td><a href=
"language/">language
</a></td>
1920 <td>Language items
</td>
1923 <td><a href=
"media-provider/">mediaProvider
</a></td>
1924 <td>Detect and convert links to media providers
</td>
1927 <td><a href=
"menu/">menu
</a></td>
1928 <td>Side-wide and custom per-page menus
</td>
1931 <td><a href=
"menu-item/">menuItem
</a></td>
1932 <td>Menu items for menus created through the menu PIP
</td>
1935 <td><a href=
"object-type/">objectType
</a></td>
1936 <td>Flexible type registry based on definitions
</td>
1939 <td><a href=
"object-type-definition/">objectTypeDefinition
</a></td>
1940 <td>Groups objects and classes by functionality
</td>
1943 <td><a href=
"option/">option
</a></td>
1944 <td>Side-wide configuration options
</td>
1947 <td><a href=
"page/">page
</a></td>
1948 <td>Register page controllers and text-based pages
</td>
1951 <td><a href=
"pip/">pip
</a></td>
1952 <td>Package Installation Plugins
</td>
1955 <td><a href=
"script/">script
</a></td>
1956 <td>Execute arbitrary PHP code during installation, update and uninstallation
</td>
1959 <td><a href=
"smiley/">smiley
</a></td>
1963 <td><a href=
"sql/">sql
</a></td>
1964 <td>Execute SQL instructions using a MySQL-flavored syntax (also see
<a href=
"../database-php-api/">database PHP API
</a>)
</td>
1967 <td><a href=
"style/">style
</a></td>
1971 <td><a href=
"template/">template
</a></td>
1972 <td>Frontend templates
</td>
1975 <td><a href=
"template-listener/">templateListener
</a></td>
1976 <td>Embed template code into templates without altering the original
</td>
1979 <td><a href=
"user-group-option/">userGroupOption
</a></td>
1980 <td>Permissions for user groups
</td>
1983 <td><a href=
"user-menu/">userMenu
</a></td>
1984 <td>User menu categories and items
</td>
1987 <td><a href=
"user-notification-event/">userNotificationEvent
</a></td>
1988 <td>Events of the user notification system
</td>
1991 <td><a href=
"user-option/">userOption
</a></td>
1992 <td>User settings
</td>
1995 <td><a href=
"user-profile-menu/">userProfileMenu
</a></td>
1996 <td>User profile tabs
</td>
2005 <div class=
"md-source-date">
2008 Last update:
2021-
03-
15
2027 <footer class=
"md-footer">
2029 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2031 <a href=
"../package-xml/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2032 <div class=
"md-footer__button md-icon">
2033 <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>
2035 <div class=
"md-footer__title">
2036 <div class=
"md-ellipsis">
2037 <span class=
"md-footer__direction">
2046 <a href=
"acl-option/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2047 <div class=
"md-footer__title">
2048 <div class=
"md-ellipsis">
2049 <span class=
"md-footer__direction">
2055 <div class=
"md-footer__button md-icon">
2056 <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>
2062 <div class=
"md-footer-meta md-typeset">
2063 <div class=
"md-footer-meta__inner md-grid">
2064 <div class=
"md-footer-copyright">
2066 <div class=
"md-footer-copyright__highlight">
2067 Copyright ©
2020 WoltLab GmbH
2071 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2076 <div class=
"md-footer-copyright">
2077 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2078 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2085 <div class=
"md-dialog" data-md-component=
"dialog">
2086 <div class=
"md-dialog__inner md-typeset"></div>
2088 <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>
2091 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>