3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>Apps - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.ef6f36e2.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <script>function __prefix(e){return new URL(
"../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
57 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
58 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
59 <label class=
"md-overlay" for=
"__drawer"></label>
60 <div data-md-component=
"skip">
63 <a href=
"#apps-for-woltlab-suite" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
84 <img src=
"../../assets/logo.png" alt=
"logo">
87 <label class=
"md-header__button md-icon" for=
"__drawer">
88 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 <div class=
"md-header__title" data-md-component=
"header-title">
91 <div class=
"md-header__ellipsis">
92 <div class=
"md-header__topic">
93 <span class=
"md-ellipsis">
94 WoltLab Suite Documentation
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
109 <label class=
"md-header__button md-icon" for=
"__search">
110 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
113 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
114 <label class=
"md-search__overlay" for=
"__search"></label>
115 <div class=
"md-search__inner" role=
"search">
116 <form class=
"md-search__form" name=
"search">
117 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
118 <label class=
"md-search__icon md-icon" for=
"__search">
119 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
120 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
122 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
123 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
126 <div class=
"md-search__output">
127 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
128 <div class=
"md-search-result" data-md-component=
"search-result">
129 <div class=
"md-search-result__meta">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
142 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
143 <div class=
"md-source__icon md-icon">
145 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
166 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
167 <div class=
"md-sidebar__scrollwrap">
168 <div class=
"md-sidebar__inner">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
184 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
185 <div class=
"md-source__icon md-icon">
187 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../getting-started/" class=
"md-nav__link">
222 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
225 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" checked
>
227 <label class=
"md-nav__link" for=
"__nav_2">
229 <span class=
"md-nav__icon md-icon"></span>
231 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
232 <label class=
"md-nav__title" for=
"__nav_2">
233 <span class=
"md-nav__icon md-icon"></span>
236 <ul class=
"md-nav__list" data-md-scrollfix
>
242 <li class=
"md-nav__item">
243 <a href=
"../pages/" class=
"md-nav__link">
254 <li class=
"md-nav__item">
255 <a href=
"../database-objects/" class=
"md-nav__link">
266 <li class=
"md-nav__item">
267 <a href=
"../database-access/" class=
"md-nav__link">
278 <li class=
"md-nav__item">
279 <a href=
"../exceptions/" class=
"md-nav__link">
291 <li class=
"md-nav__item md-nav__item--nested">
294 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
296 <label class=
"md-nav__link" for=
"__nav_2_5">
298 <span class=
"md-nav__icon md-icon"></span>
300 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
301 <label class=
"md-nav__title" for=
"__nav_2_5">
302 <span class=
"md-nav__icon md-icon"></span>
305 <ul class=
"md-nav__list" data-md-scrollfix
>
312 <li class=
"md-nav__item md-nav__item--nested">
315 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
317 <label class=
"md-nav__link" for=
"__nav_2_5_1">
319 <span class=
"md-nav__icon md-icon"></span>
321 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
322 <label class=
"md-nav__title" for=
"__nav_2_5_1">
323 <span class=
"md-nav__icon md-icon"></span>
326 <ul class=
"md-nav__list" data-md-scrollfix
>
332 <li class=
"md-nav__item">
333 <a href=
"../api/caches/" class=
"md-nav__link">
344 <li class=
"md-nav__item">
345 <a href=
"../api/caches_persistent-caches/" class=
"md-nav__link">
356 <li class=
"md-nav__item">
357 <a href=
"../api/caches_runtime-caches/" class=
"md-nav__link">
374 <li class=
"md-nav__item">
375 <a href=
"../api/comments/" class=
"md-nav__link">
386 <li class=
"md-nav__item">
387 <a href=
"../api/cronjobs/" class=
"md-nav__link">
398 <li class=
"md-nav__item">
399 <a href=
"../api/events/" class=
"md-nav__link">
411 <li class=
"md-nav__item md-nav__item--nested">
414 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
416 <label class=
"md-nav__link" for=
"__nav_2_5_5">
418 <span class=
"md-nav__icon md-icon"></span>
420 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
421 <label class=
"md-nav__title" for=
"__nav_2_5_5">
422 <span class=
"md-nav__icon md-icon"></span>
425 <ul class=
"md-nav__list" data-md-scrollfix
>
431 <li class=
"md-nav__item">
432 <a href=
"../api/form_builder/overview/" class=
"md-nav__link">
443 <li class=
"md-nav__item">
444 <a href=
"../api/form_builder/structure/" class=
"md-nav__link">
455 <li class=
"md-nav__item">
456 <a href=
"../api/form_builder/form_fields/" class=
"md-nav__link">
467 <li class=
"md-nav__item">
468 <a href=
"../api/form_builder/validation_data/" class=
"md-nav__link">
479 <li class=
"md-nav__item">
480 <a href=
"../api/form_builder/dependencies/" class=
"md-nav__link">
497 <li class=
"md-nav__item">
498 <a href=
"../api/package_installation_plugins/" class=
"md-nav__link">
499 Package Installation Plugins
509 <li class=
"md-nav__item">
510 <a href=
"../api/user_activity_points/" class=
"md-nav__link">
521 <li class=
"md-nav__item">
522 <a href=
"../api/user_notifications/" class=
"md-nav__link">
533 <li class=
"md-nav__item">
534 <a href=
"../api/sitemaps/" class=
"md-nav__link">
551 <li class=
"md-nav__item">
552 <a href=
"../code-style/" class=
"md-nav__link">
565 <li class=
"md-nav__item md-nav__item--active">
567 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
572 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
574 <span class=
"md-nav__icon md-icon"></span>
577 <a href=
"./" class=
"md-nav__link md-nav__link--active">
582 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
588 <label class=
"md-nav__title" for=
"__toc">
589 <span class=
"md-nav__icon md-icon"></span>
592 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
594 <li class=
"md-nav__item">
595 <a href=
"#introduction" class=
"md-nav__link">
601 <li class=
"md-nav__item">
602 <a href=
"#differences-to-plugins" class=
"md-nav__link">
603 Differences to Plugins
606 <nav class=
"md-nav" aria-label=
"Differences to Plugins">
607 <ul class=
"md-nav__list">
609 <li class=
"md-nav__item">
610 <a href=
"#unique-namespace" class=
"md-nav__link">
616 <li class=
"md-nav__item">
617 <a href=
"#unique-database-table-prefix" class=
"md-nav__link">
618 Unique Database Table Prefix
623 <li class=
"md-nav__item">
624 <a href=
"#separate-domain-and-path-configuration" class=
"md-nav__link">
625 Separate Domain and Path Configuration
635 <li class=
"md-nav__item">
636 <a href=
"#creating-an-app" class=
"md-nav__link">
640 <nav class=
"md-nav" aria-label=
"Creating an App">
641 <ul class=
"md-nav__list">
643 <li class=
"md-nav__item">
644 <a href=
"#packagexml" class=
"md-nav__link">
648 <nav class=
"md-nav" aria-label=
"package.xml">
649 <ul class=
"md-nav__list">
651 <li class=
"md-nav__item">
652 <a href=
"#isapplication1isapplication" class=
"md-nav__link">
653 <isapplication
>1</isapplication
>
658 <li class=
"md-nav__item">
659 <a href=
"#applicationdirectoryexampleapplicationdirectory" class=
"md-nav__link">
660 <applicationdirectory
>example
</applicationdirectory
>
670 <li class=
"md-nav__item">
671 <a href=
"#minimum-required-files" class=
"md-nav__link">
672 Minimum Required Files
694 <li class=
"md-nav__item">
695 <a href=
"../gdpr/" class=
"md-nav__link">
716 <li class=
"md-nav__item md-nav__item--nested">
719 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
721 <label class=
"md-nav__link" for=
"__nav_3">
722 Languages, Templates & CSS
723 <span class=
"md-nav__icon md-icon"></span>
725 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
726 <label class=
"md-nav__title" for=
"__nav_3">
727 <span class=
"md-nav__icon md-icon"></span>
728 Languages, Templates & CSS
730 <ul class=
"md-nav__list" data-md-scrollfix
>
736 <li class=
"md-nav__item">
737 <a href=
"../../view/languages/" class=
"md-nav__link">
748 <li class=
"md-nav__item">
749 <a href=
"../../view/templates/" class=
"md-nav__link">
760 <li class=
"md-nav__item">
761 <a href=
"../../view/template-plugins/" class=
"md-nav__link">
772 <li class=
"md-nav__item">
773 <a href=
"../../view/css/" class=
"md-nav__link">
794 <li class=
"md-nav__item md-nav__item--nested">
797 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
799 <label class=
"md-nav__link" for=
"__nav_4">
800 TypeScript and JavaScript API
801 <span class=
"md-nav__icon md-icon"></span>
803 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
804 <label class=
"md-nav__title" for=
"__nav_4">
805 <span class=
"md-nav__icon md-icon"></span>
806 TypeScript and JavaScript API
808 <ul class=
"md-nav__list" data-md-scrollfix
>
814 <li class=
"md-nav__item">
815 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
826 <li class=
"md-nav__item">
827 <a href=
"../../javascript/typescript/" class=
"md-nav__link">
839 <li class=
"md-nav__item md-nav__item--nested">
842 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
844 <label class=
"md-nav__link" for=
"__nav_4_3">
846 <span class=
"md-nav__icon md-icon"></span>
848 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
849 <label class=
"md-nav__title" for=
"__nav_4_3">
850 <span class=
"md-nav__icon md-icon"></span>
853 <ul class=
"md-nav__list" data-md-scrollfix
>
859 <li class=
"md-nav__item">
860 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
871 <li class=
"md-nav__item">
872 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
883 <li class=
"md-nav__item">
884 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
895 <li class=
"md-nav__item">
896 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
907 <li class=
"md-nav__item">
908 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
919 <li class=
"md-nav__item">
920 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
931 <li class=
"md-nav__item">
932 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
943 <li class=
"md-nav__item">
944 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
945 Browser and Screen Sizes
955 <li class=
"md-nav__item">
956 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
973 <li class=
"md-nav__item">
974 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
985 <li class=
"md-nav__item">
986 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
997 <li class=
"md-nav__item">
998 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
1019 <li class=
"md-nav__item md-nav__item--nested">
1022 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1024 <label class=
"md-nav__link" for=
"__nav_5">
1026 <span class=
"md-nav__icon md-icon"></span>
1028 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1029 <label class=
"md-nav__title" for=
"__nav_5">
1030 <span class=
"md-nav__icon md-icon"></span>
1033 <ul class=
"md-nav__list" data-md-scrollfix
>
1039 <li class=
"md-nav__item">
1040 <a href=
"../../package/package-xml/" class=
"md-nav__link">
1052 <li class=
"md-nav__item md-nav__item--nested">
1055 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1057 <label class=
"md-nav__link" for=
"__nav_5_2">
1059 <span class=
"md-nav__icon md-icon"></span>
1061 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1062 <label class=
"md-nav__title" for=
"__nav_5_2">
1063 <span class=
"md-nav__icon md-icon"></span>
1066 <ul class=
"md-nav__list" data-md-scrollfix
>
1072 <li class=
"md-nav__item">
1073 <a href=
"../../package/pip/" class=
"md-nav__link">
1084 <li class=
"md-nav__item">
1085 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1096 <li class=
"md-nav__item">
1097 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1108 <li class=
"md-nav__item">
1109 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1120 <li class=
"md-nav__item">
1121 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1132 <li class=
"md-nav__item">
1133 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1144 <li class=
"md-nav__item">
1145 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1156 <li class=
"md-nav__item">
1157 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1168 <li class=
"md-nav__item">
1169 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1180 <li class=
"md-nav__item">
1181 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1192 <li class=
"md-nav__item">
1193 <a href=
"../../package/pip/database/" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1216 <li class=
"md-nav__item">
1217 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1228 <li class=
"md-nav__item">
1229 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1240 <li class=
"md-nav__item">
1241 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1252 <li class=
"md-nav__item">
1253 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1264 <li class=
"md-nav__item">
1265 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1276 <li class=
"md-nav__item">
1277 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1288 <li class=
"md-nav__item">
1289 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1290 objectTypeDefinition
1300 <li class=
"md-nav__item">
1301 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1312 <li class=
"md-nav__item">
1313 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1324 <li class=
"md-nav__item">
1325 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1336 <li class=
"md-nav__item">
1337 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1348 <li class=
"md-nav__item">
1349 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1360 <li class=
"md-nav__item">
1361 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1372 <li class=
"md-nav__item">
1373 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1384 <li class=
"md-nav__item">
1385 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1396 <li class=
"md-nav__item">
1397 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1408 <li class=
"md-nav__item">
1409 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1420 <li class=
"md-nav__item">
1421 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1432 <li class=
"md-nav__item">
1433 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1434 userNotificationEvent
1444 <li class=
"md-nav__item">
1445 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1456 <li class=
"md-nav__item">
1457 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1474 <li class=
"md-nav__item">
1475 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1496 <li class=
"md-nav__item md-nav__item--nested">
1499 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1501 <label class=
"md-nav__link" for=
"__nav_6">
1503 <span class=
"md-nav__icon md-icon"></span>
1505 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1506 <label class=
"md-nav__title" for=
"__nav_6">
1507 <span class=
"md-nav__icon md-icon"></span>
1510 <ul class=
"md-nav__list" data-md-scrollfix
>
1517 <li class=
"md-nav__item md-nav__item--nested">
1520 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1522 <label class=
"md-nav__link" for=
"__nav_6_1">
1523 Migrating from WSC
5.3
1524 <span class=
"md-nav__icon md-icon"></span>
1526 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1527 <label class=
"md-nav__title" for=
"__nav_6_1">
1528 <span class=
"md-nav__icon md-icon"></span>
1529 Migrating from WSC
5.3
1531 <ul class=
"md-nav__list" data-md-scrollfix
>
1537 <li class=
"md-nav__item">
1538 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1549 <li class=
"md-nav__item">
1550 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1551 Session Handling and Authentication
1561 <li class=
"md-nav__item">
1562 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1563 TypeScript and JavaScript
1573 <li class=
"md-nav__item">
1574 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1585 <li class=
"md-nav__item">
1586 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1587 Third Party Libraries
1604 <li class=
"md-nav__item md-nav__item--nested">
1607 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1609 <label class=
"md-nav__link" for=
"__nav_6_2">
1610 Migrating from WSC
5.2
1611 <span class=
"md-nav__icon md-icon"></span>
1613 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1614 <label class=
"md-nav__title" for=
"__nav_6_2">
1615 <span class=
"md-nav__icon md-icon"></span>
1616 Migrating from WSC
5.2
1618 <ul class=
"md-nav__list" data-md-scrollfix
>
1624 <li class=
"md-nav__item">
1625 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1636 <li class=
"md-nav__item">
1637 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1638 Templates and Languages
1648 <li class=
"md-nav__item">
1649 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1650 Third Party Libraries
1667 <li class=
"md-nav__item md-nav__item--nested">
1670 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1672 <label class=
"md-nav__link" for=
"__nav_6_3">
1673 Migrating from WSC
3.1
1674 <span class=
"md-nav__icon md-icon"></span>
1676 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1677 <label class=
"md-nav__title" for=
"__nav_6_3">
1678 <span class=
"md-nav__icon md-icon"></span>
1679 Migrating from WSC
3.1
1681 <ul class=
"md-nav__list" data-md-scrollfix
>
1687 <li class=
"md-nav__item">
1688 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1706 <li class=
"md-nav__item md-nav__item--nested">
1709 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1711 <label class=
"md-nav__link" for=
"__nav_6_4">
1712 Migrating from WSC
3.0
1713 <span class=
"md-nav__icon md-icon"></span>
1715 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1716 <label class=
"md-nav__title" for=
"__nav_6_4">
1717 <span class=
"md-nav__icon md-icon"></span>
1718 Migrating from WSC
3.0
1720 <ul class=
"md-nav__list" data-md-scrollfix
>
1726 <li class=
"md-nav__item">
1727 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1738 <li class=
"md-nav__item">
1739 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1750 <li class=
"md-nav__item">
1751 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1762 <li class=
"md-nav__item">
1763 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1774 <li class=
"md-nav__item">
1775 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1793 <li class=
"md-nav__item md-nav__item--nested">
1796 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1798 <label class=
"md-nav__link" for=
"__nav_6_5">
1799 Migrating from WCF
2.1
1800 <span class=
"md-nav__icon md-icon"></span>
1802 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1803 <label class=
"md-nav__title" for=
"__nav_6_5">
1804 <span class=
"md-nav__icon md-icon"></span>
1805 Migrating from WCF
2.1
1807 <ul class=
"md-nav__list" data-md-scrollfix
>
1813 <li class=
"md-nav__item">
1814 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1825 <li class=
"md-nav__item">
1826 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1837 <li class=
"md-nav__item">
1838 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1849 <li class=
"md-nav__item">
1850 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1877 <li class=
"md-nav__item md-nav__item--nested">
1880 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1882 <label class=
"md-nav__link" for=
"__nav_7">
1884 <span class=
"md-nav__icon md-icon"></span>
1886 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1887 <label class=
"md-nav__title" for=
"__nav_7">
1888 <span class=
"md-nav__icon md-icon"></span>
1891 <ul class=
"md-nav__list" data-md-scrollfix
>
1898 <li class=
"md-nav__item md-nav__item--nested">
1901 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1903 <label class=
"md-nav__link" for=
"__nav_7_1">
1905 <span class=
"md-nav__icon md-icon"></span>
1907 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1908 <label class=
"md-nav__title" for=
"__nav_7_1">
1909 <span class=
"md-nav__icon md-icon"></span>
1912 <ul class=
"md-nav__list" data-md-scrollfix
>
1918 <li class=
"md-nav__item">
1919 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1930 <li class=
"md-nav__item">
1931 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1942 <li class=
"md-nav__item">
1943 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1954 <li class=
"md-nav__item">
1955 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1966 <li class=
"md-nav__item">
1967 <a href=
"../../tutorial/series/part_4/" class=
"md-nav__link">
1994 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1995 <div class=
"md-sidebar__scrollwrap">
1996 <div class=
"md-sidebar__inner">
1998 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2004 <label class=
"md-nav__title" for=
"__toc">
2005 <span class=
"md-nav__icon md-icon"></span>
2008 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2010 <li class=
"md-nav__item">
2011 <a href=
"#introduction" class=
"md-nav__link">
2017 <li class=
"md-nav__item">
2018 <a href=
"#differences-to-plugins" class=
"md-nav__link">
2019 Differences to Plugins
2022 <nav class=
"md-nav" aria-label=
"Differences to Plugins">
2023 <ul class=
"md-nav__list">
2025 <li class=
"md-nav__item">
2026 <a href=
"#unique-namespace" class=
"md-nav__link">
2032 <li class=
"md-nav__item">
2033 <a href=
"#unique-database-table-prefix" class=
"md-nav__link">
2034 Unique Database Table Prefix
2039 <li class=
"md-nav__item">
2040 <a href=
"#separate-domain-and-path-configuration" class=
"md-nav__link">
2041 Separate Domain and Path Configuration
2051 <li class=
"md-nav__item">
2052 <a href=
"#creating-an-app" class=
"md-nav__link">
2056 <nav class=
"md-nav" aria-label=
"Creating an App">
2057 <ul class=
"md-nav__list">
2059 <li class=
"md-nav__item">
2060 <a href=
"#packagexml" class=
"md-nav__link">
2064 <nav class=
"md-nav" aria-label=
"package.xml">
2065 <ul class=
"md-nav__list">
2067 <li class=
"md-nav__item">
2068 <a href=
"#isapplication1isapplication" class=
"md-nav__link">
2069 <isapplication
>1</isapplication
>
2074 <li class=
"md-nav__item">
2075 <a href=
"#applicationdirectoryexampleapplicationdirectory" class=
"md-nav__link">
2076 <applicationdirectory
>example
</applicationdirectory
>
2086 <li class=
"md-nav__item">
2087 <a href=
"#minimum-required-files" class=
"md-nav__link">
2088 Minimum Required Files
2106 <div class=
"md-content" data-md-component=
"content">
2107 <article class=
"md-content__inner md-typeset">
2110 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/apps.md" title=
"Edit this page" class=
"md-content__button md-icon">
2111 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
2115 <h1 id=
"apps-for-woltlab-suite">Apps for WoltLab Suite
<a class=
"headerlink" href=
"#apps-for-woltlab-suite" title=
"Permanent link">#
</a></h1>
2116 <h2 id=
"introduction">Introduction
<a class=
"headerlink" href=
"#introduction" title=
"Permanent link">#
</a></h2>
2117 <p>Apps are among the most powerful components in WoltLab Suite. Unlike plugins
2118 that extend an existing functionality and pages, apps have their own frontend
2119 with a dedicated namespace, database table prefixes and template locations.
</p>
2120 <p>However, apps are meant to be a logical (and to some extent physical) separation
2121 from other parts of the framework, including other installed apps. They offer
2122 an additional layer of isolation and enable you to re-use class and template
2123 names that are already in use by the Core itself.
</p>
2124 <p>If you've come here, thinking about the question if your next package should be
2125 an app instead of a regular plugin, the result is almost always:
<em>No.
</em></p>
2126 <h2 id=
"differences-to-plugins">Differences to Plugins
<a class=
"headerlink" href=
"#differences-to-plugins" title=
"Permanent link">#
</a></h2>
2127 <p>Apps do offer a couple of unique features that are not available to plugins and
2128 there are valid reasons to use one instead of a plugin, but they also increase
2129 both the code and system complexity. There is a performance penalty for each
2130 installed app, regardless if it is actively used in a request or not, simplying
2131 being there forces the Core to include it in many places, for example, class
2132 resolution or even simple tasks such as constructing a link.
</p>
2133 <h3 id=
"unique-namespace">Unique Namespace
<a class=
"headerlink" href=
"#unique-namespace" title=
"Permanent link">#
</a></h3>
2134 <p>Each app has its own unique namespace that is entirely separated from the Core
2135 and any other installed apps. The namespace is derived from the last part of the
2136 package identifier, for example,
<code>com.example.foo
</code> will yield the namespace
<code>foo
</code>.
</p>
2137 <p>The namespace is always relative to the installation directory of the app, it
2138 doesn't matter if the app is installed on
<code>example.com/foo/
</code> or in
<code>example.com/bar/
</code>,
2139 the namespace will always resolve to the right directory.
</p>
2140 <p>This app namespace is also used for ACP templates, frontend templates and files:
</p>
2141 <div class=
"highlight"><pre><span></span><code><span class=
"c"><!-- somewhere in the package.xml --
></span>
2142 <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>
2144 <h3 id=
"unique-database-table-prefix">Unique Database Table Prefix
<a class=
"headerlink" href=
"#unique-database-table-prefix" title=
"Permanent link">#
</a></h3>
2145 <p>All database tables make use of a generic prefix that is derived from one of the
2146 installed apps, including
<code>wcf
</code> which resolves to the Core itself. Following the
2147 aforementioned example, the new prefix
<code>fooN_
</code> will be automatically registered
2148 and recognized in any generated statement.
</p>
2149 <p>Any
<code>DatabaseObject
</code> that uses the app's namespace is automatically assumed to
2150 use the app's database prefix. For instance,
<code>foo\data\bar\Bar
</code> is implicitly
2151 mapped to the database table
<code>fooN_bar
</code>.
</p>
2152 <p>The app prefix is recognized in SQL-PIPs and statements that reference one of
2153 its database tables are automatically rewritten to use the Core's instance number.
</p>
2154 <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>
2155 <p>Any controller that is provided by a plugin is served from the configured domain
2156 and path of the corresponding app, such as plugins for the Core are always
2157 served from the Core's directory. Apps are different and use their own domain
2158 and/or path to present their content, additionally, this allows the app to re-use
2159 a controller name that is already provided by the Core or any other app itself.
</p>
2160 <h2 id=
"creating-an-app">Creating an App
<a class=
"headerlink" href=
"#creating-an-app" title=
"Permanent link">#
</a></h2>
2161 <div class=
"admonition danger">
2162 <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>
2164 <h3 id=
"packagexml"><code>package.xml
</code><a class=
"headerlink" href=
"#packagexml" title=
"Permanent link">#
</a></h3>
2165 <p>The
<code>package.xml
</code> supports two additional elements in the
<code><packageinformation
></code>
2166 block that are unique to applications.
</p>
2167 <h4 id=
"isapplication1isapplication"><code><isapplication
>1</isapplication
></code><a class=
"headerlink" href=
"#isapplication1isapplication" title=
"Permanent link">#
</a></h4>
2168 <p>This element is responsible to flag a package as an app.
</p>
2169 <h4 id=
"applicationdirectoryexampleapplicationdirectory"><code><applicationdirectory
>example
</applicationdirectory
></code><a class=
"headerlink" href=
"#applicationdirectoryexampleapplicationdirectory" title=
"Permanent link">#
</a></h4>
2170 <p>Sets the suggested name of the application directory when installing it, the
2171 path result in
<code><path-to-the-core
>/example/
</code>. If you leave this element out,
2172 the app identifier (
<code>com.example.foo -
> foo
</code>) will be used instead.
</p>
2173 <h3 id=
"minimum-required-files">Minimum Required Files
<a class=
"headerlink" href=
"#minimum-required-files" title=
"Permanent link">#
</a></h3>
2174 <p>An example project with the
<a href=
"https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/basic-app/">source code can be found on GitHub
</a>,
2175 it includes everything that is required for a basic app.
</p>
2181 <div class=
"md-source-date">
2184 Last update:
2021-
04-
07
2203 <footer class=
"md-footer">
2205 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2207 <a href=
"../code-style/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2208 <div class=
"md-footer__button md-icon">
2209 <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>
2211 <div class=
"md-footer__title">
2212 <div class=
"md-ellipsis">
2213 <span class=
"md-footer__direction">
2222 <a href=
"../gdpr/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2223 <div class=
"md-footer__title">
2224 <div class=
"md-ellipsis">
2225 <span class=
"md-footer__direction">
2231 <div class=
"md-footer__button md-icon">
2232 <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>
2238 <div class=
"md-footer-meta md-typeset">
2239 <div class=
"md-footer-meta__inner md-grid">
2240 <div class=
"md-footer-copyright">
2242 <div class=
"md-footer-copyright__highlight">
2243 Copyright ©
2020 WoltLab GmbH
2247 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2252 <div class=
"md-footer-copyright">
2253 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2254 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2261 <div class=
"md-dialog" data-md-component=
"dialog">
2262 <div class=
"md-dialog__inner md-typeset"></div>
2264 <script id=
"__config" type=
"application/json">{
"base":
"../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../assets/javascripts/workers/search.fe42c31b.min.js",
"version": {
"provider":
"mike"}}
</script>
2267 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>