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>userMenu - 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=
"#user-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">
111 <label class=
"md-header__button md-icon" for=
"__search">
112 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
115 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
116 <label class=
"md-search__overlay" for=
"__search"></label>
117 <div class=
"md-search__inner" role=
"search">
118 <form class=
"md-search__form" name=
"search">
119 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
120 <label class=
"md-search__icon md-icon" for=
"__search">
121 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
122 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
124 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
125 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
128 <div class=
"md-search__output">
129 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
130 <div class=
"md-search-result" data-md-component=
"search-result">
131 <div class=
"md-search-result__meta">
134 <ol class=
"md-search-result__list"></ol>
142 <div class=
"md-header__source">
144 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
145 <div class=
"md-source__icon md-icon">
147 <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>
149 <div class=
"md-source__repository">
158 <div class=
"md-container" data-md-component=
"container">
163 <main class=
"md-main" data-md-component=
"main">
164 <div class=
"md-main__inner md-grid">
168 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
169 <div class=
"md-sidebar__scrollwrap">
170 <div class=
"md-sidebar__inner">
176 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
177 <label class=
"md-nav__title" for=
"__drawer">
178 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
180 <img src=
"../../../assets/logo.png" alt=
"logo">
183 WoltLab Suite Documentation
186 <div class=
"md-nav__source">
188 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
189 <div class=
"md-source__icon md-icon">
191 <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>
193 <div class=
"md-source__repository">
199 <ul class=
"md-nav__list" data-md-scrollfix
>
208 <li class=
"md-nav__item">
209 <a href=
"../../../getting-started/" class=
"md-nav__link">
224 <li class=
"md-nav__item md-nav__item--nested">
227 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
229 <label class=
"md-nav__link" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
233 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
234 <label class=
"md-nav__title" for=
"__nav_2">
235 <span class=
"md-nav__icon md-icon"></span>
238 <ul class=
"md-nav__list" data-md-scrollfix
>
244 <li class=
"md-nav__item">
245 <a href=
"../../../php/pages/" class=
"md-nav__link">
256 <li class=
"md-nav__item">
257 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
268 <li class=
"md-nav__item">
269 <a href=
"../../../php/database-access/" class=
"md-nav__link">
280 <li class=
"md-nav__item">
281 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
293 <li class=
"md-nav__item md-nav__item--nested">
296 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
298 <label class=
"md-nav__link" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
302 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
303 <label class=
"md-nav__title" for=
"__nav_2_5">
304 <span class=
"md-nav__icon md-icon"></span>
307 <ul class=
"md-nav__list" data-md-scrollfix
>
313 <li class=
"md-nav__item">
314 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
325 <li class=
"md-nav__item">
326 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
337 <li class=
"md-nav__item">
338 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
349 <li class=
"md-nav__item">
350 <a href=
"../../../php/api/events/" class=
"md-nav__link">
362 <li class=
"md-nav__item md-nav__item--nested">
365 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
367 <label class=
"md-nav__link" for=
"__nav_2_5_5">
369 <span class=
"md-nav__icon md-icon"></span>
371 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
372 <label class=
"md-nav__title" for=
"__nav_2_5_5">
373 <span class=
"md-nav__icon md-icon"></span>
376 <ul class=
"md-nav__list" data-md-scrollfix
>
382 <li class=
"md-nav__item">
383 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
394 <li class=
"md-nav__item">
395 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
406 <li class=
"md-nav__item">
407 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
418 <li class=
"md-nav__item">
419 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
430 <li class=
"md-nav__item">
431 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
448 <li class=
"md-nav__item">
449 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
450 Package Installation Plugins
460 <li class=
"md-nav__item">
461 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
472 <li class=
"md-nav__item">
473 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
484 <li class=
"md-nav__item">
485 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
502 <li class=
"md-nav__item">
503 <a href=
"../../../php/code-style/" class=
"md-nav__link">
514 <li class=
"md-nav__item">
515 <a href=
"../../../php/apps/" class=
"md-nav__link">
526 <li class=
"md-nav__item">
527 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
548 <li class=
"md-nav__item md-nav__item--nested">
551 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
553 <label class=
"md-nav__link" for=
"__nav_3">
554 Languages, Templates & CSS
555 <span class=
"md-nav__icon md-icon"></span>
557 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
558 <label class=
"md-nav__title" for=
"__nav_3">
559 <span class=
"md-nav__icon md-icon"></span>
560 Languages, Templates & CSS
562 <ul class=
"md-nav__list" data-md-scrollfix
>
568 <li class=
"md-nav__item">
569 <a href=
"../../../view/languages/" class=
"md-nav__link">
580 <li class=
"md-nav__item">
581 <a href=
"../../../view/templates/" class=
"md-nav__link">
592 <li class=
"md-nav__item">
593 <a href=
"../../../view/css/" class=
"md-nav__link">
614 <li class=
"md-nav__item md-nav__item--nested">
617 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
619 <label class=
"md-nav__link" for=
"__nav_4">
621 <span class=
"md-nav__icon md-icon"></span>
623 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
624 <label class=
"md-nav__title" for=
"__nav_4">
625 <span class=
"md-nav__icon md-icon"></span>
628 <ul class=
"md-nav__list" data-md-scrollfix
>
634 <li class=
"md-nav__item">
635 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
647 <li class=
"md-nav__item md-nav__item--nested">
650 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
652 <label class=
"md-nav__link" for=
"__nav_4_2">
654 <span class=
"md-nav__icon md-icon"></span>
656 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
657 <label class=
"md-nav__title" for=
"__nav_4_2">
658 <span class=
"md-nav__icon md-icon"></span>
661 <ul class=
"md-nav__list" data-md-scrollfix
>
667 <li class=
"md-nav__item">
668 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
679 <li class=
"md-nav__item">
680 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
691 <li class=
"md-nav__item">
692 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
703 <li class=
"md-nav__item">
704 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
715 <li class=
"md-nav__item">
716 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
727 <li class=
"md-nav__item">
728 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
739 <li class=
"md-nav__item">
740 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
751 <li class=
"md-nav__item">
752 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
753 Browser and Screen Sizes
763 <li class=
"md-nav__item">
764 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
781 <li class=
"md-nav__item">
782 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
793 <li class=
"md-nav__item">
794 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
805 <li class=
"md-nav__item">
806 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
829 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
832 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
834 <label class=
"md-nav__link" for=
"__nav_5">
836 <span class=
"md-nav__icon md-icon"></span>
838 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
839 <label class=
"md-nav__title" for=
"__nav_5">
840 <span class=
"md-nav__icon md-icon"></span>
843 <ul class=
"md-nav__list" data-md-scrollfix
>
849 <li class=
"md-nav__item">
850 <a href=
"../../package-xml/" class=
"md-nav__link">
864 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
867 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
869 <label class=
"md-nav__link" for=
"__nav_5_2">
871 <span class=
"md-nav__icon md-icon"></span>
873 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
874 <label class=
"md-nav__title" for=
"__nav_5_2">
875 <span class=
"md-nav__icon md-icon"></span>
878 <ul class=
"md-nav__list" data-md-scrollfix
>
884 <li class=
"md-nav__item">
885 <a href=
"../" class=
"md-nav__link">
896 <li class=
"md-nav__item">
897 <a href=
"../acl-option/" class=
"md-nav__link">
908 <li class=
"md-nav__item">
909 <a href=
"../acp-menu/" class=
"md-nav__link">
920 <li class=
"md-nav__item">
921 <a href=
"../acp-search-provider/" class=
"md-nav__link">
932 <li class=
"md-nav__item">
933 <a href=
"../acp-template/" class=
"md-nav__link">
944 <li class=
"md-nav__item">
945 <a href=
"../bbcode/" class=
"md-nav__link">
956 <li class=
"md-nav__item">
957 <a href=
"../box/" class=
"md-nav__link">
968 <li class=
"md-nav__item">
969 <a href=
"../clipboard-action/" class=
"md-nav__link">
980 <li class=
"md-nav__item">
981 <a href=
"../core-object/" class=
"md-nav__link">
992 <li class=
"md-nav__item">
993 <a href=
"../cronjob/" class=
"md-nav__link">
1004 <li class=
"md-nav__item">
1005 <a href=
"../event-listener/" class=
"md-nav__link">
1016 <li class=
"md-nav__item">
1017 <a href=
"../file/" class=
"md-nav__link">
1028 <li class=
"md-nav__item">
1029 <a href=
"../language/" class=
"md-nav__link">
1040 <li class=
"md-nav__item">
1041 <a href=
"../media-provider/" class=
"md-nav__link">
1052 <li class=
"md-nav__item">
1053 <a href=
"../menu/" class=
"md-nav__link">
1064 <li class=
"md-nav__item">
1065 <a href=
"../menu-item/" class=
"md-nav__link">
1076 <li class=
"md-nav__item">
1077 <a href=
"../object-type/" class=
"md-nav__link">
1088 <li class=
"md-nav__item">
1089 <a href=
"../object-type-definition/" class=
"md-nav__link">
1090 objectTypeDefinition
1100 <li class=
"md-nav__item">
1101 <a href=
"../option/" class=
"md-nav__link">
1112 <li class=
"md-nav__item">
1113 <a href=
"../page/" class=
"md-nav__link">
1124 <li class=
"md-nav__item">
1125 <a href=
"../pip/" class=
"md-nav__link">
1136 <li class=
"md-nav__item">
1137 <a href=
"../script/" class=
"md-nav__link">
1148 <li class=
"md-nav__item">
1149 <a href=
"../smiley/" class=
"md-nav__link">
1160 <li class=
"md-nav__item">
1161 <a href=
"../sql/" class=
"md-nav__link">
1172 <li class=
"md-nav__item">
1173 <a href=
"../style/" class=
"md-nav__link">
1184 <li class=
"md-nav__item">
1185 <a href=
"../template/" class=
"md-nav__link">
1196 <li class=
"md-nav__item">
1197 <a href=
"../template-listener/" class=
"md-nav__link">
1208 <li class=
"md-nav__item">
1209 <a href=
"../user-group-option/" class=
"md-nav__link">
1222 <li class=
"md-nav__item md-nav__item--active">
1224 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1229 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1231 <span class=
"md-nav__icon md-icon"></span>
1234 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1239 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1245 <label class=
"md-nav__title" for=
"__toc">
1246 <span class=
"md-nav__icon md-icon"></span>
1249 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1251 <li class=
"md-nav__item">
1252 <a href=
"#components" class=
"md-nav__link">
1256 <nav class=
"md-nav" aria-label=
"Components">
1257 <ul class=
"md-nav__list">
1259 <li class=
"md-nav__item">
1260 <a href=
"#parent" class=
"md-nav__link">
1266 <li class=
"md-nav__item">
1267 <a href=
"#showorder" class=
"md-nav__link">
1273 <li class=
"md-nav__item">
1274 <a href=
"#controller" class=
"md-nav__link">
1280 <li class=
"md-nav__item">
1281 <a href=
"#link" class=
"md-nav__link">
1287 <li class=
"md-nav__item">
1288 <a href=
"#iconclassname" class=
"md-nav__link">
1289 <iconclassname
>
1294 <li class=
"md-nav__item">
1295 <a href=
"#options" class=
"md-nav__link">
1301 <li class=
"md-nav__item">
1302 <a href=
"#permissions" class=
"md-nav__link">
1308 <li class=
"md-nav__item">
1309 <a href=
"#classname" class=
"md-nav__link">
1320 <li class=
"md-nav__item">
1321 <a href=
"#example" class=
"md-nav__link">
1339 <li class=
"md-nav__item">
1340 <a href=
"../user-notification-event/" class=
"md-nav__link">
1341 userNotificationEvent
1351 <li class=
"md-nav__item">
1352 <a href=
"../user-option/" class=
"md-nav__link">
1363 <li class=
"md-nav__item">
1364 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1381 <li class=
"md-nav__item">
1382 <a href=
"../../database-php-api/" class=
"md-nav__link">
1403 <li class=
"md-nav__item md-nav__item--nested">
1406 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1408 <label class=
"md-nav__link" for=
"__nav_6">
1410 <span class=
"md-nav__icon md-icon"></span>
1412 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1413 <label class=
"md-nav__title" for=
"__nav_6">
1414 <span class=
"md-nav__icon md-icon"></span>
1417 <ul class=
"md-nav__list" data-md-scrollfix
>
1424 <li class=
"md-nav__item md-nav__item--nested">
1427 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1429 <label class=
"md-nav__link" for=
"__nav_6_1">
1430 Migrating from WSC
5.3
1431 <span class=
"md-nav__icon md-icon"></span>
1433 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1434 <label class=
"md-nav__title" for=
"__nav_6_1">
1435 <span class=
"md-nav__icon md-icon"></span>
1436 Migrating from WSC
5.3
1438 <ul class=
"md-nav__list" data-md-scrollfix
>
1444 <li class=
"md-nav__item">
1445 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1456 <li class=
"md-nav__item">
1457 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1458 Session Handling and Authentication
1468 <li class=
"md-nav__item">
1469 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1480 <li class=
"md-nav__item">
1481 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1492 <li class=
"md-nav__item">
1493 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1494 Third Party Libraries
1511 <li class=
"md-nav__item md-nav__item--nested">
1514 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1516 <label class=
"md-nav__link" for=
"__nav_6_2">
1517 Migrating from WSC
5.2
1518 <span class=
"md-nav__icon md-icon"></span>
1520 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1521 <label class=
"md-nav__title" for=
"__nav_6_2">
1522 <span class=
"md-nav__icon md-icon"></span>
1523 Migrating from WSC
5.2
1525 <ul class=
"md-nav__list" data-md-scrollfix
>
1531 <li class=
"md-nav__item">
1532 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1543 <li class=
"md-nav__item">
1544 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1545 Templates and Languages
1555 <li class=
"md-nav__item">
1556 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1557 Third Party Libraries
1574 <li class=
"md-nav__item md-nav__item--nested">
1577 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1579 <label class=
"md-nav__link" for=
"__nav_6_3">
1580 Migrating from WSC
3.1
1581 <span class=
"md-nav__icon md-icon"></span>
1583 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1584 <label class=
"md-nav__title" for=
"__nav_6_3">
1585 <span class=
"md-nav__icon md-icon"></span>
1586 Migrating from WSC
3.1
1588 <ul class=
"md-nav__list" data-md-scrollfix
>
1594 <li class=
"md-nav__item">
1595 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1613 <li class=
"md-nav__item md-nav__item--nested">
1616 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1618 <label class=
"md-nav__link" for=
"__nav_6_4">
1619 Migrating from WSC
3.0
1620 <span class=
"md-nav__icon md-icon"></span>
1622 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1623 <label class=
"md-nav__title" for=
"__nav_6_4">
1624 <span class=
"md-nav__icon md-icon"></span>
1625 Migrating from WSC
3.0
1627 <ul class=
"md-nav__list" data-md-scrollfix
>
1633 <li class=
"md-nav__item">
1634 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1645 <li class=
"md-nav__item">
1646 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1657 <li class=
"md-nav__item">
1658 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1669 <li class=
"md-nav__item">
1670 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1681 <li class=
"md-nav__item">
1682 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1700 <li class=
"md-nav__item md-nav__item--nested">
1703 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1705 <label class=
"md-nav__link" for=
"__nav_6_5">
1706 Migrating from WCF
2.1
1707 <span class=
"md-nav__icon md-icon"></span>
1709 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1710 <label class=
"md-nav__title" for=
"__nav_6_5">
1711 <span class=
"md-nav__icon md-icon"></span>
1712 Migrating from WCF
2.1
1714 <ul class=
"md-nav__list" data-md-scrollfix
>
1720 <li class=
"md-nav__item">
1721 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1732 <li class=
"md-nav__item">
1733 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1744 <li class=
"md-nav__item">
1745 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1756 <li class=
"md-nav__item">
1757 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1784 <li class=
"md-nav__item md-nav__item--nested">
1787 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1789 <label class=
"md-nav__link" for=
"__nav_7">
1791 <span class=
"md-nav__icon md-icon"></span>
1793 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1794 <label class=
"md-nav__title" for=
"__nav_7">
1795 <span class=
"md-nav__icon md-icon"></span>
1798 <ul class=
"md-nav__list" data-md-scrollfix
>
1805 <li class=
"md-nav__item md-nav__item--nested">
1808 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1810 <label class=
"md-nav__link" for=
"__nav_7_1">
1812 <span class=
"md-nav__icon md-icon"></span>
1814 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1815 <label class=
"md-nav__title" for=
"__nav_7_1">
1816 <span class=
"md-nav__icon md-icon"></span>
1819 <ul class=
"md-nav__list" data-md-scrollfix
>
1825 <li class=
"md-nav__item">
1826 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1837 <li class=
"md-nav__item">
1838 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1849 <li class=
"md-nav__item">
1850 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1861 <li class=
"md-nav__item">
1862 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1889 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1890 <div class=
"md-sidebar__scrollwrap">
1891 <div class=
"md-sidebar__inner">
1893 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1899 <label class=
"md-nav__title" for=
"__toc">
1900 <span class=
"md-nav__icon md-icon"></span>
1903 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1905 <li class=
"md-nav__item">
1906 <a href=
"#components" class=
"md-nav__link">
1910 <nav class=
"md-nav" aria-label=
"Components">
1911 <ul class=
"md-nav__list">
1913 <li class=
"md-nav__item">
1914 <a href=
"#parent" class=
"md-nav__link">
1920 <li class=
"md-nav__item">
1921 <a href=
"#showorder" class=
"md-nav__link">
1927 <li class=
"md-nav__item">
1928 <a href=
"#controller" class=
"md-nav__link">
1934 <li class=
"md-nav__item">
1935 <a href=
"#link" class=
"md-nav__link">
1941 <li class=
"md-nav__item">
1942 <a href=
"#iconclassname" class=
"md-nav__link">
1943 <iconclassname
>
1948 <li class=
"md-nav__item">
1949 <a href=
"#options" class=
"md-nav__link">
1955 <li class=
"md-nav__item">
1956 <a href=
"#permissions" class=
"md-nav__link">
1962 <li class=
"md-nav__item">
1963 <a href=
"#classname" class=
"md-nav__link">
1974 <li class=
"md-nav__item">
1975 <a href=
"#example" class=
"md-nav__link">
1989 <div class=
"md-content" data-md-component=
"content">
1990 <article class=
"md-content__inner md-typeset">
1993 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/user-menu.md" title=
"Edit this page" class=
"md-content__button md-icon">
1994 <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>
1998 <h1 id=
"user-menu-package-installation-plugin">User Menu Package Installation Plugin
<a class=
"headerlink" href=
"#user-menu-package-installation-plugin" title=
"Permanent link">#
</a></h1>
1999 <p>Registers new user menu items.
</p>
2000 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
2001 <p>Each item is described as an
<code><usermenuitem
></code> element with the mandatory attribute
<code>name
</code>.
</p>
2002 <h3 id=
"parent"><code><parent
></code><a class=
"headerlink" href=
"#parent" title=
"Permanent link">#
</a></h3>
2003 <p><span class=
"label label-info">Optional
</span></p>
2004 <p>The item’s parent item.
</p>
2005 <h3 id=
"showorder"><code><showorder
></code><a class=
"headerlink" href=
"#showorder" title=
"Permanent link">#
</a></h3>
2006 <p><span class=
"label label-info">Optional
</span></p>
2007 <p>Specifies the order of this item within the parent item.
</p>
2008 <h3 id=
"controller"><code><controller
></code><a class=
"headerlink" href=
"#controller" title=
"Permanent link">#
</a></h3>
2009 <p>The fully qualified class name of the target controller.
2010 If not specified this item serves as a category.
</p>
2011 <h3 id=
"link"><code><link
></code><a class=
"headerlink" href=
"#link" title=
"Permanent link">#
</a></h3>
2012 <p>Additional components if
<code><controller
></code> is set,
2013 the full external link otherwise.
</p>
2014 <h3 id=
"iconclassname"><code><iconclassname
></code><a class=
"headerlink" href=
"#iconclassname" title=
"Permanent link">#
</a></h3>
2015 <div class=
"admonition info">
2016 <p class=
"admonition-title">Use an icon only for top-level items.
</p>
2018 <p>Name of the Font Awesome icon class.
</p>
2019 <h3 id=
"options"><code><options
></code><a class=
"headerlink" href=
"#options" title=
"Permanent link">#
</a></h3>
2020 <p><span class=
"label label-info">Optional
</span></p>
2021 <p>The options element can contain a comma-separated list of options of which at least one needs to be enabled for the menu item to be shown.
</p>
2022 <h3 id=
"permissions"><code><permissions
></code><a class=
"headerlink" href=
"#permissions" title=
"Permanent link">#
</a></h3>
2023 <p><span class=
"label label-info">Optional
</span></p>
2024 <p>The permissions element can contain a comma-separated list of permissions of which the active user needs to have at least one for the menu item to be shown.
</p>
2025 <h3 id=
"classname"><code><classname
></code><a class=
"headerlink" href=
"#classname" title=
"Permanent link">#
</a></h3>
2026 <p>The name of the class providing the user menu item’s behaviour,
2027 the class has to implement the
<code>wcf\system\menu\user\IUserMenuItemProvider
</code> interface.
</p>
2028 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
2029 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
2030 <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/userMenu.xsd
"</span><span class=
"nt">></span>
2031 <span class=
"nt"><import
></span>
2032 <span class=
"nt"><usermenuitem
</span> <span class=
"na">name=
</span><span class=
"s">"wcf.user.menu.foo
"</span><span class=
"nt">></span>
2033 <span class=
"nt"><iconclassname
></span>fa-home
<span class=
"nt"></iconclassname
></span>
2034 <span class=
"nt"></usermenuitem
></span>
2036 <span class=
"nt"><usermenuitem
</span> <span class=
"na">name=
</span><span class=
"s">"wcf.user.menu.foo.bar
"</span><span class=
"nt">></span>
2037 <span class=
"nt"><controller
></span>wcf\page\FooBarListPage
<span class=
"nt"></controller
></span>
2038 <span class=
"nt"><parent
></span>wcf.user.menu.foo
<span class=
"nt"></parent
></span>
2039 <span class=
"nt"><permissions
></span>user.foo.canBar
<span class=
"nt"></permissions
></span>
2040 <span class=
"nt"><classname
></span>wcf\system\menu\user\FooBarMenuItemProvider
<span class=
"nt"></classname
></span>
2041 <span class=
"nt"></usermenuitem
></span>
2043 <span class=
"nt"><usermenuitem
</span> <span class=
"na">name=
</span><span class=
"s">"wcf.user.menu.foo.baz
"</span><span class=
"nt">></span>
2044 <span class=
"nt"><controller
></span>wcf\page\FooBazListPage
<span class=
"nt"></controller
></span>
2045 <span class=
"nt"><parent
></span>wcf.user.menu.foo
<span class=
"nt"></parent
></span>
2046 <span class=
"nt"><permissions
></span>user.foo.canBaz
<span class=
"nt"></permissions
></span>
2047 <span class=
"nt"><options
></span>module_foo_bar
<span class=
"nt"></options
></span>
2048 <span class=
"nt"></usermenuitem
></span>
2049 <span class=
"nt"></import
></span>
2050 <span class=
"nt"></data
></span>
2057 <div class=
"md-source-date">
2060 Last update:
2021-
01-
08
2078 <footer class=
"md-footer">
2080 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2082 <a href=
"../user-group-option/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2083 <div class=
"md-footer__button md-icon">
2084 <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>
2086 <div class=
"md-footer__title">
2087 <div class=
"md-ellipsis">
2088 <span class=
"md-footer__direction">
2097 <a href=
"../user-notification-event/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2098 <div class=
"md-footer__title">
2099 <div class=
"md-ellipsis">
2100 <span class=
"md-footer__direction">
2103 userNotificationEvent
2106 <div class=
"md-footer__button md-icon">
2107 <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>
2113 <div class=
"md-footer-meta md-typeset">
2114 <div class=
"md-footer-meta__inner md-grid">
2115 <div class=
"md-footer-copyright">
2117 <div class=
"md-footer-copyright__highlight">
2118 Copyright ©
2020 WoltLab GmbH
2122 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2127 <div class=
"md-footer-copyright">
2128 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2129 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2136 <div class=
"md-dialog" data-md-component=
"dialog">
2137 <div class=
"md-dialog__inner md-typeset"></div>
2139 <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>
2142 <script src=
"../../../assets/javascripts/bundle.5cf3e710.min.js"></script>