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>Overview - 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=
"#package-installation-plugins" 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
>
886 <li class=
"md-nav__item md-nav__item--active">
888 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
893 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
895 <span class=
"md-nav__icon md-icon"></span>
898 <a href=
"./" class=
"md-nav__link md-nav__link--active">
903 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
909 <label class=
"md-nav__title" for=
"__toc">
910 <span class=
"md-nav__icon md-icon"></span>
913 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
915 <li class=
"md-nav__item">
916 <a href=
"#built-in-pips" class=
"md-nav__link">
934 <li class=
"md-nav__item">
935 <a href=
"acl-option/" class=
"md-nav__link">
946 <li class=
"md-nav__item">
947 <a href=
"acp-menu/" class=
"md-nav__link">
958 <li class=
"md-nav__item">
959 <a href=
"acp-search-provider/" class=
"md-nav__link">
970 <li class=
"md-nav__item">
971 <a href=
"acp-template/" class=
"md-nav__link">
982 <li class=
"md-nav__item">
983 <a href=
"bbcode/" class=
"md-nav__link">
994 <li class=
"md-nav__item">
995 <a href=
"box/" class=
"md-nav__link">
1006 <li class=
"md-nav__item">
1007 <a href=
"clipboard-action/" class=
"md-nav__link">
1018 <li class=
"md-nav__item">
1019 <a href=
"core-object/" class=
"md-nav__link">
1030 <li class=
"md-nav__item">
1031 <a href=
"cronjob/" class=
"md-nav__link">
1042 <li class=
"md-nav__item">
1043 <a href=
"event-listener/" class=
"md-nav__link">
1054 <li class=
"md-nav__item">
1055 <a href=
"file/" class=
"md-nav__link">
1066 <li class=
"md-nav__item">
1067 <a href=
"language/" class=
"md-nav__link">
1078 <li class=
"md-nav__item">
1079 <a href=
"media-provider/" class=
"md-nav__link">
1090 <li class=
"md-nav__item">
1091 <a href=
"menu/" class=
"md-nav__link">
1102 <li class=
"md-nav__item">
1103 <a href=
"menu-item/" class=
"md-nav__link">
1114 <li class=
"md-nav__item">
1115 <a href=
"object-type/" class=
"md-nav__link">
1126 <li class=
"md-nav__item">
1127 <a href=
"object-type-definition/" class=
"md-nav__link">
1128 objectTypeDefinition
1138 <li class=
"md-nav__item">
1139 <a href=
"option/" class=
"md-nav__link">
1150 <li class=
"md-nav__item">
1151 <a href=
"page/" class=
"md-nav__link">
1162 <li class=
"md-nav__item">
1163 <a href=
"pip/" class=
"md-nav__link">
1174 <li class=
"md-nav__item">
1175 <a href=
"script/" class=
"md-nav__link">
1186 <li class=
"md-nav__item">
1187 <a href=
"smiley/" class=
"md-nav__link">
1198 <li class=
"md-nav__item">
1199 <a href=
"sql/" class=
"md-nav__link">
1210 <li class=
"md-nav__item">
1211 <a href=
"style/" class=
"md-nav__link">
1222 <li class=
"md-nav__item">
1223 <a href=
"template/" class=
"md-nav__link">
1234 <li class=
"md-nav__item">
1235 <a href=
"template-listener/" class=
"md-nav__link">
1246 <li class=
"md-nav__item">
1247 <a href=
"user-group-option/" class=
"md-nav__link">
1258 <li class=
"md-nav__item">
1259 <a href=
"user-menu/" class=
"md-nav__link">
1270 <li class=
"md-nav__item">
1271 <a href=
"user-notification-event/" class=
"md-nav__link">
1272 userNotificationEvent
1282 <li class=
"md-nav__item">
1283 <a href=
"user-option/" class=
"md-nav__link">
1294 <li class=
"md-nav__item">
1295 <a href=
"user-profile-menu/" class=
"md-nav__link">
1312 <li class=
"md-nav__item">
1313 <a href=
"../database-php-api/" class=
"md-nav__link">
1334 <li class=
"md-nav__item md-nav__item--nested">
1337 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1339 <label class=
"md-nav__link" for=
"__nav_6">
1341 <span class=
"md-nav__icon md-icon"></span>
1343 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1344 <label class=
"md-nav__title" for=
"__nav_6">
1345 <span class=
"md-nav__icon md-icon"></span>
1348 <ul class=
"md-nav__list" data-md-scrollfix
>
1355 <li class=
"md-nav__item md-nav__item--nested">
1358 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1360 <label class=
"md-nav__link" for=
"__nav_6_1">
1361 Migrating from WSC
5.3
1362 <span class=
"md-nav__icon md-icon"></span>
1364 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1365 <label class=
"md-nav__title" for=
"__nav_6_1">
1366 <span class=
"md-nav__icon md-icon"></span>
1367 Migrating from WSC
5.3
1369 <ul class=
"md-nav__list" data-md-scrollfix
>
1375 <li class=
"md-nav__item">
1376 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1387 <li class=
"md-nav__item">
1388 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1389 Session Handling and Authentication
1399 <li class=
"md-nav__item">
1400 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1411 <li class=
"md-nav__item">
1412 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1423 <li class=
"md-nav__item">
1424 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1425 Third Party Libraries
1442 <li class=
"md-nav__item md-nav__item--nested">
1445 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1447 <label class=
"md-nav__link" for=
"__nav_6_2">
1448 Migrating from WSC
5.2
1449 <span class=
"md-nav__icon md-icon"></span>
1451 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1452 <label class=
"md-nav__title" for=
"__nav_6_2">
1453 <span class=
"md-nav__icon md-icon"></span>
1454 Migrating from WSC
5.2
1456 <ul class=
"md-nav__list" data-md-scrollfix
>
1462 <li class=
"md-nav__item">
1463 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1474 <li class=
"md-nav__item">
1475 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1476 Templates and Languages
1486 <li class=
"md-nav__item">
1487 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1488 Third Party Libraries
1505 <li class=
"md-nav__item md-nav__item--nested">
1508 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1510 <label class=
"md-nav__link" for=
"__nav_6_3">
1511 Migrating from WSC
3.1
1512 <span class=
"md-nav__icon md-icon"></span>
1514 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1515 <label class=
"md-nav__title" for=
"__nav_6_3">
1516 <span class=
"md-nav__icon md-icon"></span>
1517 Migrating from WSC
3.1
1519 <ul class=
"md-nav__list" data-md-scrollfix
>
1525 <li class=
"md-nav__item">
1526 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1544 <li class=
"md-nav__item md-nav__item--nested">
1547 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1549 <label class=
"md-nav__link" for=
"__nav_6_4">
1550 Migrating from WSC
3.0
1551 <span class=
"md-nav__icon md-icon"></span>
1553 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1554 <label class=
"md-nav__title" for=
"__nav_6_4">
1555 <span class=
"md-nav__icon md-icon"></span>
1556 Migrating from WSC
3.0
1558 <ul class=
"md-nav__list" data-md-scrollfix
>
1564 <li class=
"md-nav__item">
1565 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1576 <li class=
"md-nav__item">
1577 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1588 <li class=
"md-nav__item">
1589 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1600 <li class=
"md-nav__item">
1601 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1612 <li class=
"md-nav__item">
1613 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1631 <li class=
"md-nav__item md-nav__item--nested">
1634 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1636 <label class=
"md-nav__link" for=
"__nav_6_5">
1637 Migrating from WCF
2.1
1638 <span class=
"md-nav__icon md-icon"></span>
1640 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1641 <label class=
"md-nav__title" for=
"__nav_6_5">
1642 <span class=
"md-nav__icon md-icon"></span>
1643 Migrating from WCF
2.1
1645 <ul class=
"md-nav__list" data-md-scrollfix
>
1651 <li class=
"md-nav__item">
1652 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1663 <li class=
"md-nav__item">
1664 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1675 <li class=
"md-nav__item">
1676 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1687 <li class=
"md-nav__item">
1688 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1715 <li class=
"md-nav__item md-nav__item--nested">
1718 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1720 <label class=
"md-nav__link" for=
"__nav_7">
1722 <span class=
"md-nav__icon md-icon"></span>
1724 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1725 <label class=
"md-nav__title" for=
"__nav_7">
1726 <span class=
"md-nav__icon md-icon"></span>
1729 <ul class=
"md-nav__list" data-md-scrollfix
>
1736 <li class=
"md-nav__item md-nav__item--nested">
1739 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1741 <label class=
"md-nav__link" for=
"__nav_7_1">
1743 <span class=
"md-nav__icon md-icon"></span>
1745 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1746 <label class=
"md-nav__title" for=
"__nav_7_1">
1747 <span class=
"md-nav__icon md-icon"></span>
1750 <ul class=
"md-nav__list" data-md-scrollfix
>
1756 <li class=
"md-nav__item">
1757 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1768 <li class=
"md-nav__item">
1769 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1780 <li class=
"md-nav__item">
1781 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1792 <li class=
"md-nav__item">
1793 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1820 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1821 <div class=
"md-sidebar__scrollwrap">
1822 <div class=
"md-sidebar__inner">
1824 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1830 <label class=
"md-nav__title" for=
"__toc">
1831 <span class=
"md-nav__icon md-icon"></span>
1834 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1836 <li class=
"md-nav__item">
1837 <a href=
"#built-in-pips" class=
"md-nav__link">
1851 <div class=
"md-content" data-md-component=
"content">
1852 <article class=
"md-content__inner md-typeset">
1855 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/master/docs/package/pip.md" title=
"Edit this page" class=
"md-content__button md-icon">
1856 <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>
1860 <h1 id=
"package-installation-plugins">Package Installation Plugins
<a class=
"headerlink" href=
"#package-installation-plugins" title=
"Permanent link">#
</a></h1>
1861 <p>Package Installation Plugins (PIPs) are interfaces to deploy and edit content as well as components.
</p>
1862 <div class=
"admonition info">
1863 <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>
1865 <h2 id=
"built-in-pips">Built-In PIPs
<a class=
"headerlink" href=
"#built-in-pips" title=
"Permanent link">#
</a></h2>
1870 <th>Description
</th>
1875 <td><a href=
"acl-option/">aclOption
</a></td>
1876 <td>Customizable permissions for individual objects
</td>
1879 <td><a href=
"acp-menu/">acpMenu
</a></td>
1880 <td>Admin panel menu categories and items
</td>
1883 <td><a href=
"acp-search-provider/">acpSearchProvider
</a></td>
1884 <td>Data provider for the admin panel search
</td>
1887 <td><a href=
"acp-template/">acpTemplate
</a></td>
1888 <td>Admin panel templates
</td>
1891 <td><a href=
"bbcode/">bbcode
</a></td>
1892 <td>BBCodes for rich message formatting
</td>
1895 <td><a href=
"box/">box
</a></td>
1896 <td>Boxes that can be placed anywhere on a page
</td>
1899 <td><a href=
"clipboard-action/">clipboardAction
</a></td>
1900 <td>Perform bulk operations on marked objects
</td>
1903 <td><a href=
"core-object/">coreObject
</a></td>
1904 <td>Access Singletons from within the template
</td>
1907 <td><a href=
"cronjob/">cronjob
</a></td>
1908 <td>Periodically execute code with customizable intervals
</td>
1911 <td><a href=
"database/">database
</a></td>
1912 <td>Updates the database layout using
<a href=
"../database-php-api/">the PHP API
</a></td>
1915 <td><a href=
"event-listener/">eventListener
</a></td>
1916 <td>Register listeners for the event system
</td>
1919 <td><a href=
"file/">file
</a></td>
1920 <td>Deploy any type of files with the exception of templates
</td>
1923 <td><a href=
"language/">language
</a></td>
1924 <td>Language items
</td>
1927 <td><a href=
"media-provider/">mediaProvider
</a></td>
1928 <td>Detect and convert links to media providers
</td>
1931 <td><a href=
"menu/">menu
</a></td>
1932 <td>Side-wide and custom per-page menus
</td>
1935 <td><a href=
"menu-item/">menuItem
</a></td>
1936 <td>Menu items for menus created through the menu PIP
</td>
1939 <td><a href=
"object-type/">objectType
</a></td>
1940 <td>Flexible type registry based on definitions
</td>
1943 <td><a href=
"object-type-definition/">objectTypeDefinition
</a></td>
1944 <td>Groups objects and classes by functionality
</td>
1947 <td><a href=
"option/">option
</a></td>
1948 <td>Side-wide configuration options
</td>
1951 <td><a href=
"page/">page
</a></td>
1952 <td>Register page controllers and text-based pages
</td>
1955 <td><a href=
"pip/">pip
</a></td>
1956 <td>Package Installation Plugins
</td>
1959 <td><a href=
"script/">script
</a></td>
1960 <td>Execute arbitrary PHP code during installation, update and uninstallation
</td>
1963 <td><a href=
"smiley/">smiley
</a></td>
1967 <td><a href=
"sql/">sql
</a></td>
1968 <td>Execute SQL instructions using a MySQL-flavored syntax (also see
<a href=
"../database-php-api/">database PHP API
</a>)
</td>
1971 <td><a href=
"style/">style
</a></td>
1975 <td><a href=
"template/">template
</a></td>
1976 <td>Frontend templates
</td>
1979 <td><a href=
"template-listener/">templateListener
</a></td>
1980 <td>Embed template code into templates without altering the original
</td>
1983 <td><a href=
"user-group-option/">userGroupOption
</a></td>
1984 <td>Permissions for user groups
</td>
1987 <td><a href=
"user-menu/">userMenu
</a></td>
1988 <td>User menu categories and items
</td>
1991 <td><a href=
"user-notification-event/">userNotificationEvent
</a></td>
1992 <td>Events of the user notification system
</td>
1995 <td><a href=
"user-option/">userOption
</a></td>
1996 <td>User settings
</td>
1999 <td><a href=
"user-profile-menu/">userProfileMenu
</a></td>
2000 <td>User profile tabs
</td>
2017 <footer class=
"md-footer">
2019 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2021 <a href=
"../package-xml/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2022 <div class=
"md-footer__button md-icon">
2023 <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>
2025 <div class=
"md-footer__title">
2026 <div class=
"md-ellipsis">
2027 <span class=
"md-footer__direction">
2036 <a href=
"acl-option/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2037 <div class=
"md-footer__title">
2038 <div class=
"md-ellipsis">
2039 <span class=
"md-footer__direction">
2045 <div class=
"md-footer__button md-icon">
2046 <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>
2052 <div class=
"md-footer-meta md-typeset">
2053 <div class=
"md-footer-meta__inner md-grid">
2054 <div class=
"md-footer-copyright">
2056 <div class=
"md-footer-copyright__highlight">
2057 Copyright ©
2020 WoltLab GmbH
2061 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2066 <div class=
"md-footer-copyright">
2067 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2068 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2075 <div class=
"md-dialog" data-md-component=
"dialog">
2076 <div class=
"md-dialog__inner md-typeset"></div>
2078 <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>
2081 <script src=
"../../assets/javascripts/bundle.5cf3e710.min.js"></script>