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
>
310 <li class=
"md-nav__item md-nav__item--nested">
313 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
315 <label class=
"md-nav__link" for=
"__nav_2_5_1">
317 <span class=
"md-nav__icon md-icon"></span>
319 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
320 <label class=
"md-nav__title" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
324 <ul class=
"md-nav__list" data-md-scrollfix
>
330 <li class=
"md-nav__item">
331 <a href=
"../../php/api/caches/" class=
"md-nav__link">
342 <li class=
"md-nav__item">
343 <a href=
"../../php/api/caches_persistent-caches/" class=
"md-nav__link">
354 <li class=
"md-nav__item">
355 <a href=
"../../php/api/caches_runtime-caches/" class=
"md-nav__link">
372 <li class=
"md-nav__item">
373 <a href=
"../../php/api/comments/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../php/api/events/" class=
"md-nav__link">
409 <li class=
"md-nav__item md-nav__item--nested">
412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
414 <label class=
"md-nav__link" for=
"__nav_2_5_5">
416 <span class=
"md-nav__icon md-icon"></span>
418 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
419 <label class=
"md-nav__title" for=
"__nav_2_5_5">
420 <span class=
"md-nav__icon md-icon"></span>
423 <ul class=
"md-nav__list" data-md-scrollfix
>
429 <li class=
"md-nav__item">
430 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
453 <li class=
"md-nav__item">
454 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
465 <li class=
"md-nav__item">
466 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
495 <li class=
"md-nav__item">
496 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
497 Package Installation Plugins
507 <li class=
"md-nav__item">
508 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
549 <li class=
"md-nav__item">
550 <a href=
"../../php/code-style/" class=
"md-nav__link">
561 <li class=
"md-nav__item">
562 <a href=
"../../php/apps/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../php/gdpr/" class=
"md-nav__link">
595 <li class=
"md-nav__item md-nav__item--nested">
598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
600 <label class=
"md-nav__link" for=
"__nav_3">
601 Languages, Templates & CSS
602 <span class=
"md-nav__icon md-icon"></span>
604 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
605 <label class=
"md-nav__title" for=
"__nav_3">
606 <span class=
"md-nav__icon md-icon"></span>
607 Languages, Templates & CSS
609 <ul class=
"md-nav__list" data-md-scrollfix
>
615 <li class=
"md-nav__item">
616 <a href=
"../../view/languages/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../../view/templates/" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"../../view/template-plugins/" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"../../view/css/" class=
"md-nav__link">
673 <li class=
"md-nav__item md-nav__item--nested">
676 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
678 <label class=
"md-nav__link" for=
"__nav_4">
679 TypeScript and JavaScript API
680 <span class=
"md-nav__icon md-icon"></span>
682 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
683 <label class=
"md-nav__title" for=
"__nav_4">
684 <span class=
"md-nav__icon md-icon"></span>
685 TypeScript and JavaScript API
687 <ul class=
"md-nav__list" data-md-scrollfix
>
693 <li class=
"md-nav__item">
694 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
705 <li class=
"md-nav__item">
706 <a href=
"../../javascript/typescript/" class=
"md-nav__link">
718 <li class=
"md-nav__item md-nav__item--nested">
721 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
723 <label class=
"md-nav__link" for=
"__nav_4_3">
725 <span class=
"md-nav__icon md-icon"></span>
727 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
728 <label class=
"md-nav__title" for=
"__nav_4_3">
729 <span class=
"md-nav__icon md-icon"></span>
732 <ul class=
"md-nav__list" data-md-scrollfix
>
738 <li class=
"md-nav__item">
739 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
750 <li class=
"md-nav__item">
751 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
762 <li class=
"md-nav__item">
763 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
774 <li class=
"md-nav__item">
775 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
786 <li class=
"md-nav__item">
787 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
798 <li class=
"md-nav__item">
799 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
810 <li class=
"md-nav__item">
811 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
822 <li class=
"md-nav__item">
823 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
824 Browser and Screen Sizes
834 <li class=
"md-nav__item">
835 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
852 <li class=
"md-nav__item">
853 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
864 <li class=
"md-nav__item">
865 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
876 <li class=
"md-nav__item">
877 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
900 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
903 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
905 <label class=
"md-nav__link" for=
"__nav_5">
907 <span class=
"md-nav__icon md-icon"></span>
909 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
910 <label class=
"md-nav__title" for=
"__nav_5">
911 <span class=
"md-nav__icon md-icon"></span>
914 <ul class=
"md-nav__list" data-md-scrollfix
>
920 <li class=
"md-nav__item">
921 <a href=
"../package-xml/" class=
"md-nav__link">
935 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
938 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
940 <label class=
"md-nav__link" for=
"__nav_5_2">
942 <span class=
"md-nav__icon md-icon"></span>
944 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
945 <label class=
"md-nav__title" for=
"__nav_5_2">
946 <span class=
"md-nav__icon md-icon"></span>
949 <ul class=
"md-nav__list" data-md-scrollfix
>
957 <li class=
"md-nav__item md-nav__item--active">
959 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
964 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
966 <span class=
"md-nav__icon md-icon"></span>
969 <a href=
"./" class=
"md-nav__link md-nav__link--active">
974 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
980 <label class=
"md-nav__title" for=
"__toc">
981 <span class=
"md-nav__icon md-icon"></span>
984 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
986 <li class=
"md-nav__item">
987 <a href=
"#built-in-pips" class=
"md-nav__link">
1005 <li class=
"md-nav__item">
1006 <a href=
"acl-option/" class=
"md-nav__link">
1017 <li class=
"md-nav__item">
1018 <a href=
"acp-menu/" class=
"md-nav__link">
1029 <li class=
"md-nav__item">
1030 <a href=
"acp-search-provider/" class=
"md-nav__link">
1041 <li class=
"md-nav__item">
1042 <a href=
"acp-template/" class=
"md-nav__link">
1053 <li class=
"md-nav__item">
1054 <a href=
"bbcode/" class=
"md-nav__link">
1065 <li class=
"md-nav__item">
1066 <a href=
"box/" class=
"md-nav__link">
1077 <li class=
"md-nav__item">
1078 <a href=
"clipboard-action/" class=
"md-nav__link">
1089 <li class=
"md-nav__item">
1090 <a href=
"core-object/" class=
"md-nav__link">
1101 <li class=
"md-nav__item">
1102 <a href=
"cronjob/" class=
"md-nav__link">
1113 <li class=
"md-nav__item">
1114 <a href=
"database/" class=
"md-nav__link">
1125 <li class=
"md-nav__item">
1126 <a href=
"event-listener/" class=
"md-nav__link">
1137 <li class=
"md-nav__item">
1138 <a href=
"file/" class=
"md-nav__link">
1149 <li class=
"md-nav__item">
1150 <a href=
"language/" class=
"md-nav__link">
1161 <li class=
"md-nav__item">
1162 <a href=
"media-provider/" class=
"md-nav__link">
1173 <li class=
"md-nav__item">
1174 <a href=
"menu/" class=
"md-nav__link">
1185 <li class=
"md-nav__item">
1186 <a href=
"menu-item/" class=
"md-nav__link">
1197 <li class=
"md-nav__item">
1198 <a href=
"object-type/" class=
"md-nav__link">
1209 <li class=
"md-nav__item">
1210 <a href=
"object-type-definition/" class=
"md-nav__link">
1211 objectTypeDefinition
1221 <li class=
"md-nav__item">
1222 <a href=
"option/" class=
"md-nav__link">
1233 <li class=
"md-nav__item">
1234 <a href=
"page/" class=
"md-nav__link">
1245 <li class=
"md-nav__item">
1246 <a href=
"pip/" class=
"md-nav__link">
1257 <li class=
"md-nav__item">
1258 <a href=
"script/" class=
"md-nav__link">
1269 <li class=
"md-nav__item">
1270 <a href=
"smiley/" class=
"md-nav__link">
1281 <li class=
"md-nav__item">
1282 <a href=
"sql/" class=
"md-nav__link">
1293 <li class=
"md-nav__item">
1294 <a href=
"style/" class=
"md-nav__link">
1305 <li class=
"md-nav__item">
1306 <a href=
"template/" class=
"md-nav__link">
1317 <li class=
"md-nav__item">
1318 <a href=
"template-listener/" class=
"md-nav__link">
1329 <li class=
"md-nav__item">
1330 <a href=
"user-group-option/" class=
"md-nav__link">
1341 <li class=
"md-nav__item">
1342 <a href=
"user-menu/" class=
"md-nav__link">
1353 <li class=
"md-nav__item">
1354 <a href=
"user-notification-event/" class=
"md-nav__link">
1355 userNotificationEvent
1365 <li class=
"md-nav__item">
1366 <a href=
"user-option/" class=
"md-nav__link">
1377 <li class=
"md-nav__item">
1378 <a href=
"user-profile-menu/" class=
"md-nav__link">
1395 <li class=
"md-nav__item">
1396 <a href=
"../database-php-api/" class=
"md-nav__link">
1417 <li class=
"md-nav__item md-nav__item--nested">
1420 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1422 <label class=
"md-nav__link" for=
"__nav_6">
1424 <span class=
"md-nav__icon md-icon"></span>
1426 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1427 <label class=
"md-nav__title" for=
"__nav_6">
1428 <span class=
"md-nav__icon md-icon"></span>
1431 <ul class=
"md-nav__list" data-md-scrollfix
>
1438 <li class=
"md-nav__item md-nav__item--nested">
1441 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1443 <label class=
"md-nav__link" for=
"__nav_6_1">
1444 Migrating from WSC
5.3
1445 <span class=
"md-nav__icon md-icon"></span>
1447 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1448 <label class=
"md-nav__title" for=
"__nav_6_1">
1449 <span class=
"md-nav__icon md-icon"></span>
1450 Migrating from WSC
5.3
1452 <ul class=
"md-nav__list" data-md-scrollfix
>
1458 <li class=
"md-nav__item">
1459 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1470 <li class=
"md-nav__item">
1471 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1472 Session Handling and Authentication
1482 <li class=
"md-nav__item">
1483 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1484 TypeScript and JavaScript
1494 <li class=
"md-nav__item">
1495 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1506 <li class=
"md-nav__item">
1507 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1508 Third Party Libraries
1525 <li class=
"md-nav__item md-nav__item--nested">
1528 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1530 <label class=
"md-nav__link" for=
"__nav_6_2">
1531 Migrating from WSC
5.2
1532 <span class=
"md-nav__icon md-icon"></span>
1534 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1535 <label class=
"md-nav__title" for=
"__nav_6_2">
1536 <span class=
"md-nav__icon md-icon"></span>
1537 Migrating from WSC
5.2
1539 <ul class=
"md-nav__list" data-md-scrollfix
>
1545 <li class=
"md-nav__item">
1546 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1557 <li class=
"md-nav__item">
1558 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1559 Templates and Languages
1569 <li class=
"md-nav__item">
1570 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1571 Third Party Libraries
1588 <li class=
"md-nav__item md-nav__item--nested">
1591 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1593 <label class=
"md-nav__link" for=
"__nav_6_3">
1594 Migrating from WSC
3.1
1595 <span class=
"md-nav__icon md-icon"></span>
1597 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1598 <label class=
"md-nav__title" for=
"__nav_6_3">
1599 <span class=
"md-nav__icon md-icon"></span>
1600 Migrating from WSC
3.1
1602 <ul class=
"md-nav__list" data-md-scrollfix
>
1608 <li class=
"md-nav__item">
1609 <a href=
"../../migration/wsc31/php/" 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_4" type=
"checkbox" id=
"__nav_6_4" >
1632 <label class=
"md-nav__link" for=
"__nav_6_4">
1633 Migrating from WSC
3.0
1634 <span class=
"md-nav__icon md-icon"></span>
1636 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1637 <label class=
"md-nav__title" for=
"__nav_6_4">
1638 <span class=
"md-nav__icon md-icon"></span>
1639 Migrating from WSC
3.0
1641 <ul class=
"md-nav__list" data-md-scrollfix
>
1647 <li class=
"md-nav__item">
1648 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1659 <li class=
"md-nav__item">
1660 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1671 <li class=
"md-nav__item">
1672 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1683 <li class=
"md-nav__item">
1684 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1695 <li class=
"md-nav__item">
1696 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1714 <li class=
"md-nav__item md-nav__item--nested">
1717 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1719 <label class=
"md-nav__link" for=
"__nav_6_5">
1720 Migrating from WCF
2.1
1721 <span class=
"md-nav__icon md-icon"></span>
1723 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1724 <label class=
"md-nav__title" for=
"__nav_6_5">
1725 <span class=
"md-nav__icon md-icon"></span>
1726 Migrating from WCF
2.1
1728 <ul class=
"md-nav__list" data-md-scrollfix
>
1734 <li class=
"md-nav__item">
1735 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1746 <li class=
"md-nav__item">
1747 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1758 <li class=
"md-nav__item">
1759 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1770 <li class=
"md-nav__item">
1771 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1798 <li class=
"md-nav__item md-nav__item--nested">
1801 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1803 <label class=
"md-nav__link" for=
"__nav_7">
1805 <span class=
"md-nav__icon md-icon"></span>
1807 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1808 <label class=
"md-nav__title" for=
"__nav_7">
1809 <span class=
"md-nav__icon md-icon"></span>
1812 <ul class=
"md-nav__list" data-md-scrollfix
>
1819 <li class=
"md-nav__item md-nav__item--nested">
1822 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1824 <label class=
"md-nav__link" for=
"__nav_7_1">
1826 <span class=
"md-nav__icon md-icon"></span>
1828 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1829 <label class=
"md-nav__title" for=
"__nav_7_1">
1830 <span class=
"md-nav__icon md-icon"></span>
1833 <ul class=
"md-nav__list" data-md-scrollfix
>
1839 <li class=
"md-nav__item">
1840 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1851 <li class=
"md-nav__item">
1852 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1863 <li class=
"md-nav__item">
1864 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1875 <li class=
"md-nav__item">
1876 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1887 <li class=
"md-nav__item">
1888 <a href=
"../../tutorial/series/part_4/" class=
"md-nav__link">
1915 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1916 <div class=
"md-sidebar__scrollwrap">
1917 <div class=
"md-sidebar__inner">
1919 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1925 <label class=
"md-nav__title" for=
"__toc">
1926 <span class=
"md-nav__icon md-icon"></span>
1929 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1931 <li class=
"md-nav__item">
1932 <a href=
"#built-in-pips" class=
"md-nav__link">
1946 <div class=
"md-content" data-md-component=
"content">
1947 <article class=
"md-content__inner md-typeset">
1950 <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">
1951 <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>
1955 <h1 id=
"package-installation-plugins">Package Installation Plugins
<a class=
"headerlink" href=
"#package-installation-plugins" title=
"Permanent link">#
</a></h1>
1956 <p>Package Installation Plugins (PIPs) are interfaces to deploy and edit content as well as components.
</p>
1957 <div class=
"admonition info">
1958 <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>
1960 <h2 id=
"built-in-pips">Built-In PIPs
<a class=
"headerlink" href=
"#built-in-pips" title=
"Permanent link">#
</a></h2>
1965 <th>Description
</th>
1970 <td><a href=
"acl-option/">aclOption
</a></td>
1971 <td>Customizable permissions for individual objects
</td>
1974 <td><a href=
"acp-menu/">acpMenu
</a></td>
1975 <td>Admin panel menu categories and items
</td>
1978 <td><a href=
"acp-search-provider/">acpSearchProvider
</a></td>
1979 <td>Data provider for the admin panel search
</td>
1982 <td><a href=
"acp-template/">acpTemplate
</a></td>
1983 <td>Admin panel templates
</td>
1986 <td><a href=
"bbcode/">bbcode
</a></td>
1987 <td>BBCodes for rich message formatting
</td>
1990 <td><a href=
"box/">box
</a></td>
1991 <td>Boxes that can be placed anywhere on a page
</td>
1994 <td><a href=
"clipboard-action/">clipboardAction
</a></td>
1995 <td>Perform bulk operations on marked objects
</td>
1998 <td><a href=
"core-object/">coreObject
</a></td>
1999 <td>Access Singletons from within the template
</td>
2002 <td><a href=
"cronjob/">cronjob
</a></td>
2003 <td>Periodically execute code with customizable intervals
</td>
2006 <td><a href=
"database/">database
</a></td>
2007 <td>Updates the database layout using
<a href=
"../database-php-api/">the PHP API
</a></td>
2010 <td><a href=
"event-listener/">eventListener
</a></td>
2011 <td>Register listeners for the event system
</td>
2014 <td><a href=
"file/">file
</a></td>
2015 <td>Deploy any type of files with the exception of templates
</td>
2018 <td><a href=
"language/">language
</a></td>
2019 <td>Language items
</td>
2022 <td><a href=
"media-provider/">mediaProvider
</a></td>
2023 <td>Detect and convert links to media providers
</td>
2026 <td><a href=
"menu/">menu
</a></td>
2027 <td>Side-wide and custom per-page menus
</td>
2030 <td><a href=
"menu-item/">menuItem
</a></td>
2031 <td>Menu items for menus created through the menu PIP
</td>
2034 <td><a href=
"object-type/">objectType
</a></td>
2035 <td>Flexible type registry based on definitions
</td>
2038 <td><a href=
"object-type-definition/">objectTypeDefinition
</a></td>
2039 <td>Groups objects and classes by functionality
</td>
2042 <td><a href=
"option/">option
</a></td>
2043 <td>Side-wide configuration options
</td>
2046 <td><a href=
"page/">page
</a></td>
2047 <td>Register page controllers and text-based pages
</td>
2050 <td><a href=
"pip/">pip
</a></td>
2051 <td>Package Installation Plugins
</td>
2054 <td><a href=
"script/">script
</a></td>
2055 <td>Execute arbitrary PHP code during installation, update and uninstallation
</td>
2058 <td><a href=
"smiley/">smiley
</a></td>
2062 <td><a href=
"sql/">sql
</a></td>
2063 <td>Execute SQL instructions using a MySQL-flavored syntax (also see
<a href=
"../database-php-api/">database PHP API
</a>)
</td>
2066 <td><a href=
"style/">style
</a></td>
2070 <td><a href=
"template/">template
</a></td>
2071 <td>Frontend templates
</td>
2074 <td><a href=
"template-listener/">templateListener
</a></td>
2075 <td>Embed template code into templates without altering the original
</td>
2078 <td><a href=
"user-group-option/">userGroupOption
</a></td>
2079 <td>Permissions for user groups
</td>
2082 <td><a href=
"user-menu/">userMenu
</a></td>
2083 <td>User menu categories and items
</td>
2086 <td><a href=
"user-notification-event/">userNotificationEvent
</a></td>
2087 <td>Events of the user notification system
</td>
2090 <td><a href=
"user-option/">userOption
</a></td>
2091 <td>User settings
</td>
2094 <td><a href=
"user-profile-menu/">userProfileMenu
</a></td>
2095 <td>User profile tabs
</td>
2104 <div class=
"md-source-date">
2107 Last update:
2021-
03-
15
2126 <footer class=
"md-footer">
2128 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2130 <a href=
"../package-xml/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2131 <div class=
"md-footer__button md-icon">
2132 <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>
2134 <div class=
"md-footer__title">
2135 <div class=
"md-ellipsis">
2136 <span class=
"md-footer__direction">
2145 <a href=
"acl-option/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2146 <div class=
"md-footer__title">
2147 <div class=
"md-ellipsis">
2148 <span class=
"md-footer__direction">
2154 <div class=
"md-footer__button md-icon">
2155 <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>
2161 <div class=
"md-footer-meta md-typeset">
2162 <div class=
"md-footer-meta__inner md-grid">
2163 <div class=
"md-footer-copyright">
2165 <div class=
"md-footer-copyright__highlight">
2166 Copyright ©
2020 WoltLab GmbH
2170 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2175 <div class=
"md-footer-copyright">
2176 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2177 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2184 <div class=
"md-dialog" data-md-component=
"dialog">
2185 <div class=
"md-dialog__inner md-typeset"></div>
2187 <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>
2190 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>