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>menu - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.77f3fd56.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.7fa14f5b.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
56 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
57 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
58 <label class=
"md-overlay" for=
"__drawer"></label>
59 <div data-md-component=
"skip">
62 <a href=
"#menu-package-installation-plugin" class=
"md-skip">
67 <div data-md-component=
"announce">
69 <aside class=
"md-announce">
70 <div class=
"md-announce__inner md-grid md-typeset">
72 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
81 <header class=
"md-header" data-md-component=
"header">
82 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
83 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation">
85 <img src=
"../../../assets/logo.png" alt=
"logo">
88 <label class=
"md-header__button md-icon" for=
"__drawer">
89 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
91 <div class=
"md-header__title" data-md-component=
"header-title">
92 <div class=
"md-header__ellipsis">
93 <div class=
"md-header__topic">
94 <span class=
"md-ellipsis">
95 WoltLab Suite Documentation
98 <div class=
"md-header__topic" data-md-component=
"header-topic">
99 <span class=
"md-ellipsis">
107 <div class=
"md-header__options">
112 <div class=
"md-header__source">
114 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
115 <div class=
"md-source__icon md-icon">
117 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 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>
119 <div class=
"md-source__repository">
128 <div class=
"md-container" data-md-component=
"container">
133 <main class=
"md-main" data-md-component=
"main">
134 <div class=
"md-main__inner md-grid">
138 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
139 <div class=
"md-sidebar__scrollwrap">
140 <div class=
"md-sidebar__inner">
146 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
147 <label class=
"md-nav__title" for=
"__drawer">
148 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
150 <img src=
"../../../assets/logo.png" alt=
"logo">
153 WoltLab Suite Documentation
156 <div class=
"md-nav__source">
158 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
159 <div class=
"md-source__icon md-icon">
161 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05L244 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>
163 <div class=
"md-source__repository">
169 <ul class=
"md-nav__list" data-md-scrollfix
>
178 <li class=
"md-nav__item">
179 <a href=
"../../../getting-started/" class=
"md-nav__link">
194 <li class=
"md-nav__item md-nav__item--nested">
197 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
199 <label class=
"md-nav__link" for=
"__nav_2">
201 <span class=
"md-nav__icon md-icon"></span>
203 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
204 <label class=
"md-nav__title" for=
"__nav_2">
205 <span class=
"md-nav__icon md-icon"></span>
208 <ul class=
"md-nav__list" data-md-scrollfix
>
214 <li class=
"md-nav__item">
215 <a href=
"../../../php/pages/" class=
"md-nav__link">
226 <li class=
"md-nav__item">
227 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
238 <li class=
"md-nav__item">
239 <a href=
"../../../php/database-access/" class=
"md-nav__link">
250 <li class=
"md-nav__item">
251 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
263 <li class=
"md-nav__item md-nav__item--nested">
266 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
268 <label class=
"md-nav__link" for=
"__nav_2_5">
270 <span class=
"md-nav__icon md-icon"></span>
272 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
273 <label class=
"md-nav__title" for=
"__nav_2_5">
274 <span class=
"md-nav__icon md-icon"></span>
277 <ul class=
"md-nav__list" data-md-scrollfix
>
283 <li class=
"md-nav__item">
284 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
295 <li class=
"md-nav__item">
296 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
307 <li class=
"md-nav__item">
308 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
319 <li class=
"md-nav__item">
320 <a href=
"../../../php/api/events/" class=
"md-nav__link">
332 <li class=
"md-nav__item md-nav__item--nested">
335 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
337 <label class=
"md-nav__link" for=
"__nav_2_5_5">
339 <span class=
"md-nav__icon md-icon"></span>
341 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
342 <label class=
"md-nav__title" for=
"__nav_2_5_5">
343 <span class=
"md-nav__icon md-icon"></span>
346 <ul class=
"md-nav__list" data-md-scrollfix
>
352 <li class=
"md-nav__item">
353 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
364 <li class=
"md-nav__item">
365 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
376 <li class=
"md-nav__item">
377 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
388 <li class=
"md-nav__item">
389 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
400 <li class=
"md-nav__item">
401 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
418 <li class=
"md-nav__item">
419 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
420 Package Installation Plugins
430 <li class=
"md-nav__item">
431 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
442 <li class=
"md-nav__item">
443 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
454 <li class=
"md-nav__item">
455 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
472 <li class=
"md-nav__item">
473 <a href=
"../../../php/code-style/" class=
"md-nav__link">
484 <li class=
"md-nav__item">
485 <a href=
"../../../php/apps/" class=
"md-nav__link">
496 <li class=
"md-nav__item">
497 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
518 <li class=
"md-nav__item md-nav__item--nested">
521 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
523 <label class=
"md-nav__link" for=
"__nav_3">
524 Languages, Templates & CSS
525 <span class=
"md-nav__icon md-icon"></span>
527 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
528 <label class=
"md-nav__title" for=
"__nav_3">
529 <span class=
"md-nav__icon md-icon"></span>
530 Languages, Templates & CSS
532 <ul class=
"md-nav__list" data-md-scrollfix
>
538 <li class=
"md-nav__item">
539 <a href=
"../../../view/languages/" class=
"md-nav__link">
550 <li class=
"md-nav__item">
551 <a href=
"../../../view/templates/" class=
"md-nav__link">
562 <li class=
"md-nav__item">
563 <a href=
"../../../view/css/" class=
"md-nav__link">
584 <li class=
"md-nav__item md-nav__item--nested">
587 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
589 <label class=
"md-nav__link" for=
"__nav_4">
591 <span class=
"md-nav__icon md-icon"></span>
593 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
594 <label class=
"md-nav__title" for=
"__nav_4">
595 <span class=
"md-nav__icon md-icon"></span>
598 <ul class=
"md-nav__list" data-md-scrollfix
>
604 <li class=
"md-nav__item">
605 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
617 <li class=
"md-nav__item md-nav__item--nested">
620 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
622 <label class=
"md-nav__link" for=
"__nav_4_2">
624 <span class=
"md-nav__icon md-icon"></span>
626 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
627 <label class=
"md-nav__title" for=
"__nav_4_2">
628 <span class=
"md-nav__icon md-icon"></span>
631 <ul class=
"md-nav__list" data-md-scrollfix
>
637 <li class=
"md-nav__item">
638 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
649 <li class=
"md-nav__item">
650 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
661 <li class=
"md-nav__item">
662 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
673 <li class=
"md-nav__item">
674 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
685 <li class=
"md-nav__item">
686 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
697 <li class=
"md-nav__item">
698 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
709 <li class=
"md-nav__item">
710 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
721 <li class=
"md-nav__item">
722 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
723 Browser and Screen Sizes
733 <li class=
"md-nav__item">
734 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
751 <li class=
"md-nav__item">
752 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
763 <li class=
"md-nav__item">
764 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
775 <li class=
"md-nav__item">
776 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
799 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
802 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
804 <label class=
"md-nav__link" for=
"__nav_5">
806 <span class=
"md-nav__icon md-icon"></span>
808 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
809 <label class=
"md-nav__title" for=
"__nav_5">
810 <span class=
"md-nav__icon md-icon"></span>
813 <ul class=
"md-nav__list" data-md-scrollfix
>
819 <li class=
"md-nav__item">
820 <a href=
"../../package-xml/" class=
"md-nav__link">
834 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
837 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
839 <label class=
"md-nav__link" for=
"__nav_5_2">
841 <span class=
"md-nav__icon md-icon"></span>
843 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
844 <label class=
"md-nav__title" for=
"__nav_5_2">
845 <span class=
"md-nav__icon md-icon"></span>
848 <ul class=
"md-nav__list" data-md-scrollfix
>
854 <li class=
"md-nav__item">
855 <a href=
"../" class=
"md-nav__link">
866 <li class=
"md-nav__item">
867 <a href=
"../acl-option/" class=
"md-nav__link">
878 <li class=
"md-nav__item">
879 <a href=
"../acp-menu/" class=
"md-nav__link">
890 <li class=
"md-nav__item">
891 <a href=
"../acp-search-provider/" class=
"md-nav__link">
902 <li class=
"md-nav__item">
903 <a href=
"../acp-template/" class=
"md-nav__link">
914 <li class=
"md-nav__item">
915 <a href=
"../bbcode/" class=
"md-nav__link">
926 <li class=
"md-nav__item">
927 <a href=
"../box/" class=
"md-nav__link">
938 <li class=
"md-nav__item">
939 <a href=
"../clipboard-action/" class=
"md-nav__link">
950 <li class=
"md-nav__item">
951 <a href=
"../core-object/" class=
"md-nav__link">
962 <li class=
"md-nav__item">
963 <a href=
"../cronjob/" class=
"md-nav__link">
974 <li class=
"md-nav__item">
975 <a href=
"../event-listener/" class=
"md-nav__link">
986 <li class=
"md-nav__item">
987 <a href=
"../file/" class=
"md-nav__link">
998 <li class=
"md-nav__item">
999 <a href=
"../language/" class=
"md-nav__link">
1010 <li class=
"md-nav__item">
1011 <a href=
"../media-provider/" class=
"md-nav__link">
1024 <li class=
"md-nav__item md-nav__item--active">
1026 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1031 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1033 <span class=
"md-nav__icon md-icon"></span>
1036 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1041 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1047 <label class=
"md-nav__title" for=
"__toc">
1048 <span class=
"md-nav__icon md-icon"></span>
1051 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1053 <li class=
"md-nav__item">
1054 <a href=
"#components" class=
"md-nav__link">
1058 <nav class=
"md-nav" aria-label=
"Components">
1059 <ul class=
"md-nav__list">
1061 <li class=
"md-nav__item">
1062 <a href=
"#title" class=
"md-nav__link">
1068 <li class=
"md-nav__item">
1069 <a href=
"#box" class=
"md-nav__link">
1080 <li class=
"md-nav__item">
1081 <a href=
"#example" class=
"md-nav__link">
1099 <li class=
"md-nav__item">
1100 <a href=
"../menu-item/" class=
"md-nav__link">
1111 <li class=
"md-nav__item">
1112 <a href=
"../object-type/" class=
"md-nav__link">
1123 <li class=
"md-nav__item">
1124 <a href=
"../object-type-definition/" class=
"md-nav__link">
1125 objectTypeDefinition
1135 <li class=
"md-nav__item">
1136 <a href=
"../option/" class=
"md-nav__link">
1147 <li class=
"md-nav__item">
1148 <a href=
"../page/" class=
"md-nav__link">
1159 <li class=
"md-nav__item">
1160 <a href=
"../pip/" class=
"md-nav__link">
1171 <li class=
"md-nav__item">
1172 <a href=
"../script/" class=
"md-nav__link">
1183 <li class=
"md-nav__item">
1184 <a href=
"../smiley/" class=
"md-nav__link">
1195 <li class=
"md-nav__item">
1196 <a href=
"../sql/" class=
"md-nav__link">
1207 <li class=
"md-nav__item">
1208 <a href=
"../style/" class=
"md-nav__link">
1219 <li class=
"md-nav__item">
1220 <a href=
"../template/" class=
"md-nav__link">
1231 <li class=
"md-nav__item">
1232 <a href=
"../template-listener/" class=
"md-nav__link">
1243 <li class=
"md-nav__item">
1244 <a href=
"../user-group-option/" class=
"md-nav__link">
1255 <li class=
"md-nav__item">
1256 <a href=
"../user-menu/" class=
"md-nav__link">
1267 <li class=
"md-nav__item">
1268 <a href=
"../user-notification-event/" class=
"md-nav__link">
1269 userNotificationEvent
1279 <li class=
"md-nav__item">
1280 <a href=
"../user-option/" class=
"md-nav__link">
1291 <li class=
"md-nav__item">
1292 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1309 <li class=
"md-nav__item">
1310 <a href=
"../../database-php-api/" class=
"md-nav__link">
1331 <li class=
"md-nav__item md-nav__item--nested">
1334 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1336 <label class=
"md-nav__link" for=
"__nav_6">
1338 <span class=
"md-nav__icon md-icon"></span>
1340 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1341 <label class=
"md-nav__title" for=
"__nav_6">
1342 <span class=
"md-nav__icon md-icon"></span>
1345 <ul class=
"md-nav__list" data-md-scrollfix
>
1352 <li class=
"md-nav__item md-nav__item--nested">
1355 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1357 <label class=
"md-nav__link" for=
"__nav_6_1">
1358 Migrating from WSC
5.3
1359 <span class=
"md-nav__icon md-icon"></span>
1361 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1362 <label class=
"md-nav__title" for=
"__nav_6_1">
1363 <span class=
"md-nav__icon md-icon"></span>
1364 Migrating from WSC
5.3
1366 <ul class=
"md-nav__list" data-md-scrollfix
>
1372 <li class=
"md-nav__item">
1373 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1384 <li class=
"md-nav__item">
1385 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1386 Session Handling and Authentication
1396 <li class=
"md-nav__item">
1397 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1408 <li class=
"md-nav__item">
1409 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1420 <li class=
"md-nav__item">
1421 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1422 Third Party Libraries
1439 <li class=
"md-nav__item md-nav__item--nested">
1442 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1444 <label class=
"md-nav__link" for=
"__nav_6_2">
1445 Migrating from WSC
5.2
1446 <span class=
"md-nav__icon md-icon"></span>
1448 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1449 <label class=
"md-nav__title" for=
"__nav_6_2">
1450 <span class=
"md-nav__icon md-icon"></span>
1451 Migrating from WSC
5.2
1453 <ul class=
"md-nav__list" data-md-scrollfix
>
1459 <li class=
"md-nav__item">
1460 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1471 <li class=
"md-nav__item">
1472 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1473 Templates and Languages
1483 <li class=
"md-nav__item">
1484 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1485 Third Party Libraries
1502 <li class=
"md-nav__item md-nav__item--nested">
1505 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1507 <label class=
"md-nav__link" for=
"__nav_6_3">
1508 Migrating from WSC
3.1
1509 <span class=
"md-nav__icon md-icon"></span>
1511 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1512 <label class=
"md-nav__title" for=
"__nav_6_3">
1513 <span class=
"md-nav__icon md-icon"></span>
1514 Migrating from WSC
3.1
1516 <ul class=
"md-nav__list" data-md-scrollfix
>
1522 <li class=
"md-nav__item">
1523 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1541 <li class=
"md-nav__item md-nav__item--nested">
1544 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1546 <label class=
"md-nav__link" for=
"__nav_6_4">
1547 Migrating from WSC
3.0
1548 <span class=
"md-nav__icon md-icon"></span>
1550 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1551 <label class=
"md-nav__title" for=
"__nav_6_4">
1552 <span class=
"md-nav__icon md-icon"></span>
1553 Migrating from WSC
3.0
1555 <ul class=
"md-nav__list" data-md-scrollfix
>
1561 <li class=
"md-nav__item">
1562 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1573 <li class=
"md-nav__item">
1574 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1585 <li class=
"md-nav__item">
1586 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1597 <li class=
"md-nav__item">
1598 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1609 <li class=
"md-nav__item">
1610 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1628 <li class=
"md-nav__item md-nav__item--nested">
1631 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1633 <label class=
"md-nav__link" for=
"__nav_6_5">
1634 Migrating from WCF
2.1
1635 <span class=
"md-nav__icon md-icon"></span>
1637 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1638 <label class=
"md-nav__title" for=
"__nav_6_5">
1639 <span class=
"md-nav__icon md-icon"></span>
1640 Migrating from WCF
2.1
1642 <ul class=
"md-nav__list" data-md-scrollfix
>
1648 <li class=
"md-nav__item">
1649 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1660 <li class=
"md-nav__item">
1661 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1672 <li class=
"md-nav__item">
1673 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1684 <li class=
"md-nav__item">
1685 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1712 <li class=
"md-nav__item md-nav__item--nested">
1715 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1717 <label class=
"md-nav__link" for=
"__nav_7">
1719 <span class=
"md-nav__icon md-icon"></span>
1721 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1722 <label class=
"md-nav__title" for=
"__nav_7">
1723 <span class=
"md-nav__icon md-icon"></span>
1726 <ul class=
"md-nav__list" data-md-scrollfix
>
1733 <li class=
"md-nav__item md-nav__item--nested">
1736 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1738 <label class=
"md-nav__link" for=
"__nav_7_1">
1740 <span class=
"md-nav__icon md-icon"></span>
1742 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1743 <label class=
"md-nav__title" for=
"__nav_7_1">
1744 <span class=
"md-nav__icon md-icon"></span>
1747 <ul class=
"md-nav__list" data-md-scrollfix
>
1753 <li class=
"md-nav__item">
1754 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1765 <li class=
"md-nav__item">
1766 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1777 <li class=
"md-nav__item">
1778 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1789 <li class=
"md-nav__item">
1790 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1817 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1818 <div class=
"md-sidebar__scrollwrap">
1819 <div class=
"md-sidebar__inner">
1821 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1827 <label class=
"md-nav__title" for=
"__toc">
1828 <span class=
"md-nav__icon md-icon"></span>
1831 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1833 <li class=
"md-nav__item">
1834 <a href=
"#components" class=
"md-nav__link">
1838 <nav class=
"md-nav" aria-label=
"Components">
1839 <ul class=
"md-nav__list">
1841 <li class=
"md-nav__item">
1842 <a href=
"#title" class=
"md-nav__link">
1848 <li class=
"md-nav__item">
1849 <a href=
"#box" class=
"md-nav__link">
1860 <li class=
"md-nav__item">
1861 <a href=
"#example" class=
"md-nav__link">
1875 <div class=
"md-content" data-md-component=
"content">
1876 <article class=
"md-content__inner md-typeset">
1879 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/menu.md" title=
"Edit this page" class=
"md-content__button md-icon">
1880 <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>
1884 <h1 id=
"menu-package-installation-plugin">Menu Package Installation Plugin
<a class=
"headerlink" href=
"#menu-package-installation-plugin" title=
"Permanent link">#
</a></h1>
1885 <p>Deploy and manage menus that can be placed anywhere on the site.
</p>
1886 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
1887 <p>Each item is described as a
<code><menu
></code> element with the mandatory attribute
<code>identifier
</code> that should follow the naming pattern
<code><packageIdentifier
>.
<MenuName
></code>, e.g.
<code>com.woltlab.wcf.MainMenu
</code>.
</p>
1888 <h3 id=
"title"><code><title
></code><a class=
"headerlink" href=
"#title" title=
"Permanent link">#
</a></h3>
1889 <div class=
"admonition info">
1890 <p class=
"admonition-title">The
<code>language
</code> attribute is required and should specify the
<a href=
"https://en.wikipedia.org/wiki/ISO_639-1">ISO-
639-
1</a> language code.
</p>
1892 <p>The internal name displayed in the admin panel only, can be fully customized by the administrator and is immutable. Only one value is accepted and will be picked based on the site's default language, but you can provide localized values by including multiple
<code><title
></code> elements.
</p>
1893 <h3 id=
"box"><code><box
></code><a class=
"headerlink" href=
"#box" title=
"Permanent link">#
</a></h3>
1894 <p>The following elements of the
<a href=
"../box/">box PIP
</a> are supported, please refer to the documentation to learn more about them:
</p>
1896 <li><code><position
></code></li>
1897 <li><code><showHeader
></code></li>
1898 <li><code><visibleEverywhere
></code></li>
1899 <li><code><visibilityExceptions
></code></li>
1900 <li><code>cssClassName
</code></li>
1902 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
1903 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
1904 <span class=
"nt"><data
</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/
2019/menu.xsd
"</span><span class=
"nt">></span>
1905 <span class=
"nt"><import
></span>
1906 <span class=
"nt"><menu
</span> <span class=
"na">identifier=
</span><span class=
"s">"com.woltlab.wcf.FooterLinks
"</span><span class=
"nt">></span>
1907 <span class=
"nt"><title
</span> <span class=
"na">language=
</span><span class=
"s">"de
"</span><span class=
"nt">></span>Footer-Links
<span class=
"nt"></title
></span>
1908 <span class=
"nt"><title
</span> <span class=
"na">language=
</span><span class=
"s">"en
"</span><span class=
"nt">></span>Footer Links
<span class=
"nt"></title
></span>
1910 <span class=
"nt"><box
></span>
1911 <span class=
"nt"><position
></span>footer
<span class=
"nt"></position
></span>
1912 <span class=
"nt"><cssClassName
></span>boxMenuLinkGroup
<span class=
"nt"></cssClassName
></span>
1913 <span class=
"nt"><showHeader
></span>0<span class=
"nt"></showHeader
></span>
1914 <span class=
"nt"><visibleEverywhere
></span>1<span class=
"nt"></visibleEverywhere
></span>
1915 <span class=
"nt"></box
></span>
1916 <span class=
"nt"></menu
></span>
1917 <span class=
"nt"></import
></span>
1919 <span class=
"nt"><delete
></span>
1920 <span class=
"nt"><menu
</span> <span class=
"na">identifier=
</span><span class=
"s">"com.woltlab.wcf.FooterLinks
"</span> <span class=
"nt">/
></span>
1921 <span class=
"nt"></delete
></span>
1922 <span class=
"nt"></data
></span>
1929 <div class=
"md-source-date">
1932 Last update:
2021-
01-
08
1950 <footer class=
"md-footer">
1952 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
1954 <a href=
"../media-provider/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
1955 <div class=
"md-footer__button md-icon">
1956 <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>
1958 <div class=
"md-footer__title">
1959 <div class=
"md-ellipsis">
1960 <span class=
"md-footer__direction">
1969 <a href=
"../menu-item/" class=
"md-footer__link md-footer__link--next" rel=
"next">
1970 <div class=
"md-footer__title">
1971 <div class=
"md-ellipsis">
1972 <span class=
"md-footer__direction">
1978 <div class=
"md-footer__button md-icon">
1979 <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>
1985 <div class=
"md-footer-meta md-typeset">
1986 <div class=
"md-footer-meta__inner md-grid">
1987 <div class=
"md-footer-copyright">
1989 <div class=
"md-footer-copyright__highlight">
1990 Copyright ©
2020 WoltLab GmbH
1994 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
1999 <div class=
"md-footer-copyright">
2000 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2001 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2008 <div class=
"md-dialog" data-md-component=
"dialog">
2009 <div class=
"md-dialog__inner md-typeset"></div>
2011 <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>
2014 <script src=
"../../../assets/javascripts/bundle.5cf3e710.min.js"></script>