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>Apps - 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=
"#apps-for-woltlab-suite" 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">
199 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
202 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" checked
>
204 <label class=
"md-nav__link" for=
"__nav_2">
206 <span class=
"md-nav__icon md-icon"></span>
208 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
209 <label class=
"md-nav__title" for=
"__nav_2">
210 <span class=
"md-nav__icon md-icon"></span>
213 <ul class=
"md-nav__list" data-md-scrollfix
>
219 <li class=
"md-nav__item">
220 <a href=
"../pages/" class=
"md-nav__link">
231 <li class=
"md-nav__item">
232 <a href=
"../database-objects/" class=
"md-nav__link">
243 <li class=
"md-nav__item">
244 <a href=
"../database-access/" class=
"md-nav__link">
255 <li class=
"md-nav__item">
256 <a href=
"../exceptions/" class=
"md-nav__link">
268 <li class=
"md-nav__item md-nav__item--nested">
271 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
273 <label class=
"md-nav__link" for=
"__nav_2_5">
275 <span class=
"md-nav__icon md-icon"></span>
277 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
278 <label class=
"md-nav__title" for=
"__nav_2_5">
279 <span class=
"md-nav__icon md-icon"></span>
282 <ul class=
"md-nav__list" data-md-scrollfix
>
288 <li class=
"md-nav__item">
289 <a href=
"../api/caches/" class=
"md-nav__link">
300 <li class=
"md-nav__item">
301 <a href=
"../api/comments/" class=
"md-nav__link">
312 <li class=
"md-nav__item">
313 <a href=
"../api/cronjobs/" class=
"md-nav__link">
324 <li class=
"md-nav__item">
325 <a href=
"../api/events/" class=
"md-nav__link">
337 <li class=
"md-nav__item md-nav__item--nested">
340 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
342 <label class=
"md-nav__link" for=
"__nav_2_5_5">
344 <span class=
"md-nav__icon md-icon"></span>
346 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
347 <label class=
"md-nav__title" for=
"__nav_2_5_5">
348 <span class=
"md-nav__icon md-icon"></span>
351 <ul class=
"md-nav__list" data-md-scrollfix
>
357 <li class=
"md-nav__item">
358 <a href=
"../api/form_builder/overview/" class=
"md-nav__link">
369 <li class=
"md-nav__item">
370 <a href=
"../api/form_builder/structure/" class=
"md-nav__link">
381 <li class=
"md-nav__item">
382 <a href=
"../api/form_builder/form_fields/" class=
"md-nav__link">
393 <li class=
"md-nav__item">
394 <a href=
"../api/form_builder/validation_data/" class=
"md-nav__link">
405 <li class=
"md-nav__item">
406 <a href=
"../api/form_builder/dependencies/" class=
"md-nav__link">
423 <li class=
"md-nav__item">
424 <a href=
"../api/package_installation_plugins/" class=
"md-nav__link">
425 Package Installation Plugins
435 <li class=
"md-nav__item">
436 <a href=
"../api/user_activity_points/" class=
"md-nav__link">
447 <li class=
"md-nav__item">
448 <a href=
"../api/user_notifications/" class=
"md-nav__link">
459 <li class=
"md-nav__item">
460 <a href=
"../api/sitemaps/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../code-style/" class=
"md-nav__link">
491 <li class=
"md-nav__item md-nav__item--active">
493 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
498 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
500 <span class=
"md-nav__icon md-icon"></span>
503 <a href=
"./" class=
"md-nav__link md-nav__link--active">
508 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
514 <label class=
"md-nav__title" for=
"__toc">
515 <span class=
"md-nav__icon md-icon"></span>
518 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
520 <li class=
"md-nav__item">
521 <a href=
"#introduction" class=
"md-nav__link">
527 <li class=
"md-nav__item">
528 <a href=
"#differences-to-plugins" class=
"md-nav__link">
529 Differences to Plugins
532 <nav class=
"md-nav" aria-label=
"Differences to Plugins">
533 <ul class=
"md-nav__list">
535 <li class=
"md-nav__item">
536 <a href=
"#unique-namespace" class=
"md-nav__link">
542 <li class=
"md-nav__item">
543 <a href=
"#unique-database-table-prefix" class=
"md-nav__link">
544 Unique Database Table Prefix
549 <li class=
"md-nav__item">
550 <a href=
"#separate-domain-and-path-configuration" class=
"md-nav__link">
551 Separate Domain and Path Configuration
561 <li class=
"md-nav__item">
562 <a href=
"#creating-an-app" class=
"md-nav__link">
566 <nav class=
"md-nav" aria-label=
"Creating an App">
567 <ul class=
"md-nav__list">
569 <li class=
"md-nav__item">
570 <a href=
"#packagexml" class=
"md-nav__link">
574 <nav class=
"md-nav" aria-label=
"package.xml">
575 <ul class=
"md-nav__list">
577 <li class=
"md-nav__item">
578 <a href=
"#isapplication1isapplication" class=
"md-nav__link">
579 <isapplication
>1</isapplication
>
584 <li class=
"md-nav__item">
585 <a href=
"#applicationdirectoryexampleapplicationdirectory" class=
"md-nav__link">
586 <applicationdirectory
>example
</applicationdirectory
>
596 <li class=
"md-nav__item">
597 <a href=
"#minimum-required-files" class=
"md-nav__link">
598 Minimum Required Files
620 <li class=
"md-nav__item">
621 <a href=
"../gdpr/" class=
"md-nav__link">
642 <li class=
"md-nav__item md-nav__item--nested">
645 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
647 <label class=
"md-nav__link" for=
"__nav_3">
648 Languages, Templates & CSS
649 <span class=
"md-nav__icon md-icon"></span>
651 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
652 <label class=
"md-nav__title" for=
"__nav_3">
653 <span class=
"md-nav__icon md-icon"></span>
654 Languages, Templates & CSS
656 <ul class=
"md-nav__list" data-md-scrollfix
>
662 <li class=
"md-nav__item">
663 <a href=
"../../view/languages/" class=
"md-nav__link">
674 <li class=
"md-nav__item">
675 <a href=
"../../view/templates/" class=
"md-nav__link">
686 <li class=
"md-nav__item">
687 <a href=
"../../view/css/" class=
"md-nav__link">
708 <li class=
"md-nav__item md-nav__item--nested">
711 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
713 <label class=
"md-nav__link" for=
"__nav_4">
715 <span class=
"md-nav__icon md-icon"></span>
717 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
718 <label class=
"md-nav__title" for=
"__nav_4">
719 <span class=
"md-nav__icon md-icon"></span>
722 <ul class=
"md-nav__list" data-md-scrollfix
>
728 <li class=
"md-nav__item">
729 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
741 <li class=
"md-nav__item md-nav__item--nested">
744 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
746 <label class=
"md-nav__link" for=
"__nav_4_2">
748 <span class=
"md-nav__icon md-icon"></span>
750 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
751 <label class=
"md-nav__title" for=
"__nav_4_2">
752 <span class=
"md-nav__icon md-icon"></span>
755 <ul class=
"md-nav__list" data-md-scrollfix
>
761 <li class=
"md-nav__item">
762 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
773 <li class=
"md-nav__item">
774 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
785 <li class=
"md-nav__item">
786 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
797 <li class=
"md-nav__item">
798 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
809 <li class=
"md-nav__item">
810 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
821 <li class=
"md-nav__item">
822 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
833 <li class=
"md-nav__item">
834 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
845 <li class=
"md-nav__item">
846 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
847 Browser and Screen Sizes
857 <li class=
"md-nav__item">
858 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
875 <li class=
"md-nav__item">
876 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
887 <li class=
"md-nav__item">
888 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
899 <li class=
"md-nav__item">
900 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
921 <li class=
"md-nav__item md-nav__item--nested">
924 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
926 <label class=
"md-nav__link" for=
"__nav_5">
928 <span class=
"md-nav__icon md-icon"></span>
930 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
931 <label class=
"md-nav__title" for=
"__nav_5">
932 <span class=
"md-nav__icon md-icon"></span>
935 <ul class=
"md-nav__list" data-md-scrollfix
>
941 <li class=
"md-nav__item">
942 <a href=
"../../package/package-xml/" class=
"md-nav__link">
954 <li class=
"md-nav__item md-nav__item--nested">
957 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
959 <label class=
"md-nav__link" for=
"__nav_5_2">
961 <span class=
"md-nav__icon md-icon"></span>
963 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
964 <label class=
"md-nav__title" for=
"__nav_5_2">
965 <span class=
"md-nav__icon md-icon"></span>
968 <ul class=
"md-nav__list" data-md-scrollfix
>
974 <li class=
"md-nav__item">
975 <a href=
"../../package/pip/" class=
"md-nav__link">
986 <li class=
"md-nav__item">
987 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
998 <li class=
"md-nav__item">
999 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1010 <li class=
"md-nav__item">
1011 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1022 <li class=
"md-nav__item">
1023 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1034 <li class=
"md-nav__item">
1035 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1046 <li class=
"md-nav__item">
1047 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1058 <li class=
"md-nav__item">
1059 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1070 <li class=
"md-nav__item">
1071 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1082 <li class=
"md-nav__item">
1083 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1094 <li class=
"md-nav__item">
1095 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1106 <li class=
"md-nav__item">
1107 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1118 <li class=
"md-nav__item">
1119 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1130 <li class=
"md-nav__item">
1131 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1142 <li class=
"md-nav__item">
1143 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1154 <li class=
"md-nav__item">
1155 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1166 <li class=
"md-nav__item">
1167 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1178 <li class=
"md-nav__item">
1179 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1180 objectTypeDefinition
1190 <li class=
"md-nav__item">
1191 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1202 <li class=
"md-nav__item">
1203 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1214 <li class=
"md-nav__item">
1215 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1226 <li class=
"md-nav__item">
1227 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1238 <li class=
"md-nav__item">
1239 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1250 <li class=
"md-nav__item">
1251 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1262 <li class=
"md-nav__item">
1263 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1274 <li class=
"md-nav__item">
1275 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1286 <li class=
"md-nav__item">
1287 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1298 <li class=
"md-nav__item">
1299 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1310 <li class=
"md-nav__item">
1311 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1322 <li class=
"md-nav__item">
1323 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1324 userNotificationEvent
1334 <li class=
"md-nav__item">
1335 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1346 <li class=
"md-nav__item">
1347 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1364 <li class=
"md-nav__item">
1365 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1386 <li class=
"md-nav__item md-nav__item--nested">
1389 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1391 <label class=
"md-nav__link" for=
"__nav_6">
1393 <span class=
"md-nav__icon md-icon"></span>
1395 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1396 <label class=
"md-nav__title" for=
"__nav_6">
1397 <span class=
"md-nav__icon md-icon"></span>
1400 <ul class=
"md-nav__list" data-md-scrollfix
>
1407 <li class=
"md-nav__item md-nav__item--nested">
1410 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1412 <label class=
"md-nav__link" for=
"__nav_6_1">
1413 Migrating from WSC
5.3
1414 <span class=
"md-nav__icon md-icon"></span>
1416 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1417 <label class=
"md-nav__title" for=
"__nav_6_1">
1418 <span class=
"md-nav__icon md-icon"></span>
1419 Migrating from WSC
5.3
1421 <ul class=
"md-nav__list" data-md-scrollfix
>
1427 <li class=
"md-nav__item">
1428 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1439 <li class=
"md-nav__item">
1440 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1441 Session Handling and Authentication
1451 <li class=
"md-nav__item">
1452 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1463 <li class=
"md-nav__item">
1464 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1475 <li class=
"md-nav__item">
1476 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1477 Third Party Libraries
1494 <li class=
"md-nav__item md-nav__item--nested">
1497 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1499 <label class=
"md-nav__link" for=
"__nav_6_2">
1500 Migrating from WSC
5.2
1501 <span class=
"md-nav__icon md-icon"></span>
1503 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1504 <label class=
"md-nav__title" for=
"__nav_6_2">
1505 <span class=
"md-nav__icon md-icon"></span>
1506 Migrating from WSC
5.2
1508 <ul class=
"md-nav__list" data-md-scrollfix
>
1514 <li class=
"md-nav__item">
1515 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1526 <li class=
"md-nav__item">
1527 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1528 Templates and Languages
1538 <li class=
"md-nav__item">
1539 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1540 Third Party Libraries
1557 <li class=
"md-nav__item md-nav__item--nested">
1560 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1562 <label class=
"md-nav__link" for=
"__nav_6_3">
1563 Migrating from WSC
3.1
1564 <span class=
"md-nav__icon md-icon"></span>
1566 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1567 <label class=
"md-nav__title" for=
"__nav_6_3">
1568 <span class=
"md-nav__icon md-icon"></span>
1569 Migrating from WSC
3.1
1571 <ul class=
"md-nav__list" data-md-scrollfix
>
1577 <li class=
"md-nav__item">
1578 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1596 <li class=
"md-nav__item md-nav__item--nested">
1599 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1601 <label class=
"md-nav__link" for=
"__nav_6_4">
1602 Migrating from WSC
3.0
1603 <span class=
"md-nav__icon md-icon"></span>
1605 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1606 <label class=
"md-nav__title" for=
"__nav_6_4">
1607 <span class=
"md-nav__icon md-icon"></span>
1608 Migrating from WSC
3.0
1610 <ul class=
"md-nav__list" data-md-scrollfix
>
1616 <li class=
"md-nav__item">
1617 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1628 <li class=
"md-nav__item">
1629 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1640 <li class=
"md-nav__item">
1641 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1652 <li class=
"md-nav__item">
1653 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1664 <li class=
"md-nav__item">
1665 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1683 <li class=
"md-nav__item md-nav__item--nested">
1686 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1688 <label class=
"md-nav__link" for=
"__nav_6_5">
1689 Migrating from WCF
2.1
1690 <span class=
"md-nav__icon md-icon"></span>
1692 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1693 <label class=
"md-nav__title" for=
"__nav_6_5">
1694 <span class=
"md-nav__icon md-icon"></span>
1695 Migrating from WCF
2.1
1697 <ul class=
"md-nav__list" data-md-scrollfix
>
1703 <li class=
"md-nav__item">
1704 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1715 <li class=
"md-nav__item">
1716 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1727 <li class=
"md-nav__item">
1728 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1739 <li class=
"md-nav__item">
1740 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1767 <li class=
"md-nav__item md-nav__item--nested">
1770 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1772 <label class=
"md-nav__link" for=
"__nav_7">
1774 <span class=
"md-nav__icon md-icon"></span>
1776 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1777 <label class=
"md-nav__title" for=
"__nav_7">
1778 <span class=
"md-nav__icon md-icon"></span>
1781 <ul class=
"md-nav__list" data-md-scrollfix
>
1788 <li class=
"md-nav__item md-nav__item--nested">
1791 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1793 <label class=
"md-nav__link" for=
"__nav_7_1">
1795 <span class=
"md-nav__icon md-icon"></span>
1797 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1798 <label class=
"md-nav__title" for=
"__nav_7_1">
1799 <span class=
"md-nav__icon md-icon"></span>
1802 <ul class=
"md-nav__list" data-md-scrollfix
>
1808 <li class=
"md-nav__item">
1809 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1820 <li class=
"md-nav__item">
1821 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1832 <li class=
"md-nav__item">
1833 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1844 <li class=
"md-nav__item">
1845 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1872 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1873 <div class=
"md-sidebar__scrollwrap">
1874 <div class=
"md-sidebar__inner">
1876 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1882 <label class=
"md-nav__title" for=
"__toc">
1883 <span class=
"md-nav__icon md-icon"></span>
1886 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1888 <li class=
"md-nav__item">
1889 <a href=
"#introduction" class=
"md-nav__link">
1895 <li class=
"md-nav__item">
1896 <a href=
"#differences-to-plugins" class=
"md-nav__link">
1897 Differences to Plugins
1900 <nav class=
"md-nav" aria-label=
"Differences to Plugins">
1901 <ul class=
"md-nav__list">
1903 <li class=
"md-nav__item">
1904 <a href=
"#unique-namespace" class=
"md-nav__link">
1910 <li class=
"md-nav__item">
1911 <a href=
"#unique-database-table-prefix" class=
"md-nav__link">
1912 Unique Database Table Prefix
1917 <li class=
"md-nav__item">
1918 <a href=
"#separate-domain-and-path-configuration" class=
"md-nav__link">
1919 Separate Domain and Path Configuration
1929 <li class=
"md-nav__item">
1930 <a href=
"#creating-an-app" class=
"md-nav__link">
1934 <nav class=
"md-nav" aria-label=
"Creating an App">
1935 <ul class=
"md-nav__list">
1937 <li class=
"md-nav__item">
1938 <a href=
"#packagexml" class=
"md-nav__link">
1942 <nav class=
"md-nav" aria-label=
"package.xml">
1943 <ul class=
"md-nav__list">
1945 <li class=
"md-nav__item">
1946 <a href=
"#isapplication1isapplication" class=
"md-nav__link">
1947 <isapplication
>1</isapplication
>
1952 <li class=
"md-nav__item">
1953 <a href=
"#applicationdirectoryexampleapplicationdirectory" class=
"md-nav__link">
1954 <applicationdirectory
>example
</applicationdirectory
>
1964 <li class=
"md-nav__item">
1965 <a href=
"#minimum-required-files" class=
"md-nav__link">
1966 Minimum Required Files
1984 <div class=
"md-content" data-md-component=
"content">
1985 <article class=
"md-content__inner md-typeset">
1989 <h1 id=
"apps-for-woltlab-suite">Apps for WoltLab Suite
<a class=
"headerlink" href=
"#apps-for-woltlab-suite" title=
"Permanent link">#
</a></h1>
1990 <h2 id=
"introduction">Introduction
<a class=
"headerlink" href=
"#introduction" title=
"Permanent link">#
</a></h2>
1991 <p>Apps are among the most powerful components in WoltLab Suite. Unlike plugins
1992 that extend an existing functionality and pages, apps have their own frontend
1993 with a dedicated namespace, database table prefixes and template locations.
</p>
1994 <p>However, apps are meant to be a logical (and to some extent physical) separation
1995 from other parts of the framework, including other installed apps. They offer
1996 an additional layer of isolation and enable you to re-use class and template
1997 names that are already in use by the Core itself.
</p>
1998 <p>If you've come here, thinking about the question if your next package should be
1999 an app instead of a regular plugin, the result is almost always:
<em>No.
</em></p>
2000 <h2 id=
"differences-to-plugins">Differences to Plugins
<a class=
"headerlink" href=
"#differences-to-plugins" title=
"Permanent link">#
</a></h2>
2001 <p>Apps do offer a couple of unique features that are not available to plugins and
2002 there are valid reasons to use one instead of a plugin, but they also increase
2003 both the code and system complexity. There is a performance penalty for each
2004 installed app, regardless if it is actively used in a request or not, simplying
2005 being there forces the Core to include it in many places, for example, class
2006 resolution or even simple tasks such as constructing a link.
</p>
2007 <h3 id=
"unique-namespace">Unique Namespace
<a class=
"headerlink" href=
"#unique-namespace" title=
"Permanent link">#
</a></h3>
2008 <p>Each app has its own unique namespace that is entirely separated from the Core
2009 and any other installed apps. The namespace is derived from the last part of the
2010 package identifier, for example,
<code>com.example.foo
</code> will yield the namespace
<code>foo
</code>.
</p>
2011 <p>The namespace is always relative to the installation directory of the app, it
2012 doesn't matter if the app is installed on
<code>example.com/foo/
</code> or in
<code>example.com/bar/
</code>,
2013 the namespace will always resolve to the right directory.
</p>
2014 <p>This app namespace is also used for ACP templates, frontend templates and files:
</p>
2015 <div class=
"highlight"><pre><span></span><code><span class=
"c"><!-- somewhere in the package.xml --
></span>
2016 <span class=
"nt"><instructions
</span> <span class=
"na">type=
</span><span class=
"s">"file
"</span> <span class=
"na">application=
</span><span class=
"s">"foo
"</span> <span class=
"nt">/
></span>
2018 <h3 id=
"unique-database-table-prefix">Unique Database Table Prefix
<a class=
"headerlink" href=
"#unique-database-table-prefix" title=
"Permanent link">#
</a></h3>
2019 <p>All database tables make use of a generic prefix that is derived from one of the
2020 installed apps, including
<code>wcf
</code> which resolves to the Core itself. Following the
2021 aforementioned example, the new prefix
<code>fooN_
</code> will be automatically registered
2022 and recognized in any generated statement.
</p>
2023 <p>Any
<code>DatabaseObject
</code> that uses the app's namespace is automatically assumed to
2024 use the app's database prefix. For instance,
<code>foo\data\bar\Bar
</code> is implicitly
2025 mapped to the database table
<code>fooN_bar
</code>.
</p>
2026 <p>The app prefix is recognized in SQL-PIPs and statements that reference one of
2027 its database tables are automatically rewritten to use the Core's instance number.
</p>
2028 <h3 id=
"separate-domain-and-path-configuration">Separate Domain and Path Configuration
<a class=
"headerlink" href=
"#separate-domain-and-path-configuration" title=
"Permanent link">#
</a></h3>
2029 <p>Any controller that is provided by a plugin is served from the configured domain
2030 and path of the corresponding app, such as plugins for the Core are always
2031 served from the Core's directory. Apps are different and use their own domain
2032 and/or path to present their content, additionally, this allows the app to re-use
2033 a controller name that is already provided by the Core or any other app itself.
</p>
2034 <h2 id=
"creating-an-app">Creating an App
<a class=
"headerlink" href=
"#creating-an-app" title=
"Permanent link">#
</a></h2>
2035 <div class=
"admonition danger">
2036 <p class=
"admonition-title">This is a non-reversible operation! Once a package has been installed, its type cannot be changed without uninstalling and reinstalling the entire package, an app will always be an app and vice versa.
</p>
2038 <h3 id=
"packagexml"><code>package.xml
</code><a class=
"headerlink" href=
"#packagexml" title=
"Permanent link">#
</a></h3>
2039 <p>The
<code>package.xml
</code> supports two additional elements in the
<code><packageinformation
></code>
2040 block that are unique to applications.
</p>
2041 <h4 id=
"isapplication1isapplication"><code><isapplication
>1</isapplication
></code><a class=
"headerlink" href=
"#isapplication1isapplication" title=
"Permanent link">#
</a></h4>
2042 <p>This element is responsible to flag a package as an app.
</p>
2043 <h4 id=
"applicationdirectoryexampleapplicationdirectory"><code><applicationdirectory
>example
</applicationdirectory
></code><a class=
"headerlink" href=
"#applicationdirectoryexampleapplicationdirectory" title=
"Permanent link">#
</a></h4>
2044 <p>Sets the suggested name of the application directory when installing it, the
2045 path result in
<code><path-to-the-core
>/example/
</code>. If you leave this element out,
2046 the app identifier (
<code>com.example.foo -
> foo
</code>) will be used instead.
</p>
2047 <h3 id=
"minimum-required-files">Minimum Required Files
<a class=
"headerlink" href=
"#minimum-required-files" title=
"Permanent link">#
</a></h3>
2048 <p>An example project with the
<a href=
"https://github.com/WoltLab/woltlab.github.io/tree/master/_includes/tutorial/basic-app/">source code can be found on GitHub
</a>,
2049 it includes everything that is required for a basic app.
</p>
2063 <footer class=
"md-footer">
2065 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2067 <a href=
"../code-style/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2068 <div class=
"md-footer__button md-icon">
2069 <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>
2071 <div class=
"md-footer__title">
2072 <div class=
"md-ellipsis">
2073 <span class=
"md-footer__direction">
2082 <a href=
"../gdpr/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2083 <div class=
"md-footer__title">
2084 <div class=
"md-ellipsis">
2085 <span class=
"md-footer__direction">
2091 <div class=
"md-footer__button md-icon">
2092 <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>
2098 <div class=
"md-footer-meta md-typeset">
2099 <div class=
"md-footer-meta__inner md-grid">
2100 <div class=
"md-footer-copyright">
2102 <div class=
"md-footer-copyright__highlight">
2103 Copyright ©
2020 WoltLab GmbH
2107 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2112 <div class=
"md-footer-copyright">
2113 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2114 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2121 <div class=
"md-dialog" data-md-component=
"dialog">
2122 <div class=
"md-dialog__inner md-typeset"></div>
2124 <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>
2127 <script src=
"../../assets/javascripts/bundle.5cf3e710.min.js"></script>