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">
37 <link rel=
"stylesheet" href=
"../../stylesheets/extra.css">
51 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
56 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
57 <label class=
"md-overlay" for=
"__drawer"></label>
58 <div data-md-component=
"skip">
61 <a href=
"#package-installation-plugins" class=
"md-skip">
66 <div data-md-component=
"announce">
68 <aside class=
"md-announce">
69 <div class=
"md-announce__inner md-grid md-typeset">
71 <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">
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">
106 <div class=
"md-header__options">
110 <label class=
"md-header__button md-icon" for=
"__search">
111 <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>
114 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
115 <label class=
"md-search__overlay" for=
"__search"></label>
116 <div class=
"md-search__inner" role=
"search">
117 <form class=
"md-search__form" name=
"search">
118 <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
>
119 <label class=
"md-search__icon md-icon" for=
"__search">
120 <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>
121 <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>
123 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
124 <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>
127 <div class=
"md-search__output">
128 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
129 <div class=
"md-search-result" data-md-component=
"search-result">
130 <div class=
"md-search-result__meta">
133 <ol class=
"md-search-result__list"></ol>
144 <div class=
"md-container" data-md-component=
"container">
149 <main class=
"md-main" data-md-component=
"main">
150 <div class=
"md-main__inner md-grid">
154 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
155 <div class=
"md-sidebar__scrollwrap">
156 <div class=
"md-sidebar__inner">
162 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
163 <label class=
"md-nav__title" for=
"__drawer">
164 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
166 <img src=
"../../assets/logo.png" alt=
"logo">
169 WoltLab Suite Documentation
172 <ul class=
"md-nav__list" data-md-scrollfix
>
181 <li class=
"md-nav__item">
182 <a href=
"../../getting-started/" class=
"md-nav__link">
197 <li class=
"md-nav__item md-nav__item--nested">
200 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
202 <label class=
"md-nav__link" for=
"__nav_2">
204 <span class=
"md-nav__icon md-icon"></span>
206 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
207 <label class=
"md-nav__title" for=
"__nav_2">
208 <span class=
"md-nav__icon md-icon"></span>
211 <ul class=
"md-nav__list" data-md-scrollfix
>
217 <li class=
"md-nav__item">
218 <a href=
"../../php/pages/" class=
"md-nav__link">
229 <li class=
"md-nav__item">
230 <a href=
"../../php/database-objects/" class=
"md-nav__link">
241 <li class=
"md-nav__item">
242 <a href=
"../../php/database-access/" class=
"md-nav__link">
253 <li class=
"md-nav__item">
254 <a href=
"../../php/exceptions/" class=
"md-nav__link">
266 <li class=
"md-nav__item md-nav__item--nested">
269 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
271 <label class=
"md-nav__link" for=
"__nav_2_5">
273 <span class=
"md-nav__icon md-icon"></span>
275 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
276 <label class=
"md-nav__title" for=
"__nav_2_5">
277 <span class=
"md-nav__icon md-icon"></span>
280 <ul class=
"md-nav__list" data-md-scrollfix
>
286 <li class=
"md-nav__item">
287 <a href=
"../../php/api/caches/" class=
"md-nav__link">
298 <li class=
"md-nav__item">
299 <a href=
"../../php/api/comments/" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
322 <li class=
"md-nav__item">
323 <a href=
"../../php/api/events/" class=
"md-nav__link">
335 <li class=
"md-nav__item md-nav__item--nested">
338 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
340 <label class=
"md-nav__link" for=
"__nav_2_5_5">
342 <span class=
"md-nav__icon md-icon"></span>
344 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
345 <label class=
"md-nav__title" for=
"__nav_2_5_5">
346 <span class=
"md-nav__icon md-icon"></span>
349 <ul class=
"md-nav__list" data-md-scrollfix
>
355 <li class=
"md-nav__item">
356 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
367 <li class=
"md-nav__item">
368 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
379 <li class=
"md-nav__item">
380 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
391 <li class=
"md-nav__item">
392 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
403 <li class=
"md-nav__item">
404 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
421 <li class=
"md-nav__item">
422 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
423 Package Installation Plugins
433 <li class=
"md-nav__item">
434 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
445 <li class=
"md-nav__item">
446 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
457 <li class=
"md-nav__item">
458 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
475 <li class=
"md-nav__item">
476 <a href=
"../../php/code-style/" class=
"md-nav__link">
487 <li class=
"md-nav__item">
488 <a href=
"../../php/apps/" class=
"md-nav__link">
499 <li class=
"md-nav__item">
500 <a href=
"../../php/gdpr/" class=
"md-nav__link">
521 <li class=
"md-nav__item md-nav__item--nested">
524 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
526 <label class=
"md-nav__link" for=
"__nav_3">
527 Languages, Templates & CSS
528 <span class=
"md-nav__icon md-icon"></span>
530 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
531 <label class=
"md-nav__title" for=
"__nav_3">
532 <span class=
"md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
535 <ul class=
"md-nav__list" data-md-scrollfix
>
541 <li class=
"md-nav__item">
542 <a href=
"../../view/languages/" class=
"md-nav__link">
553 <li class=
"md-nav__item">
554 <a href=
"../../view/templates/" class=
"md-nav__link">
565 <li class=
"md-nav__item">
566 <a href=
"../../view/css/" class=
"md-nav__link">
587 <li class=
"md-nav__item md-nav__item--nested">
590 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
592 <label class=
"md-nav__link" for=
"__nav_4">
594 <span class=
"md-nav__icon md-icon"></span>
596 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
597 <label class=
"md-nav__title" for=
"__nav_4">
598 <span class=
"md-nav__icon md-icon"></span>
601 <ul class=
"md-nav__list" data-md-scrollfix
>
607 <li class=
"md-nav__item">
608 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
620 <li class=
"md-nav__item md-nav__item--nested">
623 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
625 <label class=
"md-nav__link" for=
"__nav_4_2">
627 <span class=
"md-nav__icon md-icon"></span>
629 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
630 <label class=
"md-nav__title" for=
"__nav_4_2">
631 <span class=
"md-nav__icon md-icon"></span>
634 <ul class=
"md-nav__list" data-md-scrollfix
>
640 <li class=
"md-nav__item">
641 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
652 <li class=
"md-nav__item">
653 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
664 <li class=
"md-nav__item">
665 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
676 <li class=
"md-nav__item">
677 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
688 <li class=
"md-nav__item">
689 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
700 <li class=
"md-nav__item">
701 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
712 <li class=
"md-nav__item">
713 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
724 <li class=
"md-nav__item">
725 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
726 Browser and Screen Sizes
736 <li class=
"md-nav__item">
737 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
754 <li class=
"md-nav__item">
755 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
766 <li class=
"md-nav__item">
767 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
778 <li class=
"md-nav__item">
779 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
802 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
805 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
807 <label class=
"md-nav__link" for=
"__nav_5">
809 <span class=
"md-nav__icon md-icon"></span>
811 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
812 <label class=
"md-nav__title" for=
"__nav_5">
813 <span class=
"md-nav__icon md-icon"></span>
816 <ul class=
"md-nav__list" data-md-scrollfix
>
822 <li class=
"md-nav__item">
823 <a href=
"../package-xml/" class=
"md-nav__link">
837 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
840 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
842 <label class=
"md-nav__link" for=
"__nav_5_2">
844 <span class=
"md-nav__icon md-icon"></span>
846 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
847 <label class=
"md-nav__title" for=
"__nav_5_2">
848 <span class=
"md-nav__icon md-icon"></span>
851 <ul class=
"md-nav__list" data-md-scrollfix
>
859 <li class=
"md-nav__item md-nav__item--active">
861 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
866 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
868 <span class=
"md-nav__icon md-icon"></span>
871 <a href=
"./" class=
"md-nav__link md-nav__link--active">
876 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
882 <label class=
"md-nav__title" for=
"__toc">
883 <span class=
"md-nav__icon md-icon"></span>
886 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
888 <li class=
"md-nav__item">
889 <a href=
"#built-in-pips" class=
"md-nav__link">
907 <li class=
"md-nav__item">
908 <a href=
"acl-option/" class=
"md-nav__link">
919 <li class=
"md-nav__item">
920 <a href=
"acp-menu/" class=
"md-nav__link">
931 <li class=
"md-nav__item">
932 <a href=
"acp-search-provider/" class=
"md-nav__link">
943 <li class=
"md-nav__item">
944 <a href=
"acp-template/" class=
"md-nav__link">
955 <li class=
"md-nav__item">
956 <a href=
"bbcode/" class=
"md-nav__link">
967 <li class=
"md-nav__item">
968 <a href=
"box/" class=
"md-nav__link">
979 <li class=
"md-nav__item">
980 <a href=
"clipboard-action/" class=
"md-nav__link">
991 <li class=
"md-nav__item">
992 <a href=
"core-object/" class=
"md-nav__link">
1003 <li class=
"md-nav__item">
1004 <a href=
"cronjob/" class=
"md-nav__link">
1015 <li class=
"md-nav__item">
1016 <a href=
"event-listener/" class=
"md-nav__link">
1027 <li class=
"md-nav__item">
1028 <a href=
"file/" class=
"md-nav__link">
1039 <li class=
"md-nav__item">
1040 <a href=
"language/" class=
"md-nav__link">
1051 <li class=
"md-nav__item">
1052 <a href=
"media-provider/" class=
"md-nav__link">
1063 <li class=
"md-nav__item">
1064 <a href=
"menu/" class=
"md-nav__link">
1075 <li class=
"md-nav__item">
1076 <a href=
"menu-item/" class=
"md-nav__link">
1087 <li class=
"md-nav__item">
1088 <a href=
"object-type/" class=
"md-nav__link">
1099 <li class=
"md-nav__item">
1100 <a href=
"object-type-definition/" class=
"md-nav__link">
1101 objectTypeDefinition
1111 <li class=
"md-nav__item">
1112 <a href=
"option/" class=
"md-nav__link">
1123 <li class=
"md-nav__item">
1124 <a href=
"page/" class=
"md-nav__link">
1135 <li class=
"md-nav__item">
1136 <a href=
"pip/" class=
"md-nav__link">
1147 <li class=
"md-nav__item">
1148 <a href=
"script/" class=
"md-nav__link">
1159 <li class=
"md-nav__item">
1160 <a href=
"smiley/" class=
"md-nav__link">
1171 <li class=
"md-nav__item">
1172 <a href=
"sql/" class=
"md-nav__link">
1183 <li class=
"md-nav__item">
1184 <a href=
"style/" class=
"md-nav__link">
1195 <li class=
"md-nav__item">
1196 <a href=
"template/" class=
"md-nav__link">
1207 <li class=
"md-nav__item">
1208 <a href=
"template-listener/" class=
"md-nav__link">
1219 <li class=
"md-nav__item">
1220 <a href=
"user-group-option/" class=
"md-nav__link">
1231 <li class=
"md-nav__item">
1232 <a href=
"user-menu/" class=
"md-nav__link">
1243 <li class=
"md-nav__item">
1244 <a href=
"user-notification-event/" class=
"md-nav__link">
1245 userNotificationEvent
1255 <li class=
"md-nav__item">
1256 <a href=
"user-option/" class=
"md-nav__link">
1267 <li class=
"md-nav__item">
1268 <a href=
"user-profile-menu/" class=
"md-nav__link">
1285 <li class=
"md-nav__item">
1286 <a href=
"../database-php-api/" class=
"md-nav__link">
1307 <li class=
"md-nav__item md-nav__item--nested">
1310 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1312 <label class=
"md-nav__link" for=
"__nav_6">
1314 <span class=
"md-nav__icon md-icon"></span>
1316 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1317 <label class=
"md-nav__title" for=
"__nav_6">
1318 <span class=
"md-nav__icon md-icon"></span>
1321 <ul class=
"md-nav__list" data-md-scrollfix
>
1328 <li class=
"md-nav__item md-nav__item--nested">
1331 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1333 <label class=
"md-nav__link" for=
"__nav_6_1">
1334 Migrating from WSC
5.3
1335 <span class=
"md-nav__icon md-icon"></span>
1337 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1338 <label class=
"md-nav__title" for=
"__nav_6_1">
1339 <span class=
"md-nav__icon md-icon"></span>
1340 Migrating from WSC
5.3
1342 <ul class=
"md-nav__list" data-md-scrollfix
>
1348 <li class=
"md-nav__item">
1349 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1360 <li class=
"md-nav__item">
1361 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1362 Session Handling and Authentication
1372 <li class=
"md-nav__item">
1373 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1384 <li class=
"md-nav__item">
1385 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1396 <li class=
"md-nav__item">
1397 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1398 Third Party Libraries
1415 <li class=
"md-nav__item md-nav__item--nested">
1418 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1420 <label class=
"md-nav__link" for=
"__nav_6_2">
1421 Migrating from WSC
5.2
1422 <span class=
"md-nav__icon md-icon"></span>
1424 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1425 <label class=
"md-nav__title" for=
"__nav_6_2">
1426 <span class=
"md-nav__icon md-icon"></span>
1427 Migrating from WSC
5.2
1429 <ul class=
"md-nav__list" data-md-scrollfix
>
1435 <li class=
"md-nav__item">
1436 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1447 <li class=
"md-nav__item">
1448 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1449 Templates and Languages
1459 <li class=
"md-nav__item">
1460 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1461 Third Party Libraries
1478 <li class=
"md-nav__item md-nav__item--nested">
1481 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1483 <label class=
"md-nav__link" for=
"__nav_6_3">
1484 Migrating from WSC
3.1
1485 <span class=
"md-nav__icon md-icon"></span>
1487 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1488 <label class=
"md-nav__title" for=
"__nav_6_3">
1489 <span class=
"md-nav__icon md-icon"></span>
1490 Migrating from WSC
3.1
1492 <ul class=
"md-nav__list" data-md-scrollfix
>
1498 <li class=
"md-nav__item">
1499 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1517 <li class=
"md-nav__item md-nav__item--nested">
1520 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1522 <label class=
"md-nav__link" for=
"__nav_6_4">
1523 Migrating from WSC
3.0
1524 <span class=
"md-nav__icon md-icon"></span>
1526 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1527 <label class=
"md-nav__title" for=
"__nav_6_4">
1528 <span class=
"md-nav__icon md-icon"></span>
1529 Migrating from WSC
3.0
1531 <ul class=
"md-nav__list" data-md-scrollfix
>
1537 <li class=
"md-nav__item">
1538 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1549 <li class=
"md-nav__item">
1550 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1561 <li class=
"md-nav__item">
1562 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1573 <li class=
"md-nav__item">
1574 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1585 <li class=
"md-nav__item">
1586 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1604 <li class=
"md-nav__item md-nav__item--nested">
1607 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1609 <label class=
"md-nav__link" for=
"__nav_6_5">
1610 Migrating from WCF
2.1
1611 <span class=
"md-nav__icon md-icon"></span>
1613 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1614 <label class=
"md-nav__title" for=
"__nav_6_5">
1615 <span class=
"md-nav__icon md-icon"></span>
1616 Migrating from WCF
2.1
1618 <ul class=
"md-nav__list" data-md-scrollfix
>
1624 <li class=
"md-nav__item">
1625 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1636 <li class=
"md-nav__item">
1637 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1648 <li class=
"md-nav__item">
1649 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1660 <li class=
"md-nav__item">
1661 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1688 <li class=
"md-nav__item md-nav__item--nested">
1691 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1693 <label class=
"md-nav__link" for=
"__nav_7">
1695 <span class=
"md-nav__icon md-icon"></span>
1697 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1698 <label class=
"md-nav__title" for=
"__nav_7">
1699 <span class=
"md-nav__icon md-icon"></span>
1702 <ul class=
"md-nav__list" data-md-scrollfix
>
1709 <li class=
"md-nav__item md-nav__item--nested">
1712 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1714 <label class=
"md-nav__link" for=
"__nav_7_1">
1716 <span class=
"md-nav__icon md-icon"></span>
1718 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1719 <label class=
"md-nav__title" for=
"__nav_7_1">
1720 <span class=
"md-nav__icon md-icon"></span>
1723 <ul class=
"md-nav__list" data-md-scrollfix
>
1729 <li class=
"md-nav__item">
1730 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1741 <li class=
"md-nav__item">
1742 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1753 <li class=
"md-nav__item">
1754 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1765 <li class=
"md-nav__item">
1766 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1793 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1794 <div class=
"md-sidebar__scrollwrap">
1795 <div class=
"md-sidebar__inner">
1797 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1803 <label class=
"md-nav__title" for=
"__toc">
1804 <span class=
"md-nav__icon md-icon"></span>
1807 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1809 <li class=
"md-nav__item">
1810 <a href=
"#built-in-pips" class=
"md-nav__link">
1824 <div class=
"md-content" data-md-component=
"content">
1825 <article class=
"md-content__inner md-typeset">
1829 <h1 id=
"package-installation-plugins">Package Installation Plugins
<a class=
"headerlink" href=
"#package-installation-plugins" title=
"Permanent link">#
</a></h1>
1830 <p>Package Installation Plugins (PIPs) are interfaces to deploy and edit content as well as components.
</p>
1831 <div class=
"admonition info">
1832 <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>
1834 <h2 id=
"built-in-pips">Built-In PIPs
<a class=
"headerlink" href=
"#built-in-pips" title=
"Permanent link">#
</a></h2>
1839 <th>Description
</th>
1844 <td><a href=
"acl-option/">aclOption
</a></td>
1845 <td>Customizable permissions for individual objects
</td>
1848 <td><a href=
"acp-menu/">acpMenu
</a></td>
1849 <td>Admin panel menu categories and items
</td>
1852 <td><a href=
"acp-search-provider/">acpSearchProvider
</a></td>
1853 <td>Data provider for the admin panel search
</td>
1856 <td><a href=
"acp-template/">acpTemplate
</a></td>
1857 <td>Admin panel templates
</td>
1860 <td><a href=
"bbcode/">bbcode
</a></td>
1861 <td>BBCodes for rich message formatting
</td>
1864 <td><a href=
"box/">box
</a></td>
1865 <td>Boxes that can be placed anywhere on a page
</td>
1868 <td><a href=
"clipboard-action/">clipboardAction
</a></td>
1869 <td>Perform bulk operations on marked objects
</td>
1872 <td><a href=
"core-object/">coreObject
</a></td>
1873 <td>Access Singletons from within the template
</td>
1876 <td><a href=
"cronjob/">cronjob
</a></td>
1877 <td>Periodically execute code with customizable intervals
</td>
1880 <td><a href=
"event-listener/">eventListener
</a></td>
1881 <td>Register listeners for the event system
</td>
1884 <td><a href=
"file/">file
</a></td>
1885 <td>Deploy any type of files with the exception of templates
</td>
1888 <td><a href=
"language/">language
</a></td>
1889 <td>Language items
</td>
1892 <td><a href=
"media-provider/">mediaProvider
</a></td>
1893 <td>Detect and convert links to media providers
</td>
1896 <td><a href=
"menu/">menu
</a></td>
1897 <td>Side-wide and custom per-page menus
</td>
1900 <td><a href=
"menu-item/">menuItem
</a></td>
1901 <td>Menu items for menus created through the menu PIP
</td>
1904 <td><a href=
"object-type/">objectType
</a></td>
1905 <td>Flexible type registry based on definitions
</td>
1908 <td><a href=
"object-type-definition/">objectTypeDefinition
</a></td>
1909 <td>Groups objects and classes by functionality
</td>
1912 <td><a href=
"option/">option
</a></td>
1913 <td>Side-wide configuration options
</td>
1916 <td><a href=
"page/">page
</a></td>
1917 <td>Register page controllers and text-based pages
</td>
1920 <td><a href=
"pip/">pip
</a></td>
1921 <td>Package Installation Plugins
</td>
1924 <td><a href=
"script/">script
</a></td>
1925 <td>Execute arbitrary PHP code during installation, update and uninstallation
</td>
1928 <td><a href=
"smiley/">smiley
</a></td>
1932 <td><a href=
"sql/">sql
</a></td>
1933 <td>Execute SQL instructions using a MySQL-flavored syntax (also see
<a href=
"../database-php-api/">database PHP API
</a>)
</td>
1936 <td><a href=
"style/">style
</a></td>
1940 <td><a href=
"template/">template
</a></td>
1941 <td>Frontend templates
</td>
1944 <td><a href=
"template-listener/">templateListener
</a></td>
1945 <td>Embed template code into templates without altering the original
</td>
1948 <td><a href=
"user-group-option/">userGroupOption
</a></td>
1949 <td>Permissions for user groups
</td>
1952 <td><a href=
"user-menu/">userMenu
</a></td>
1953 <td>User menu categories and items
</td>
1956 <td><a href=
"user-notification-event/">userNotificationEvent
</a></td>
1957 <td>Events of the user notification system
</td>
1960 <td><a href=
"user-option/">userOption
</a></td>
1961 <td>User settings
</td>
1964 <td><a href=
"user-profile-menu/">userProfileMenu
</a></td>
1965 <td>User profile tabs
</td>
1982 <footer class=
"md-footer">
1984 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
1986 <a href=
"../package-xml/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
1987 <div class=
"md-footer__button md-icon">
1988 <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>
1990 <div class=
"md-footer__title">
1991 <div class=
"md-ellipsis">
1992 <span class=
"md-footer__direction">
2001 <a href=
"acl-option/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2002 <div class=
"md-footer__title">
2003 <div class=
"md-ellipsis">
2004 <span class=
"md-footer__direction">
2010 <div class=
"md-footer__button md-icon">
2011 <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>
2017 <div class=
"md-footer-meta md-typeset">
2018 <div class=
"md-footer-meta__inner md-grid">
2019 <div class=
"md-footer-copyright">
2021 <div class=
"md-footer-copyright__highlight">
2022 Copyright ©
2020 WoltLab GmbH
2026 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2031 <div class=
"md-footer-copyright">
2032 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2033 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2040 <div class=
"md-dialog" data-md-component=
"dialog">
2041 <div class=
"md-dialog__inner md-typeset"></div>
2043 <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>
2046 <script src=
"../../assets/javascripts/bundle.5cf3e710.min.js"></script>