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>
145 <div class=
"md-container" data-md-component=
"container">
150 <main class=
"md-main" data-md-component=
"main">
151 <div class=
"md-main__inner md-grid">
155 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
156 <div class=
"md-sidebar__scrollwrap">
157 <div class=
"md-sidebar__inner">
163 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
164 <label class=
"md-nav__title" for=
"__drawer">
165 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
167 <img src=
"../../assets/logo.png" alt=
"logo">
170 WoltLab Suite Documentation
173 <ul class=
"md-nav__list" data-md-scrollfix
>
182 <li class=
"md-nav__item">
183 <a href=
"../../getting-started/" class=
"md-nav__link">
198 <li class=
"md-nav__item md-nav__item--nested">
201 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
203 <label class=
"md-nav__link" for=
"__nav_2">
205 <span class=
"md-nav__icon md-icon"></span>
207 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
208 <label class=
"md-nav__title" for=
"__nav_2">
209 <span class=
"md-nav__icon md-icon"></span>
212 <ul class=
"md-nav__list" data-md-scrollfix
>
218 <li class=
"md-nav__item">
219 <a href=
"../../php/pages/" class=
"md-nav__link">
230 <li class=
"md-nav__item">
231 <a href=
"../../php/database-objects/" class=
"md-nav__link">
242 <li class=
"md-nav__item">
243 <a href=
"../../php/database-access/" class=
"md-nav__link">
254 <li class=
"md-nav__item">
255 <a href=
"../../php/exceptions/" class=
"md-nav__link">
267 <li class=
"md-nav__item md-nav__item--nested">
270 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
272 <label class=
"md-nav__link" for=
"__nav_2_5">
274 <span class=
"md-nav__icon md-icon"></span>
276 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
277 <label class=
"md-nav__title" for=
"__nav_2_5">
278 <span class=
"md-nav__icon md-icon"></span>
281 <ul class=
"md-nav__list" data-md-scrollfix
>
287 <li class=
"md-nav__item">
288 <a href=
"../../php/api/caches/" class=
"md-nav__link">
299 <li class=
"md-nav__item">
300 <a href=
"../../php/api/comments/" class=
"md-nav__link">
311 <li class=
"md-nav__item">
312 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
323 <li class=
"md-nav__item">
324 <a href=
"../../php/api/events/" class=
"md-nav__link">
336 <li class=
"md-nav__item md-nav__item--nested">
339 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
341 <label class=
"md-nav__link" for=
"__nav_2_5_5">
343 <span class=
"md-nav__icon md-icon"></span>
345 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
346 <label class=
"md-nav__title" for=
"__nav_2_5_5">
347 <span class=
"md-nav__icon md-icon"></span>
350 <ul class=
"md-nav__list" data-md-scrollfix
>
356 <li class=
"md-nav__item">
357 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
368 <li class=
"md-nav__item">
369 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
380 <li class=
"md-nav__item">
381 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
392 <li class=
"md-nav__item">
393 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
404 <li class=
"md-nav__item">
405 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
422 <li class=
"md-nav__item">
423 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
424 Package Installation Plugins
434 <li class=
"md-nav__item">
435 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
446 <li class=
"md-nav__item">
447 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
458 <li class=
"md-nav__item">
459 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
476 <li class=
"md-nav__item">
477 <a href=
"../../php/code-style/" class=
"md-nav__link">
488 <li class=
"md-nav__item">
489 <a href=
"../../php/apps/" class=
"md-nav__link">
500 <li class=
"md-nav__item">
501 <a href=
"../../php/gdpr/" class=
"md-nav__link">
522 <li class=
"md-nav__item md-nav__item--nested">
525 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
527 <label class=
"md-nav__link" for=
"__nav_3">
528 Languages, Templates & CSS
529 <span class=
"md-nav__icon md-icon"></span>
531 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
532 <label class=
"md-nav__title" for=
"__nav_3">
533 <span class=
"md-nav__icon md-icon"></span>
534 Languages, Templates & CSS
536 <ul class=
"md-nav__list" data-md-scrollfix
>
542 <li class=
"md-nav__item">
543 <a href=
"../../view/languages/" class=
"md-nav__link">
554 <li class=
"md-nav__item">
555 <a href=
"../../view/templates/" class=
"md-nav__link">
566 <li class=
"md-nav__item">
567 <a href=
"../../view/css/" class=
"md-nav__link">
588 <li class=
"md-nav__item md-nav__item--nested">
591 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
593 <label class=
"md-nav__link" for=
"__nav_4">
595 <span class=
"md-nav__icon md-icon"></span>
597 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
598 <label class=
"md-nav__title" for=
"__nav_4">
599 <span class=
"md-nav__icon md-icon"></span>
602 <ul class=
"md-nav__list" data-md-scrollfix
>
608 <li class=
"md-nav__item">
609 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
621 <li class=
"md-nav__item md-nav__item--nested">
624 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
626 <label class=
"md-nav__link" for=
"__nav_4_2">
628 <span class=
"md-nav__icon md-icon"></span>
630 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
631 <label class=
"md-nav__title" for=
"__nav_4_2">
632 <span class=
"md-nav__icon md-icon"></span>
635 <ul class=
"md-nav__list" data-md-scrollfix
>
641 <li class=
"md-nav__item">
642 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
653 <li class=
"md-nav__item">
654 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
665 <li class=
"md-nav__item">
666 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
677 <li class=
"md-nav__item">
678 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
689 <li class=
"md-nav__item">
690 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
701 <li class=
"md-nav__item">
702 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
713 <li class=
"md-nav__item">
714 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
725 <li class=
"md-nav__item">
726 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
727 Browser and Screen Sizes
737 <li class=
"md-nav__item">
738 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
755 <li class=
"md-nav__item">
756 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
767 <li class=
"md-nav__item">
768 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
779 <li class=
"md-nav__item">
780 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
803 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
806 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
808 <label class=
"md-nav__link" for=
"__nav_5">
810 <span class=
"md-nav__icon md-icon"></span>
812 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
813 <label class=
"md-nav__title" for=
"__nav_5">
814 <span class=
"md-nav__icon md-icon"></span>
817 <ul class=
"md-nav__list" data-md-scrollfix
>
823 <li class=
"md-nav__item">
824 <a href=
"../package-xml/" class=
"md-nav__link">
838 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
841 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
843 <label class=
"md-nav__link" for=
"__nav_5_2">
845 <span class=
"md-nav__icon md-icon"></span>
847 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
848 <label class=
"md-nav__title" for=
"__nav_5_2">
849 <span class=
"md-nav__icon md-icon"></span>
852 <ul class=
"md-nav__list" data-md-scrollfix
>
860 <li class=
"md-nav__item md-nav__item--active">
862 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
867 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
869 <span class=
"md-nav__icon md-icon"></span>
872 <a href=
"./" class=
"md-nav__link md-nav__link--active">
877 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
883 <label class=
"md-nav__title" for=
"__toc">
884 <span class=
"md-nav__icon md-icon"></span>
887 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
889 <li class=
"md-nav__item">
890 <a href=
"#built-in-pips" class=
"md-nav__link">
908 <li class=
"md-nav__item">
909 <a href=
"acl-option/" class=
"md-nav__link">
920 <li class=
"md-nav__item">
921 <a href=
"acp-menu/" class=
"md-nav__link">
932 <li class=
"md-nav__item">
933 <a href=
"acp-search-provider/" class=
"md-nav__link">
944 <li class=
"md-nav__item">
945 <a href=
"acp-template/" class=
"md-nav__link">
956 <li class=
"md-nav__item">
957 <a href=
"bbcode/" class=
"md-nav__link">
968 <li class=
"md-nav__item">
969 <a href=
"box/" class=
"md-nav__link">
980 <li class=
"md-nav__item">
981 <a href=
"clipboard-action/" class=
"md-nav__link">
992 <li class=
"md-nav__item">
993 <a href=
"core-object/" class=
"md-nav__link">
1004 <li class=
"md-nav__item">
1005 <a href=
"cronjob/" class=
"md-nav__link">
1016 <li class=
"md-nav__item">
1017 <a href=
"event-listener/" class=
"md-nav__link">
1028 <li class=
"md-nav__item">
1029 <a href=
"file/" class=
"md-nav__link">
1040 <li class=
"md-nav__item">
1041 <a href=
"language/" class=
"md-nav__link">
1052 <li class=
"md-nav__item">
1053 <a href=
"media-provider/" class=
"md-nav__link">
1064 <li class=
"md-nav__item">
1065 <a href=
"menu/" class=
"md-nav__link">
1076 <li class=
"md-nav__item">
1077 <a href=
"menu-item/" class=
"md-nav__link">
1088 <li class=
"md-nav__item">
1089 <a href=
"object-type/" class=
"md-nav__link">
1100 <li class=
"md-nav__item">
1101 <a href=
"object-type-definition/" class=
"md-nav__link">
1102 objectTypeDefinition
1112 <li class=
"md-nav__item">
1113 <a href=
"option/" class=
"md-nav__link">
1124 <li class=
"md-nav__item">
1125 <a href=
"page/" class=
"md-nav__link">
1136 <li class=
"md-nav__item">
1137 <a href=
"pip/" class=
"md-nav__link">
1148 <li class=
"md-nav__item">
1149 <a href=
"script/" class=
"md-nav__link">
1160 <li class=
"md-nav__item">
1161 <a href=
"smiley/" class=
"md-nav__link">
1172 <li class=
"md-nav__item">
1173 <a href=
"sql/" class=
"md-nav__link">
1184 <li class=
"md-nav__item">
1185 <a href=
"style/" class=
"md-nav__link">
1196 <li class=
"md-nav__item">
1197 <a href=
"template/" class=
"md-nav__link">
1208 <li class=
"md-nav__item">
1209 <a href=
"template-listener/" class=
"md-nav__link">
1220 <li class=
"md-nav__item">
1221 <a href=
"user-group-option/" class=
"md-nav__link">
1232 <li class=
"md-nav__item">
1233 <a href=
"user-menu/" class=
"md-nav__link">
1244 <li class=
"md-nav__item">
1245 <a href=
"user-notification-event/" class=
"md-nav__link">
1246 userNotificationEvent
1256 <li class=
"md-nav__item">
1257 <a href=
"user-option/" class=
"md-nav__link">
1268 <li class=
"md-nav__item">
1269 <a href=
"user-profile-menu/" class=
"md-nav__link">
1286 <li class=
"md-nav__item">
1287 <a href=
"../database-php-api/" class=
"md-nav__link">
1308 <li class=
"md-nav__item md-nav__item--nested">
1311 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1313 <label class=
"md-nav__link" for=
"__nav_6">
1315 <span class=
"md-nav__icon md-icon"></span>
1317 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1318 <label class=
"md-nav__title" for=
"__nav_6">
1319 <span class=
"md-nav__icon md-icon"></span>
1322 <ul class=
"md-nav__list" data-md-scrollfix
>
1329 <li class=
"md-nav__item md-nav__item--nested">
1332 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1334 <label class=
"md-nav__link" for=
"__nav_6_1">
1335 Migrating from WSC
5.3
1336 <span class=
"md-nav__icon md-icon"></span>
1338 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1339 <label class=
"md-nav__title" for=
"__nav_6_1">
1340 <span class=
"md-nav__icon md-icon"></span>
1341 Migrating from WSC
5.3
1343 <ul class=
"md-nav__list" data-md-scrollfix
>
1349 <li class=
"md-nav__item">
1350 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1361 <li class=
"md-nav__item">
1362 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1363 Session Handling and Authentication
1373 <li class=
"md-nav__item">
1374 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1385 <li class=
"md-nav__item">
1386 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1397 <li class=
"md-nav__item">
1398 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1399 Third Party Libraries
1416 <li class=
"md-nav__item md-nav__item--nested">
1419 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1421 <label class=
"md-nav__link" for=
"__nav_6_2">
1422 Migrating from WSC
5.2
1423 <span class=
"md-nav__icon md-icon"></span>
1425 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1426 <label class=
"md-nav__title" for=
"__nav_6_2">
1427 <span class=
"md-nav__icon md-icon"></span>
1428 Migrating from WSC
5.2
1430 <ul class=
"md-nav__list" data-md-scrollfix
>
1436 <li class=
"md-nav__item">
1437 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1448 <li class=
"md-nav__item">
1449 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1450 Templates and Languages
1460 <li class=
"md-nav__item">
1461 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1462 Third Party Libraries
1479 <li class=
"md-nav__item md-nav__item--nested">
1482 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1484 <label class=
"md-nav__link" for=
"__nav_6_3">
1485 Migrating from WSC
3.1
1486 <span class=
"md-nav__icon md-icon"></span>
1488 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1489 <label class=
"md-nav__title" for=
"__nav_6_3">
1490 <span class=
"md-nav__icon md-icon"></span>
1491 Migrating from WSC
3.1
1493 <ul class=
"md-nav__list" data-md-scrollfix
>
1499 <li class=
"md-nav__item">
1500 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1518 <li class=
"md-nav__item md-nav__item--nested">
1521 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1523 <label class=
"md-nav__link" for=
"__nav_6_4">
1524 Migrating from WSC
3.0
1525 <span class=
"md-nav__icon md-icon"></span>
1527 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1528 <label class=
"md-nav__title" for=
"__nav_6_4">
1529 <span class=
"md-nav__icon md-icon"></span>
1530 Migrating from WSC
3.0
1532 <ul class=
"md-nav__list" data-md-scrollfix
>
1538 <li class=
"md-nav__item">
1539 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1550 <li class=
"md-nav__item">
1551 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1562 <li class=
"md-nav__item">
1563 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1574 <li class=
"md-nav__item">
1575 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1586 <li class=
"md-nav__item">
1587 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1605 <li class=
"md-nav__item md-nav__item--nested">
1608 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1610 <label class=
"md-nav__link" for=
"__nav_6_5">
1611 Migrating from WCF
2.1
1612 <span class=
"md-nav__icon md-icon"></span>
1614 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1615 <label class=
"md-nav__title" for=
"__nav_6_5">
1616 <span class=
"md-nav__icon md-icon"></span>
1617 Migrating from WCF
2.1
1619 <ul class=
"md-nav__list" data-md-scrollfix
>
1625 <li class=
"md-nav__item">
1626 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1637 <li class=
"md-nav__item">
1638 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1649 <li class=
"md-nav__item">
1650 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1661 <li class=
"md-nav__item">
1662 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1689 <li class=
"md-nav__item md-nav__item--nested">
1692 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1694 <label class=
"md-nav__link" for=
"__nav_7">
1696 <span class=
"md-nav__icon md-icon"></span>
1698 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1699 <label class=
"md-nav__title" for=
"__nav_7">
1700 <span class=
"md-nav__icon md-icon"></span>
1703 <ul class=
"md-nav__list" data-md-scrollfix
>
1710 <li class=
"md-nav__item md-nav__item--nested">
1713 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1715 <label class=
"md-nav__link" for=
"__nav_7_1">
1717 <span class=
"md-nav__icon md-icon"></span>
1719 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1720 <label class=
"md-nav__title" for=
"__nav_7_1">
1721 <span class=
"md-nav__icon md-icon"></span>
1724 <ul class=
"md-nav__list" data-md-scrollfix
>
1730 <li class=
"md-nav__item">
1731 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1742 <li class=
"md-nav__item">
1743 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1754 <li class=
"md-nav__item">
1755 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1766 <li class=
"md-nav__item">
1767 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1794 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1795 <div class=
"md-sidebar__scrollwrap">
1796 <div class=
"md-sidebar__inner">
1798 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1804 <label class=
"md-nav__title" for=
"__toc">
1805 <span class=
"md-nav__icon md-icon"></span>
1808 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1810 <li class=
"md-nav__item">
1811 <a href=
"#built-in-pips" class=
"md-nav__link">
1825 <div class=
"md-content" data-md-component=
"content">
1826 <article class=
"md-content__inner md-typeset">
1830 <h1 id=
"package-installation-plugins">Package Installation Plugins
<a class=
"headerlink" href=
"#package-installation-plugins" title=
"Permanent link">#
</a></h1>
1831 <p>Package Installation Plugins (PIPs) are interfaces to deploy and edit content as well as components.
</p>
1832 <div class=
"admonition info">
1833 <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>
1835 <h2 id=
"built-in-pips">Built-In PIPs
<a class=
"headerlink" href=
"#built-in-pips" title=
"Permanent link">#
</a></h2>
1840 <th>Description
</th>
1845 <td><a href=
"acl-option/">aclOption
</a></td>
1846 <td>Customizable permissions for individual objects
</td>
1849 <td><a href=
"acp-menu/">acpMenu
</a></td>
1850 <td>Admin panel menu categories and items
</td>
1853 <td><a href=
"acp-search-provider/">acpSearchProvider
</a></td>
1854 <td>Data provider for the admin panel search
</td>
1857 <td><a href=
"acp-template/">acpTemplate
</a></td>
1858 <td>Admin panel templates
</td>
1861 <td><a href=
"bbcode/">bbcode
</a></td>
1862 <td>BBCodes for rich message formatting
</td>
1865 <td><a href=
"box/">box
</a></td>
1866 <td>Boxes that can be placed anywhere on a page
</td>
1869 <td><a href=
"clipboard-action/">clipboardAction
</a></td>
1870 <td>Perform bulk operations on marked objects
</td>
1873 <td><a href=
"core-object/">coreObject
</a></td>
1874 <td>Access Singletons from within the template
</td>
1877 <td><a href=
"cronjob/">cronjob
</a></td>
1878 <td>Periodically execute code with customizable intervals
</td>
1881 <td><a href=
"database/">database
</a></td>
1882 <td>Updates the database layout using
<a href=
"../database-php-api/">the PHP API
</a></td>
1885 <td><a href=
"event-listener/">eventListener
</a></td>
1886 <td>Register listeners for the event system
</td>
1889 <td><a href=
"file/">file
</a></td>
1890 <td>Deploy any type of files with the exception of templates
</td>
1893 <td><a href=
"language/">language
</a></td>
1894 <td>Language items
</td>
1897 <td><a href=
"media-provider/">mediaProvider
</a></td>
1898 <td>Detect and convert links to media providers
</td>
1901 <td><a href=
"menu/">menu
</a></td>
1902 <td>Side-wide and custom per-page menus
</td>
1905 <td><a href=
"menu-item/">menuItem
</a></td>
1906 <td>Menu items for menus created through the menu PIP
</td>
1909 <td><a href=
"object-type/">objectType
</a></td>
1910 <td>Flexible type registry based on definitions
</td>
1913 <td><a href=
"object-type-definition/">objectTypeDefinition
</a></td>
1914 <td>Groups objects and classes by functionality
</td>
1917 <td><a href=
"option/">option
</a></td>
1918 <td>Side-wide configuration options
</td>
1921 <td><a href=
"page/">page
</a></td>
1922 <td>Register page controllers and text-based pages
</td>
1925 <td><a href=
"pip/">pip
</a></td>
1926 <td>Package Installation Plugins
</td>
1929 <td><a href=
"script/">script
</a></td>
1930 <td>Execute arbitrary PHP code during installation, update and uninstallation
</td>
1933 <td><a href=
"smiley/">smiley
</a></td>
1937 <td><a href=
"sql/">sql
</a></td>
1938 <td>Execute SQL instructions using a MySQL-flavored syntax (also see
<a href=
"../database-php-api/">database PHP API
</a>)
</td>
1941 <td><a href=
"style/">style
</a></td>
1945 <td><a href=
"template/">template
</a></td>
1946 <td>Frontend templates
</td>
1949 <td><a href=
"template-listener/">templateListener
</a></td>
1950 <td>Embed template code into templates without altering the original
</td>
1953 <td><a href=
"user-group-option/">userGroupOption
</a></td>
1954 <td>Permissions for user groups
</td>
1957 <td><a href=
"user-menu/">userMenu
</a></td>
1958 <td>User menu categories and items
</td>
1961 <td><a href=
"user-notification-event/">userNotificationEvent
</a></td>
1962 <td>Events of the user notification system
</td>
1965 <td><a href=
"user-option/">userOption
</a></td>
1966 <td>User settings
</td>
1969 <td><a href=
"user-profile-menu/">userProfileMenu
</a></td>
1970 <td>User profile tabs
</td>
1987 <footer class=
"md-footer">
1989 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
1991 <a href=
"../package-xml/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
1992 <div class=
"md-footer__button md-icon">
1993 <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>
1995 <div class=
"md-footer__title">
1996 <div class=
"md-ellipsis">
1997 <span class=
"md-footer__direction">
2006 <a href=
"acl-option/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2007 <div class=
"md-footer__title">
2008 <div class=
"md-ellipsis">
2009 <span class=
"md-footer__direction">
2015 <div class=
"md-footer__button md-icon">
2016 <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>
2022 <div class=
"md-footer-meta md-typeset">
2023 <div class=
"md-footer-meta__inner md-grid">
2024 <div class=
"md-footer-copyright">
2026 <div class=
"md-footer-copyright__highlight">
2027 Copyright ©
2020 WoltLab GmbH
2031 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2036 <div class=
"md-footer-copyright">
2037 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2038 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2045 <div class=
"md-dialog" data-md-component=
"dialog">
2046 <div class=
"md-dialog__inner md-typeset"></div>
2048 <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>
2051 <script src=
"../../assets/javascripts/bundle.5cf3e710.min.js"></script>