Deployed 357acc5a to 6.0 with MkDocs 1.4.2 and mike 1.1.2
[GitHub/WoltLab/woltlab.github.io.git] / 6.0 / package / pip / user-menu / index.html
CommitLineData
9aa5da67
WG
1
2<!doctype html>
3<html lang="en" class="no-js">
4 <head>
5
6 <meta charset="utf-8">
7 <meta name="viewport" content="width=device-width,initial-scale=1">
8
9
10
11 <link rel="canonical" href="https://docs.woltlab.com/6.0/package/pip/user-menu/">
12
e02609d6
WG
13
14 <link rel="prev" href="../user-group-option/">
15
16
17 <link rel="next" href="../user-notification-event/">
18
9aa5da67 19 <link rel="icon" href="../../../assets/default.favicon.ico">
94fa7b1e 20 <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
9aa5da67
WG
21
22
23
24 <title>userMenu - WoltLab Suite Documentation</title>
25
26
27
94fa7b1e 28 <link rel="stylesheet" href="../../../assets/stylesheets/main.ded33207.min.css">
9aa5da67
WG
29
30
6f2e8f13 31 <link rel="stylesheet" href="../../../assets/stylesheets/palette.a0c5b2b5.min.css">
9aa5da67
WG
32
33
7f9945cf 34
9aa5da67
WG
35
36
37
38
39
40
41 <link rel="stylesheet" href="../../../stylesheets/extra.css">
42
a06fd3b1 43 <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
9aa5da67
WG
44
45
46
47
48
7f9945cf 49
9aa5da67
WG
50 </head>
51
52
53
54
55
56
57
94fa7b1e 58 <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
9aa5da67
WG
59
60
61
62 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
63 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
64 <label class="md-overlay" for="__drawer"></label>
65 <div data-md-component="skip">
66
67
68 <a href="#user-menu-package-installation-plugin" class="md-skip">
69 Skip to content
70 </a>
71
72 </div>
73 <div data-md-component="announce">
74
75 <aside class="md-banner">
76 <div class="md-banner__inner md-grid md-typeset">
77
a06fd3b1 78
9aa5da67
WG
79 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
80
81 </div>
a06fd3b1 82
9aa5da67
WG
83 </aside>
84
85 </div>
86
6f2e8f13 87 <div data-md-color-scheme="default" data-md-component="outdated" hidden>
a06fd3b1 88
9aa5da67
WG
89 </div>
90
91
92
93
781975eb
WG
94
95
96<header class="md-header md-header--shadow" data-md-component="header">
9aa5da67
WG
97 <nav class="md-header__inner md-grid" aria-label="Header">
98 <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
99
100 <img src="../../../assets/logo.png" alt="logo">
101
102 </a>
103 <label class="md-header__button md-icon" for="__drawer">
104 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
105 </label>
106 <div class="md-header__title" data-md-component="header-title">
107 <div class="md-header__ellipsis">
108 <div class="md-header__topic">
109 <span class="md-ellipsis">
110 WoltLab Suite Documentation
111 </span>
112 </div>
113 <div class="md-header__topic" data-md-component="header-topic">
114 <span class="md-ellipsis">
115
116 userMenu
117
118 </span>
119 </div>
120 </div>
121 </div>
122
94fa7b1e
WG
123
124
9aa5da67
WG
125
126
127 <label class="md-header__button md-icon" for="__search">
128 <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>
129 </label>
130 <div class="md-search" data-md-component="search" role="dialog">
131 <label class="md-search__overlay" for="__search"></label>
132 <div class="md-search__inner" role="search">
133 <form class="md-search__form" name="search">
134 <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" required>
135 <label class="md-search__icon md-icon" for="__search">
136 <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>
137 <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>
138 </label>
139 <nav class="md-search__options" aria-label="Search">
140
7f9945cf 141 <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
9aa5da67
WG
142 <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>
143 </button>
144 </nav>
145
146 </form>
147 <div class="md-search__output">
148 <div class="md-search__scrollwrap" data-md-scrollfix>
149 <div class="md-search-result" data-md-component="search-result">
150 <div class="md-search-result__meta">
151 Initializing search
152 </div>
7b2c751c 153 <ol class="md-search-result__list" role="presentation"></ol>
9aa5da67
WG
154 </div>
155 </div>
156 </div>
157 </div>
158</div>
159
160
161 <div class="md-header__source">
162 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
163 <div class="md-source__icon md-icon">
164
94fa7b1e 165 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
9aa5da67
WG
166 </div>
167 <div class="md-source__repository">
168 GitHub
169 </div>
170</a>
171 </div>
172
173 </nav>
174
175</header>
176
177 <div class="md-container" data-md-component="container">
178
179
180
181
182
183
184 <main class="md-main" data-md-component="main">
185 <div class="md-main__inner md-grid">
186
187
188
189 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
190 <div class="md-sidebar__scrollwrap">
191 <div class="md-sidebar__inner">
192
193
194
195<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
196 <label class="md-nav__title" for="__drawer">
197 <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
198
199 <img src="../../../assets/logo.png" alt="logo">
200
201 </a>
202 WoltLab Suite Documentation
203 </label>
204
205 <div class="md-nav__source">
206 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
207 <div class="md-source__icon md-icon">
208
94fa7b1e 209 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
9aa5da67
WG
210 </div>
211 <div class="md-source__repository">
212 GitHub
213 </div>
214</a>
215 </div>
216
217 <ul class="md-nav__list" data-md-scrollfix>
218
219
220
221
222
223
224
225
226 <li class="md-nav__item">
227 <a href="../../../getting-started/" class="md-nav__link">
228 Getting Started
229 </a>
230 </li>
231
232
233
234
235
236
237
238
239
240
241
242 <li class="md-nav__item md-nav__item--nested">
243
244
9aa5da67
WG
245
246
51b70eee 247 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
e02609d6 248
9aa5da67
WG
249
250
51b70eee 251 <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
9aa5da67
WG
252 PHP API
253 <span class="md-nav__icon md-icon"></span>
254 </label>
255
51b70eee 256 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
9aa5da67
WG
257 <label class="md-nav__title" for="__nav_2">
258 <span class="md-nav__icon md-icon"></span>
259 PHP API
260 </label>
261 <ul class="md-nav__list" data-md-scrollfix>
262
263
264
265
266
267
268 <li class="md-nav__item">
269 <a href="../../../php/pages/" class="md-nav__link">
270 Pages
271 </a>
272 </li>
273
274
275
276
277
278
279
280
281
282 <li class="md-nav__item">
283 <a href="../../../php/database-objects/" class="md-nav__link">
284 Database Objects
285 </a>
286 </li>
287
288
289
290
291
292
293
294
295
296 <li class="md-nav__item">
297 <a href="../../../php/database-access/" class="md-nav__link">
298 Database Access
299 </a>
300 </li>
301
302
303
304
305
306
307
308
309
310 <li class="md-nav__item">
311 <a href="../../../php/exceptions/" class="md-nav__link">
312 Exceptions
313 </a>
314 </li>
315
316
317
318
319
320
321
322
323
324
325 <li class="md-nav__item md-nav__item--nested">
326
327
9aa5da67
WG
328
329
51b70eee 330 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
e02609d6 331
9aa5da67
WG
332
333
51b70eee 334 <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
9aa5da67
WG
335 API
336 <span class="md-nav__icon md-icon"></span>
337 </label>
338
51b70eee 339 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
9aa5da67
WG
340 <label class="md-nav__title" for="__nav_2_5">
341 <span class="md-nav__icon md-icon"></span>
342 API
343 </label>
344 <ul class="md-nav__list" data-md-scrollfix>
345
346
347
348
349
350
351
352 <li class="md-nav__item md-nav__item--nested">
353
354
9aa5da67
WG
355
356
51b70eee 357 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
9aa5da67
WG
358
359
e02609d6 360
51b70eee 361 <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
9aa5da67
WG
362 Caches
363 <span class="md-nav__icon md-icon"></span>
364 </label>
365
51b70eee 366 <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
9aa5da67
WG
367 <label class="md-nav__title" for="__nav_2_5_1">
368 <span class="md-nav__icon md-icon"></span>
369 Caches
370 </label>
371 <ul class="md-nav__list" data-md-scrollfix>
372
373
374
375
376
377
378 <li class="md-nav__item">
379 <a href="../../../php/api/caches/" class="md-nav__link">
380 Overview
381 </a>
382 </li>
383
384
385
386
387
388
389
390
391
392 <li class="md-nav__item">
393 <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
394 Persistent Caches
395 </a>
396 </li>
397
398
399
400
401
402
403
404
405
406 <li class="md-nav__item">
407 <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
408 Runtime Caches
409 </a>
410 </li>
411
412
413
414
415 </ul>
416 </nav>
417 </li>
418
419
420
421
422
423
424
425
426
427 <li class="md-nav__item">
428 <a href="../../../php/api/comments/" class="md-nav__link">
429 Comments
430 </a>
431 </li>
432
433
434
435
436
437
438
439
440
441 <li class="md-nav__item">
442 <a href="../../../php/api/cronjobs/" class="md-nav__link">
443 Cronjobs
444 </a>
445 </li>
446
447
448
449
450
451
452
453
454
455 <li class="md-nav__item">
456 <a href="../../../php/api/events/" class="md-nav__link">
457 Events
458 </a>
459 </li>
460
461
462
463
464
465
466
467
468
469
470 <li class="md-nav__item md-nav__item--nested">
471
472
9aa5da67
WG
473
474
51b70eee 475 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
e02609d6 476
9aa5da67
WG
477
478
51b70eee 479 <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
9aa5da67
WG
480 Form Builder
481 <span class="md-nav__icon md-icon"></span>
482 </label>
483
51b70eee 484 <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
9aa5da67
WG
485 <label class="md-nav__title" for="__nav_2_5_5">
486 <span class="md-nav__icon md-icon"></span>
487 Form Builder
488 </label>
489 <ul class="md-nav__list" data-md-scrollfix>
490
491
492
493
494
495
496 <li class="md-nav__item">
497 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
498 Overview
499 </a>
500 </li>
501
502
503
504
505
506
507
508
509
510 <li class="md-nav__item">
511 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
512 Structure
513 </a>
514 </li>
515
516
517
518
519
520
521
522
523
524 <li class="md-nav__item">
525 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
526 Fields
527 </a>
528 </li>
529
530
531
532
533
534
535
536
537
538 <li class="md-nav__item">
539 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
540 Validation and Data
541 </a>
542 </li>
543
544
545
546
547
548
549
550
551
552 <li class="md-nav__item">
553 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
554 Dependencies
555 </a>
556 </li>
557
558
559
560
561 </ul>
562 </nav>
563 </li>
564
565
566
567
568
569
570
571
572
573 <li class="md-nav__item">
574 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
575 Package Installation Plugins
576 </a>
577 </li>
578
579
580
581
582
583
584
585
586
587 <li class="md-nav__item">
588 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
589 User Activity Points
590 </a>
591 </li>
592
593
594
595
596
597
598
599
600
601 <li class="md-nav__item">
602 <a href="../../../php/api/user_notifications/" class="md-nav__link">
603 User Notifications
604 </a>
605 </li>
606
607
608
609
610
611
612
613
614
615 <li class="md-nav__item">
616 <a href="../../../php/api/sitemaps/" class="md-nav__link">
617 Sitemaps
618 </a>
619 </li>
620
621
622
623
624 </ul>
625 </nav>
626 </li>
627
628
629
630
631
632
633
634
635
636 <li class="md-nav__item">
637 <a href="../../../php/code-style/" class="md-nav__link">
638 Code Style
639 </a>
640 </li>
641
642
643
644
645
646
647
648
649
650 <li class="md-nav__item">
651 <a href="../../../php/apps/" class="md-nav__link">
652 Apps
653 </a>
654 </li>
655
656
657
658
659
660
661
662
663
664 <li class="md-nav__item">
665 <a href="../../../php/gdpr/" class="md-nav__link">
666 GDPR
667 </a>
668 </li>
669
670
671
672
673 </ul>
674 </nav>
675 </li>
676
677
678
679
680
681
682
683
684
685
686
687 <li class="md-nav__item md-nav__item--nested">
688
689
9aa5da67
WG
690
691
51b70eee 692 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
e02609d6 693
9aa5da67
WG
694
695
51b70eee 696 <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
9aa5da67
WG
697 Languages, Templates & CSS
698 <span class="md-nav__icon md-icon"></span>
699 </label>
700
51b70eee 701 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
9aa5da67
WG
702 <label class="md-nav__title" for="__nav_3">
703 <span class="md-nav__icon md-icon"></span>
704 Languages, Templates & CSS
705 </label>
706 <ul class="md-nav__list" data-md-scrollfix>
707
708
709
710
711
712
713 <li class="md-nav__item">
714 <a href="../../../view/languages/" class="md-nav__link">
715 Languages
716 </a>
717 </li>
718
719
720
721
722
723
724
725
726
727 <li class="md-nav__item">
728 <a href="../../../view/templates/" class="md-nav__link">
729 Templates
730 </a>
731 </li>
732
733
734
735
736
737
738
739
740
741 <li class="md-nav__item">
742 <a href="../../../view/template-plugins/" class="md-nav__link">
743 Template Plugins
744 </a>
745 </li>
746
747
748
749
750
751
752
753
754
755 <li class="md-nav__item">
756 <a href="../../../view/css/" class="md-nav__link">
757 CSS
758 </a>
759 </li>
760
761
762
763
764 </ul>
765 </nav>
766 </li>
767
768
769
770
771
772
773
774
775
776
777
778 <li class="md-nav__item md-nav__item--nested">
779
780
9aa5da67
WG
781
782
51b70eee 783 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
9aa5da67
WG
784
785
e02609d6 786
51b70eee 787 <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
9aa5da67
WG
788 TypeScript and JavaScript API
789 <span class="md-nav__icon md-icon"></span>
790 </label>
791
51b70eee 792 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
9aa5da67
WG
793 <label class="md-nav__title" for="__nav_4">
794 <span class="md-nav__icon md-icon"></span>
795 TypeScript and JavaScript API
796 </label>
797 <ul class="md-nav__list" data-md-scrollfix>
798
799
800
801
802
803
804 <li class="md-nav__item">
805 <a href="../../../javascript/general-usage/" class="md-nav__link">
806 General Usage
807 </a>
808 </li>
809
810
811
812
813
814
815
816
817
818 <li class="md-nav__item">
819 <a href="../../../javascript/typescript/" class="md-nav__link">
820 TypeScript
821 </a>
822 </li>
823
824
825
826
827
828
829
830
831
832
833 <li class="md-nav__item md-nav__item--nested">
834
835
9aa5da67
WG
836
837
51b70eee 838 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
e02609d6 839
9aa5da67
WG
840
841
51b70eee 842 <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
9f399714
WG
843 Components
844 <span class="md-nav__icon md-icon"></span>
845 </label>
846
51b70eee 847 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
9f399714
WG
848 <label class="md-nav__title" for="__nav_4_3">
849 <span class="md-nav__icon md-icon"></span>
850 Components
851 </label>
852 <ul class="md-nav__list" data-md-scrollfix>
853
854
855
856
857
858
859 <li class="md-nav__item">
860 <a href="../../../javascript/components_confirmation/" class="md-nav__link">
861 Confirmation
862 </a>
863 </li>
864
865
866
867
868
869
870
871
872
873 <li class="md-nav__item">
874 <a href="../../../javascript/components_dialog/" class="md-nav__link">
875 Dialog
876 </a>
877 </li>
878
879
880
881
f2d0508c
WG
882
883
884
885
886
816a45a9
WG
887 <li class="md-nav__item">
888 <a href="../../../javascript/components_google_maps/" class="md-nav__link">
889 Google Maps
890 </a>
891 </li>
892
893
894
895
896
897
898
899
900
f2d0508c
WG
901 <li class="md-nav__item">
902 <a href="../../../javascript/components_pagination/" class="md-nav__link">
903 Pagination
904 </a>
905 </li>
906
907
908
909
9f399714
WG
910 </ul>
911 </nav>
912 </li>
913
914
915
916
917
918
919
920
921
922
923 <li class="md-nav__item md-nav__item--nested">
924
925
9f399714
WG
926
927
51b70eee 928 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
9f399714
WG
929
930
e02609d6 931
51b70eee 932 <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
9aa5da67
WG
933 New API
934 <span class="md-nav__icon md-icon"></span>
935 </label>
936
51b70eee 937 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
9f399714 938 <label class="md-nav__title" for="__nav_4_4">
9aa5da67
WG
939 <span class="md-nav__icon md-icon"></span>
940 New API
941 </label>
942 <ul class="md-nav__list" data-md-scrollfix>
943
944
945
946
947
948
949 <li class="md-nav__item">
950 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
951 Writing a module
952 </a>
953 </li>
954
955
956
957
958
959
960
961
962
9aa5da67
WG
963 <li class="md-nav__item">
964 <a href="../../../javascript/new-api_core/" class="md-nav__link">
965 Core Functions
966 </a>
967 </li>
968
969
970
971
972
973
974
975
976
977 <li class="md-nav__item">
978 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
979 DOM
980 </a>
981 </li>
982
983
984
985
986
987
988
989
990
991 <li class="md-nav__item">
992 <a href="../../../javascript/new-api_events/" class="md-nav__link">
993 Event Handling
994 </a>
995 </li>
996
997
998
999
1000
1001
1002
1003
1004
1005 <li class="md-nav__item">
1006 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1007 Ajax
1008 </a>
1009 </li>
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019 <li class="md-nav__item">
1020 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1021 Dialogs
1022 </a>
1023 </li>
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033 <li class="md-nav__item">
1034 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1035 Browser and Screen Sizes
1036 </a>
1037 </li>
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047 <li class="md-nav__item">
1048 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1049 User Interface
1050 </a>
1051 </li>
1052
1053
1054
1055
1056 </ul>
1057 </nav>
1058 </li>
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068 <li class="md-nav__item">
1069 <a href="../../../javascript/legacy-api/" class="md-nav__link">
1070 Legacy API
1071 </a>
1072 </li>
1073
1074
1075
1076
1077
1078
1079
1080
1081
9aa5da67
WG
1082 <li class="md-nav__item">
1083 <a href="../../../javascript/code-snippets/" class="md-nav__link">
1084 Code Snippets
1085 </a>
1086 </li>
1087
1088
1089
1090
1091 </ul>
1092 </nav>
1093 </li>
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1108
1109
9aa5da67
WG
1110
1111
51b70eee 1112 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
e02609d6 1113
9aa5da67
WG
1114
1115
51b70eee 1116 <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
9aa5da67
WG
1117 Package Components
1118 <span class="md-nav__icon md-icon"></span>
1119 </label>
1120
51b70eee 1121 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
9aa5da67
WG
1122 <label class="md-nav__title" for="__nav_5">
1123 <span class="md-nav__icon md-icon"></span>
1124 Package Components
1125 </label>
1126 <ul class="md-nav__list" data-md-scrollfix>
1127
1128
1129
1130
1131
1132
1133 <li class="md-nav__item">
1134 <a href="../../package-xml/" class="md-nav__link">
1135 package.xml
1136 </a>
1137 </li>
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1151
1152
9aa5da67
WG
1153
1154
51b70eee 1155 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" checked>
9aa5da67
WG
1156
1157
e02609d6 1158
51b70eee 1159 <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
9aa5da67
WG
1160 PIPs
1161 <span class="md-nav__icon md-icon"></span>
1162 </label>
1163
51b70eee 1164 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="true">
9aa5da67
WG
1165 <label class="md-nav__title" for="__nav_5_2">
1166 <span class="md-nav__icon md-icon"></span>
1167 PIPs
1168 </label>
1169 <ul class="md-nav__list" data-md-scrollfix>
1170
1171
1172
1173
1174
1175
1176 <li class="md-nav__item">
1177 <a href="../" class="md-nav__link">
1178 Overview
1179 </a>
1180 </li>
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190 <li class="md-nav__item">
1191 <a href="../acl-option/" class="md-nav__link">
1192 aclOption
1193 </a>
1194 </li>
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204 <li class="md-nav__item">
1205 <a href="../acp-menu/" class="md-nav__link">
1206 acpMenu
1207 </a>
1208 </li>
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218 <li class="md-nav__item">
1219 <a href="../acp-search-provider/" class="md-nav__link">
1220 acpSearchProvider
1221 </a>
1222 </li>
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232 <li class="md-nav__item">
1233 <a href="../acp-template/" class="md-nav__link">
1234 acpTemplate
1235 </a>
1236 </li>
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246 <li class="md-nav__item">
1247 <a href="../acp-template-delete/" class="md-nav__link">
1248 acpTemplateDelete
1249 </a>
1250 </li>
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260 <li class="md-nav__item">
1261 <a href="../bbcode/" class="md-nav__link">
1262 bbcode
1263 </a>
1264 </li>
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274 <li class="md-nav__item">
1275 <a href="../box/" class="md-nav__link">
1276 box
1277 </a>
1278 </li>
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288 <li class="md-nav__item">
1289 <a href="../clipboard-action/" class="md-nav__link">
1290 clipboardAction
1291 </a>
1292 </li>
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302 <li class="md-nav__item">
1303 <a href="../core-object/" class="md-nav__link">
1304 coreObject
1305 </a>
1306 </li>
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316 <li class="md-nav__item">
1317 <a href="../cronjob/" class="md-nav__link">
1318 cronjob
1319 </a>
1320 </li>
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330 <li class="md-nav__item">
1331 <a href="../database/" class="md-nav__link">
1332 database
1333 </a>
1334 </li>
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344 <li class="md-nav__item">
1345 <a href="../event-listener/" class="md-nav__link">
1346 eventListener
1347 </a>
1348 </li>
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358 <li class="md-nav__item">
1359 <a href="../file/" class="md-nav__link">
1360 file
1361 </a>
1362 </li>
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372 <li class="md-nav__item">
1373 <a href="../file-delete/" class="md-nav__link">
1374 fileDelete
1375 </a>
1376 </li>
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386 <li class="md-nav__item">
1387 <a href="../language/" class="md-nav__link">
1388 language
1389 </a>
1390 </li>
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400 <li class="md-nav__item">
1401 <a href="../media-provider/" class="md-nav__link">
1402 mediaProvider
1403 </a>
1404 </li>
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414 <li class="md-nav__item">
1415 <a href="../menu/" class="md-nav__link">
1416 menu
1417 </a>
1418 </li>
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428 <li class="md-nav__item">
1429 <a href="../menu-item/" class="md-nav__link">
1430 menuItem
1431 </a>
1432 </li>
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442 <li class="md-nav__item">
1443 <a href="../object-type/" class="md-nav__link">
1444 objectType
1445 </a>
1446 </li>
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456 <li class="md-nav__item">
1457 <a href="../object-type-definition/" class="md-nav__link">
1458 objectTypeDefinition
1459 </a>
1460 </li>
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470 <li class="md-nav__item">
1471 <a href="../option/" class="md-nav__link">
1472 option
1473 </a>
1474 </li>
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484 <li class="md-nav__item">
1485 <a href="../page/" class="md-nav__link">
1486 page
1487 </a>
1488 </li>
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498 <li class="md-nav__item">
1499 <a href="../pip/" class="md-nav__link">
1500 pip
1501 </a>
1502 </li>
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512 <li class="md-nav__item">
1513 <a href="../script/" class="md-nav__link">
1514 script
1515 </a>
1516 </li>
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526 <li class="md-nav__item">
1527 <a href="../smiley/" class="md-nav__link">
1528 smiley
1529 </a>
1530 </li>
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540 <li class="md-nav__item">
1541 <a href="../sql/" class="md-nav__link">
1542 sql
1543 </a>
1544 </li>
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554 <li class="md-nav__item">
1555 <a href="../style/" class="md-nav__link">
1556 style
1557 </a>
1558 </li>
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568 <li class="md-nav__item">
1569 <a href="../template/" class="md-nav__link">
1570 template
1571 </a>
1572 </li>
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582 <li class="md-nav__item">
1583 <a href="../template-delete/" class="md-nav__link">
1584 templateDelete
1585 </a>
1586 </li>
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596 <li class="md-nav__item">
1597 <a href="../template-listener/" class="md-nav__link">
1598 templateListener
1599 </a>
1600 </li>
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610 <li class="md-nav__item">
1611 <a href="../user-group-option/" class="md-nav__link">
1612 userGroupOption
1613 </a>
1614 </li>
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626 <li class="md-nav__item md-nav__item--active">
1627
51b70eee 1628 <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
9aa5da67
WG
1629
1630
1631
1632
1633
1634 <label class="md-nav__link md-nav__link--active" for="__toc">
1635 userMenu
1636 <span class="md-nav__icon md-icon"></span>
1637 </label>
1638
1639 <a href="./" class="md-nav__link md-nav__link--active">
1640 userMenu
1641 </a>
1642
1643
1644
1645<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1646
1647
1648
1649
1650
1651
1652 <label class="md-nav__title" for="__toc">
1653 <span class="md-nav__icon md-icon"></span>
1654 Table of contents
1655 </label>
1656 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1657
1658 <li class="md-nav__item">
1659 <a href="#components" class="md-nav__link">
1660 Components
1661 </a>
1662
1663 <nav class="md-nav" aria-label="Components">
1664 <ul class="md-nav__list">
1665
1666 <li class="md-nav__item">
1667 <a href="#parent" class="md-nav__link">
1668 &lt;parent&gt;
1669 </a>
1670
1671</li>
1672
1673 <li class="md-nav__item">
1674 <a href="#showorder" class="md-nav__link">
1675 &lt;showorder&gt;
1676 </a>
1677
1678</li>
1679
1680 <li class="md-nav__item">
1681 <a href="#controller" class="md-nav__link">
1682 &lt;controller&gt;
1683 </a>
1684
1685</li>
1686
1687 <li class="md-nav__item">
1688 <a href="#link" class="md-nav__link">
1689 &lt;link&gt;
1690 </a>
1691
1692</li>
1693
1694 <li class="md-nav__item">
1695 <a href="#iconclassname" class="md-nav__link">
1696 &lt;iconclassname&gt;
1697 </a>
1698
1699</li>
1700
1701 <li class="md-nav__item">
1702 <a href="#options" class="md-nav__link">
1703 &lt;options&gt;
1704 </a>
1705
1706</li>
1707
1708 <li class="md-nav__item">
1709 <a href="#permissions" class="md-nav__link">
1710 &lt;permissions&gt;
1711 </a>
1712
1713</li>
1714
1715 <li class="md-nav__item">
1716 <a href="#classname" class="md-nav__link">
1717 &lt;classname&gt;
1718 </a>
1719
1720</li>
1721
1722 </ul>
1723 </nav>
1724
1725</li>
1726
1727 <li class="md-nav__item">
1728 <a href="#example" class="md-nav__link">
1729 Example
1730 </a>
1731
1732</li>
1733
1734 </ul>
1735
1736</nav>
1737
1738 </li>
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748 <li class="md-nav__item">
1749 <a href="../user-notification-event/" class="md-nav__link">
1750 userNotificationEvent
1751 </a>
1752 </li>
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762 <li class="md-nav__item">
1763 <a href="../user-option/" class="md-nav__link">
1764 userOption
1765 </a>
1766 </li>
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776 <li class="md-nav__item">
1777 <a href="../user-profile-menu/" class="md-nav__link">
1778 userProfileMenu
1779 </a>
1780 </li>
1781
1782
1783
1784
1785 </ul>
1786 </nav>
1787 </li>
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797 <li class="md-nav__item">
1798 <a href="../../database-php-api/" class="md-nav__link">
1799 Database PHP API
1800 </a>
1801 </li>
1802
1803
1804
1805
1806 </ul>
1807 </nav>
1808 </li>
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820 <li class="md-nav__item md-nav__item--nested">
1821
1822
9aa5da67
WG
1823
1824
51b70eee 1825 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
e02609d6 1826
9aa5da67
WG
1827
1828
51b70eee 1829 <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
9aa5da67
WG
1830 Migration
1831 <span class="md-nav__icon md-icon"></span>
1832 </label>
1833
51b70eee 1834 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
9aa5da67
WG
1835 <label class="md-nav__title" for="__nav_6">
1836 <span class="md-nav__icon md-icon"></span>
1837 Migration
1838 </label>
1839 <ul class="md-nav__list" data-md-scrollfix>
1840
1841
1842
1843
1844
1845
1846
1847 <li class="md-nav__item md-nav__item--nested">
1848
1849
9aa5da67
WG
1850
1851
51b70eee 1852 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
e02609d6 1853
9aa5da67
WG
1854
1855
51b70eee 1856 <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
9aa5da67
WG
1857 From WoltLab Suite 5.5
1858 <span class="md-nav__icon md-icon"></span>
1859 </label>
1860
51b70eee 1861 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
9aa5da67
WG
1862 <label class="md-nav__title" for="__nav_6_1">
1863 <span class="md-nav__icon md-icon"></span>
1864 From WoltLab Suite 5.5
1865 </label>
1866 <ul class="md-nav__list" data-md-scrollfix>
1867
1868
1869
1870
1871
1872
1873 <li class="md-nav__item">
1874 <a href="../../../migration/wsc55/php/" class="md-nav__link">
1875 PHP API
1876 </a>
1877 </li>
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887 <li class="md-nav__item">
1888 <a href="../../../migration/wsc55/javascript/" class="md-nav__link">
1889 TypeScript and JavaScript
1890 </a>
1891 </li>
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901 <li class="md-nav__item">
1902 <a href="../../../migration/wsc55/templates/" class="md-nav__link">
1903 Templates
1904 </a>
1905 </li>
1906
1907
1908
1909
1910
1911
1912
1913
1914
024038ef
WG
1915 <li class="md-nav__item">
1916 <a href="../../../migration/wsc55/icons/" class="md-nav__link">
1917 Icons
1918 </a>
1919 </li>
1920
1921
1922
1923
1924
1925
1926
1927
1928
6d611e8a
WG
1929 <li class="md-nav__item">
1930 <a href="../../../migration/wsc55/dialogs/" class="md-nav__link">
1931 Dialogs
1932 </a>
1933 </li>
1934
1935
1936
1937
1938
1939
1940
1941
1942
9aa5da67
WG
1943 <li class="md-nav__item">
1944 <a href="../../../migration/wsc55/libraries/" class="md-nav__link">
1945 Third Party Libraries
1946 </a>
1947 </li>
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957 <li class="md-nav__item">
1958 <a href="../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1959 Deprecations and Removals
1960 </a>
1961 </li>
1962
1963
1964
1965
1966 </ul>
1967 </nav>
1968 </li>
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979 <li class="md-nav__item md-nav__item--nested">
1980
1981
9aa5da67
WG
1982
1983
51b70eee 1984 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
9aa5da67
WG
1985
1986
e02609d6 1987
51b70eee 1988 <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
9aa5da67
WG
1989 From WoltLab Suite 5.4
1990 <span class="md-nav__icon md-icon"></span>
1991 </label>
1992
51b70eee 1993 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
9aa5da67
WG
1994 <label class="md-nav__title" for="__nav_6_2">
1995 <span class="md-nav__icon md-icon"></span>
1996 From WoltLab Suite 5.4
1997 </label>
1998 <ul class="md-nav__list" data-md-scrollfix>
1999
2000
2001
2002
2003
2004
2005 <li class="md-nav__item">
2006 <a href="../../../migration/wsc54/php/" class="md-nav__link">
2007 PHP API
2008 </a>
2009 </li>
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019 <li class="md-nav__item">
2020 <a href="../../../migration/wsc54/javascript/" class="md-nav__link">
2021 TypeScript and JavaScript
2022 </a>
2023 </li>
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033 <li class="md-nav__item">
2034 <a href="../../../migration/wsc54/templates/" class="md-nav__link">
2035 Templates
2036 </a>
2037 </li>
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047 <li class="md-nav__item">
2048 <a href="../../../migration/wsc54/libraries/" class="md-nav__link">
2049 Third Party Libraries
2050 </a>
2051 </li>
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061 <li class="md-nav__item">
2062 <a href="../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2063 Deprecations and Removals
2064 </a>
2065 </li>
2066
2067
2068
2069
2070 </ul>
2071 </nav>
2072 </li>
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083 <li class="md-nav__item md-nav__item--nested">
2084
2085
9aa5da67
WG
2086
2087
51b70eee 2088 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
e02609d6 2089
9aa5da67
WG
2090
2091
51b70eee 2092 <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
9aa5da67
WG
2093 From WoltLab Suite 5.3
2094 <span class="md-nav__icon md-icon"></span>
2095 </label>
2096
51b70eee 2097 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
9aa5da67
WG
2098 <label class="md-nav__title" for="__nav_6_3">
2099 <span class="md-nav__icon md-icon"></span>
2100 From WoltLab Suite 5.3
2101 </label>
2102 <ul class="md-nav__list" data-md-scrollfix>
2103
2104
2105
2106
2107
2108
2109 <li class="md-nav__item">
2110 <a href="../../../migration/wsc53/php/" class="md-nav__link">
2111 PHP API
2112 </a>
2113 </li>
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123 <li class="md-nav__item">
2124 <a href="../../../migration/wsc53/session/" class="md-nav__link">
2125 Session Handling and Authentication
2126 </a>
2127 </li>
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137 <li class="md-nav__item">
2138 <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
2139 TypeScript and JavaScript
2140 </a>
2141 </li>
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151 <li class="md-nav__item">
2152 <a href="../../../migration/wsc53/templates/" class="md-nav__link">
2153 Templates
2154 </a>
2155 </li>
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165 <li class="md-nav__item">
2166 <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
2167 Third Party Libraries
2168 </a>
2169 </li>
2170
2171
2172
2173
2174 </ul>
2175 </nav>
2176 </li>
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187 <li class="md-nav__item md-nav__item--nested">
2188
2189
9aa5da67
WG
2190
2191
51b70eee 2192 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
e02609d6 2193
9aa5da67
WG
2194
2195
51b70eee 2196 <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
9aa5da67
WG
2197 From WoltLab Suite 5.2
2198 <span class="md-nav__icon md-icon"></span>
2199 </label>
2200
51b70eee 2201 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
9aa5da67
WG
2202 <label class="md-nav__title" for="__nav_6_4">
2203 <span class="md-nav__icon md-icon"></span>
2204 From WoltLab Suite 5.2
2205 </label>
2206 <ul class="md-nav__list" data-md-scrollfix>
2207
2208
2209
2210
2211
2212
2213 <li class="md-nav__item">
2214 <a href="../../../migration/wsc52/php/" class="md-nav__link">
2215 PHP API
2216 </a>
2217 </li>
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227 <li class="md-nav__item">
2228 <a href="../../../migration/wsc52/templates/" class="md-nav__link">
2229 Templates and Languages
2230 </a>
2231 </li>
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241 <li class="md-nav__item">
2242 <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
2243 Third Party Libraries
2244 </a>
2245 </li>
2246
2247
2248
2249
2250 </ul>
2251 </nav>
2252 </li>
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263 <li class="md-nav__item md-nav__item--nested">
2264
2265
9aa5da67
WG
2266
2267
51b70eee 2268 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
9aa5da67
WG
2269
2270
e02609d6 2271
51b70eee 2272 <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
9aa5da67
WG
2273 From WoltLab Suite 3.1
2274 <span class="md-nav__icon md-icon"></span>
2275 </label>
2276
51b70eee 2277 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
9aa5da67
WG
2278 <label class="md-nav__title" for="__nav_6_5">
2279 <span class="md-nav__icon md-icon"></span>
2280 From WoltLab Suite 3.1
2281 </label>
2282 <ul class="md-nav__list" data-md-scrollfix>
2283
2284
2285
2286
2287
2288
2289 <li class="md-nav__item">
2290 <a href="../../../migration/wsc31/php/" class="md-nav__link">
2291 PHP API
2292 </a>
2293 </li>
2294
2295
2296
2297
2298 </ul>
2299 </nav>
2300 </li>
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311 <li class="md-nav__item md-nav__item--nested">
2312
2313
9aa5da67
WG
2314
2315
51b70eee 2316 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
e02609d6 2317
9aa5da67
WG
2318
2319
51b70eee 2320 <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
9aa5da67
WG
2321 From WoltLab Suite 3.0
2322 <span class="md-nav__icon md-icon"></span>
2323 </label>
2324
51b70eee 2325 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
9aa5da67
WG
2326 <label class="md-nav__title" for="__nav_6_6">
2327 <span class="md-nav__icon md-icon"></span>
2328 From WoltLab Suite 3.0
2329 </label>
2330 <ul class="md-nav__list" data-md-scrollfix>
2331
2332
2333
2334
2335
2336
2337 <li class="md-nav__item">
2338 <a href="../../../migration/wsc30/php/" class="md-nav__link">
2339 PHP API
2340 </a>
2341 </li>
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351 <li class="md-nav__item">
2352 <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
2353 JavaScript API
2354 </a>
2355 </li>
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365 <li class="md-nav__item">
2366 <a href="../../../migration/wsc30/templates/" class="md-nav__link">
2367 Templates
2368 </a>
2369 </li>
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379 <li class="md-nav__item">
2380 <a href="../../../migration/wsc30/css/" class="md-nav__link">
2381 CSS
2382 </a>
2383 </li>
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393 <li class="md-nav__item">
2394 <a href="../../../migration/wsc30/package/" class="md-nav__link">
2395 Package Components
2396 </a>
2397 </li>
2398
2399
2400
2401
2402 </ul>
2403 </nav>
2404 </li>
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415 <li class="md-nav__item md-nav__item--nested">
2416
2417
9aa5da67
WG
2418
2419
51b70eee 2420 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
e02609d6 2421
9aa5da67
WG
2422
2423
51b70eee 2424 <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
9aa5da67
WG
2425 From WCF 2.1
2426 <span class="md-nav__icon md-icon"></span>
2427 </label>
2428
51b70eee 2429 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
9aa5da67
WG
2430 <label class="md-nav__title" for="__nav_6_7">
2431 <span class="md-nav__icon md-icon"></span>
2432 From WCF 2.1
2433 </label>
2434 <ul class="md-nav__list" data-md-scrollfix>
2435
2436
2437
2438
2439
2440
2441 <li class="md-nav__item">
2442 <a href="../../../migration/wcf21/php/" class="md-nav__link">
2443 PHP API
2444 </a>
2445 </li>
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455 <li class="md-nav__item">
2456 <a href="../../../migration/wcf21/templates/" class="md-nav__link">
2457 Templates
2458 </a>
2459 </li>
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469 <li class="md-nav__item">
2470 <a href="../../../migration/wcf21/css/" class="md-nav__link">
2471 CSS
2472 </a>
2473 </li>
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483 <li class="md-nav__item">
2484 <a href="../../../migration/wcf21/package/" class="md-nav__link">
2485 Package Components
2486 </a>
2487 </li>
2488
2489
2490
2491
2492 </ul>
2493 </nav>
2494 </li>
2495
2496
2497
2498
2499 </ul>
2500 </nav>
2501 </li>
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513 <li class="md-nav__item md-nav__item--nested">
2514
2515
9aa5da67
WG
2516
2517
51b70eee 2518 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
9aa5da67
WG
2519
2520
e02609d6 2521
51b70eee 2522 <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
9aa5da67
WG
2523 Tutorials
2524 <span class="md-nav__icon md-icon"></span>
2525 </label>
2526
51b70eee 2527 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
9aa5da67
WG
2528 <label class="md-nav__title" for="__nav_7">
2529 <span class="md-nav__icon md-icon"></span>
2530 Tutorials
2531 </label>
2532 <ul class="md-nav__list" data-md-scrollfix>
2533
2534
2535
2536
2537
2538
2539
2540 <li class="md-nav__item md-nav__item--nested">
2541
2542
9aa5da67
WG
2543
2544
51b70eee 2545 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
e02609d6 2546
9aa5da67
WG
2547
2548
51b70eee 2549 <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
9aa5da67
WG
2550 Tutorial Series
2551 <span class="md-nav__icon md-icon"></span>
2552 </label>
2553
51b70eee 2554 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
9aa5da67
WG
2555 <label class="md-nav__title" for="__nav_7_1">
2556 <span class="md-nav__icon md-icon"></span>
2557 Tutorial Series
2558 </label>
2559 <ul class="md-nav__list" data-md-scrollfix>
2560
2561
2562
2563
2564
2565
2566 <li class="md-nav__item">
2567 <a href="../../../tutorial/series/overview/" class="md-nav__link">
2568 Overview
2569 </a>
2570 </li>
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580 <li class="md-nav__item">
2581 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2582 Part 1
2583 </a>
2584 </li>
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594 <li class="md-nav__item">
2595 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2596 Part 2
2597 </a>
2598 </li>
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608 <li class="md-nav__item">
2609 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2610 Part 3
2611 </a>
2612 </li>
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622 <li class="md-nav__item">
2623 <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2624 Part 4
2625 </a>
2626 </li>
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636 <li class="md-nav__item">
2637 <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2638 Part 5
2639 </a>
2640 </li>
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650 <li class="md-nav__item">
2651 <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2652 Part 6
2653 </a>
2654 </li>
2655
2656
2657
2658
2659 </ul>
2660 </nav>
2661 </li>
2662
2663
2664
2665
2666 </ul>
2667 </nav>
2668 </li>
2669
2670
2671
2672 </ul>
2673</nav>
2674 </div>
2675 </div>
2676 </div>
2677
2678
2679
2680 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2681 <div class="md-sidebar__scrollwrap">
2682 <div class="md-sidebar__inner">
2683
2684
2685<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2686
2687
2688
2689
2690
2691
2692 <label class="md-nav__title" for="__toc">
2693 <span class="md-nav__icon md-icon"></span>
2694 Table of contents
2695 </label>
2696 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2697
2698 <li class="md-nav__item">
2699 <a href="#components" class="md-nav__link">
2700 Components
2701 </a>
2702
2703 <nav class="md-nav" aria-label="Components">
2704 <ul class="md-nav__list">
2705
2706 <li class="md-nav__item">
2707 <a href="#parent" class="md-nav__link">
2708 &lt;parent&gt;
2709 </a>
2710
2711</li>
2712
2713 <li class="md-nav__item">
2714 <a href="#showorder" class="md-nav__link">
2715 &lt;showorder&gt;
2716 </a>
2717
2718</li>
2719
2720 <li class="md-nav__item">
2721 <a href="#controller" class="md-nav__link">
2722 &lt;controller&gt;
2723 </a>
2724
2725</li>
2726
2727 <li class="md-nav__item">
2728 <a href="#link" class="md-nav__link">
2729 &lt;link&gt;
2730 </a>
2731
2732</li>
2733
2734 <li class="md-nav__item">
2735 <a href="#iconclassname" class="md-nav__link">
2736 &lt;iconclassname&gt;
2737 </a>
2738
2739</li>
2740
2741 <li class="md-nav__item">
2742 <a href="#options" class="md-nav__link">
2743 &lt;options&gt;
2744 </a>
2745
2746</li>
2747
2748 <li class="md-nav__item">
2749 <a href="#permissions" class="md-nav__link">
2750 &lt;permissions&gt;
2751 </a>
2752
2753</li>
2754
2755 <li class="md-nav__item">
2756 <a href="#classname" class="md-nav__link">
2757 &lt;classname&gt;
2758 </a>
2759
2760</li>
2761
2762 </ul>
2763 </nav>
2764
2765</li>
2766
2767 <li class="md-nav__item">
2768 <a href="#example" class="md-nav__link">
2769 Example
2770 </a>
2771
2772</li>
2773
2774 </ul>
2775
2776</nav>
2777 </div>
2778 </div>
2779 </div>
2780
2781
7f9945cf
WG
2782
2783 <div class="md-content" data-md-component="content">
2784 <article class="md-content__inner md-typeset">
9aa5da67 2785
7f9945cf
WG
2786
2787
e02609d6
WG
2788
2789
2790
9aa5da67 2791
9aa5da67
WG
2792<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>
2793<p>Registers new user menu items.</p>
2794<h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
2795<p>Each item is described as an <code>&lt;usermenuitem&gt;</code> element with the mandatory attribute <code>name</code>.</p>
2796<h3 id="parent"><code>&lt;parent&gt;</code><a class="headerlink" href="#parent" title="Permanent link">#</a></h3>
2797<p><span class="label label-info">Optional</span></p>
2798<p>The item’s parent item.</p>
2799<h3 id="showorder"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder" title="Permanent link">#</a></h3>
2800<p><span class="label label-info">Optional</span></p>
2801<p>Specifies the order of this item within the parent item.</p>
2802<h3 id="controller"><code>&lt;controller&gt;</code><a class="headerlink" href="#controller" title="Permanent link">#</a></h3>
2803<p>The fully qualified class name of the target controller.
2804If not specified this item serves as a category.</p>
2805<h3 id="link"><code>&lt;link&gt;</code><a class="headerlink" href="#link" title="Permanent link">#</a></h3>
2806<p>Additional components if <code>&lt;controller&gt;</code> is set,
2807the full external link otherwise.</p>
2808<h3 id="iconclassname"><code>&lt;iconclassname&gt;</code><a class="headerlink" href="#iconclassname" title="Permanent link">#</a></h3>
2809<div class="admonition info">
2810<p class="admonition-title">Use an icon only for top-level items.</p>
2811</div>
2812<p>Name of the Font Awesome icon class.</p>
2813<h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2814<p><span class="label label-info">Optional</span></p>
2815<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>
2816<h3 id="permissions"><code>&lt;permissions&gt;</code><a class="headerlink" href="#permissions" title="Permanent link">#</a></h3>
2817<p><span class="label label-info">Optional</span></p>
2818<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>
2819<h3 id="classname"><code>&lt;classname&gt;</code><a class="headerlink" href="#classname" title="Permanent link">#</a></h3>
2820<p>The name of the class providing the user menu item’s behaviour,
2821the class has to implement the <code>wcf\system\menu\user\IUserMenuItemProvider</code> interface.</p>
2822<h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2823<div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">userMenu.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/package/pip/userMenu.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2824<span class="normal"> 2</span>
2825<span class="normal"> 3</span>
2826<span class="normal"> 4</span>
2827<span class="normal"> 5</span>
2828<span class="normal"> 6</span>
2829<span class="normal"> 7</span>
2830<span class="normal"> 8</span>
2831<span class="normal"> 9</span>
2832<span class="normal">10</span>
2833<span class="normal">11</span>
2834<span class="normal">12</span>
2835<span class="normal">13</span>
2836<span class="normal">14</span>
2837<span class="normal">15</span>
2838<span class="normal">16</span>
2839<span class="normal">17</span>
2840<span class="normal">18</span>
2841<span class="normal">19</span>
2842<span class="normal">20</span>
2843<span class="normal">21</span>
2844<span class="normal">22</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
c708394c
WG
2845<span class="nt">&lt;data</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/userMenu.xsd&quot;</span><span class="nt">&gt;</span>
2846<span class="w"> </span><span class="nt">&lt;import&gt;</span>
2847<span class="w"> </span><span class="nt">&lt;usermenuitem</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;wcf.user.menu.foo&quot;</span><span class="nt">&gt;</span>
2848<span class="w"> </span><span class="nt">&lt;iconclassname&gt;</span>fa-home<span class="nt">&lt;/iconclassname&gt;</span>
2849<span class="w"> </span><span class="nt">&lt;/usermenuitem&gt;</span>
2850
2851<span class="w"> </span><span class="nt">&lt;usermenuitem</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;wcf.user.menu.foo.bar&quot;</span><span class="nt">&gt;</span>
2852<span class="w"> </span><span class="nt">&lt;controller&gt;</span>wcf\page\FooBarListPage<span class="nt">&lt;/controller&gt;</span>
2853<span class="w"> </span><span class="nt">&lt;parent&gt;</span>wcf.user.menu.foo<span class="nt">&lt;/parent&gt;</span>
2854<span class="w"> </span><span class="nt">&lt;permissions&gt;</span>user.foo.canBar<span class="nt">&lt;/permissions&gt;</span>
2855<span class="w"> </span><span class="nt">&lt;classname&gt;</span>wcf\system\menu\user\FooBarMenuItemProvider<span class="nt">&lt;/classname&gt;</span>
2856<span class="w"> </span><span class="nt">&lt;/usermenuitem&gt;</span>
2857
2858<span class="w"> </span><span class="nt">&lt;usermenuitem</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;wcf.user.menu.foo.baz&quot;</span><span class="nt">&gt;</span>
2859<span class="w"> </span><span class="nt">&lt;controller&gt;</span>wcf\page\FooBazListPage<span class="nt">&lt;/controller&gt;</span>
2860<span class="w"> </span><span class="nt">&lt;parent&gt;</span>wcf.user.menu.foo<span class="nt">&lt;/parent&gt;</span>
2861<span class="w"> </span><span class="nt">&lt;permissions&gt;</span>user.foo.canBaz<span class="nt">&lt;/permissions&gt;</span>
2862<span class="w"> </span><span class="nt">&lt;options&gt;</span>module_foo_bar<span class="nt">&lt;/options&gt;</span>
2863<span class="w"> </span><span class="nt">&lt;/usermenuitem&gt;</span>
2864<span class="w"> </span><span class="nt">&lt;/import&gt;</span>
9aa5da67
WG
2865<span class="nt">&lt;/data&gt;</span>
2866</code></pre></div></td></tr></table></div>
2867
2868 <hr>
2869<div class="md-source-file">
2870 <small>
2871
2872 Last update:
2873 2021-04-23
2874
2875 </small>
2876</div>
2877
a06fd3b1
WG
2878
2879
2880
7f9945cf
WG
2881
2882
2883 </article>
2884 </div>
2885
2886
9aa5da67
WG
2887 </div>
2888
2889 </main>
2890
2891 <footer class="md-footer">
2892
9aa5da67
WG
2893 <div class="md-footer-meta md-typeset">
2894 <div class="md-footer-meta__inner md-grid">
2895 <div class="md-copyright">
2896
2897 <div class="md-copyright__highlight">
2898 Copyright © 2020 WoltLab GmbH
2899 </div>
2900
2901
2902 Made with
2903 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2904 Material for MkDocs
2905 </a>
2906
2907</div>
2908
2909 <div class="md-copyright">
2910 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2911 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2912</div>
2913
2914 </div>
2915 </div>
2916</footer>
2917
2918 </div>
2919 <div class="md-dialog" data-md-component="dialog">
2920 <div class="md-dialog__inner md-typeset"></div>
2921 </div>
a06fd3b1 2922
6f2e8f13 2923 <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
9aa5da67
WG
2924
2925
94fa7b1e 2926 <script src="../../../assets/javascripts/bundle.51198bba.min.js"></script>
9aa5da67
WG
2927
2928
2929 </body>
2930</html>