Deployed 10e50fd9 to 6.0 with MkDocs 1.5.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">
9f07cf57 20 <meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">
9aa5da67
WG
21
22
23
24 <title>userMenu - WoltLab Suite Documentation</title>
25
26
27
e06c8b5f 28 <link rel="stylesheet" href="../../../assets/stylesheets/main.eebd395e.min.css">
9aa5da67
WG
29
30
9d185e89 31 <link rel="stylesheet" href="../../../assets/stylesheets/palette.ecc896b0.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
3c22ac76
WG
741 <li class="md-nav__item">
742 <a href="../../../view/template-modifiers/" class="md-nav__link">
743 Template Modifiers
744 </a>
745 </li>
746
747
748
749
750
751
752
753
754
9aa5da67
WG
755 <li class="md-nav__item">
756 <a href="../../../view/template-plugins/" class="md-nav__link">
757 Template Plugins
758 </a>
759 </li>
760
761
762
763
764
765
766
767
768
769 <li class="md-nav__item">
770 <a href="../../../view/css/" class="md-nav__link">
771 CSS
772 </a>
773 </li>
774
775
776
777
778 </ul>
779 </nav>
780 </li>
781
782
783
784
785
786
787
788
789
790
791
792 <li class="md-nav__item md-nav__item--nested">
793
794
9aa5da67
WG
795
796
51b70eee 797 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
9aa5da67
WG
798
799
e02609d6 800
51b70eee 801 <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
9aa5da67
WG
802 TypeScript and JavaScript API
803 <span class="md-nav__icon md-icon"></span>
804 </label>
805
51b70eee 806 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
9aa5da67
WG
807 <label class="md-nav__title" for="__nav_4">
808 <span class="md-nav__icon md-icon"></span>
809 TypeScript and JavaScript API
810 </label>
811 <ul class="md-nav__list" data-md-scrollfix>
812
813
814
815
816
817
818 <li class="md-nav__item">
819 <a href="../../../javascript/general-usage/" class="md-nav__link">
820 General Usage
821 </a>
822 </li>
823
824
825
826
827
828
829
830
831
832 <li class="md-nav__item">
833 <a href="../../../javascript/typescript/" class="md-nav__link">
834 TypeScript
835 </a>
836 </li>
837
838
839
840
841
842
843
844
845
846
847 <li class="md-nav__item md-nav__item--nested">
848
849
9aa5da67
WG
850
851
51b70eee 852 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
e02609d6 853
9aa5da67
WG
854
855
51b70eee 856 <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
9f399714
WG
857 Components
858 <span class="md-nav__icon md-icon"></span>
859 </label>
860
51b70eee 861 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
9f399714
WG
862 <label class="md-nav__title" for="__nav_4_3">
863 <span class="md-nav__icon md-icon"></span>
864 Components
865 </label>
866 <ul class="md-nav__list" data-md-scrollfix>
867
868
869
870
871
872
8c5b3015
WG
873 <li class="md-nav__item">
874 <a href="../../../javascript/components_ckeditor5/" class="md-nav__link">
875 CKEditor 5
876 </a>
877 </li>
878
879
880
881
882
883
884
885
886
9f399714
WG
887 <li class="md-nav__item">
888 <a href="../../../javascript/components_confirmation/" class="md-nav__link">
889 Confirmation
890 </a>
891 </li>
892
893
894
895
896
897
898
899
900
901 <li class="md-nav__item">
902 <a href="../../../javascript/components_dialog/" class="md-nav__link">
903 Dialog
904 </a>
905 </li>
906
907
908
909
f2d0508c
WG
910
911
912
913
914
816a45a9
WG
915 <li class="md-nav__item">
916 <a href="../../../javascript/components_google_maps/" class="md-nav__link">
917 Google Maps
918 </a>
919 </li>
920
921
922
923
924
925
926
927
928
f2d0508c
WG
929 <li class="md-nav__item">
930 <a href="../../../javascript/components_pagination/" class="md-nav__link">
931 Pagination
932 </a>
933 </li>
934
935
936
937
9f399714
WG
938 </ul>
939 </nav>
940 </li>
941
942
943
944
945
946
947
948
949
950
951 <li class="md-nav__item md-nav__item--nested">
952
953
9f399714
WG
954
955
51b70eee 956 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
9f399714
WG
957
958
e02609d6 959
51b70eee 960 <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
9aa5da67
WG
961 New API
962 <span class="md-nav__icon md-icon"></span>
963 </label>
964
51b70eee 965 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
9f399714 966 <label class="md-nav__title" for="__nav_4_4">
9aa5da67
WG
967 <span class="md-nav__icon md-icon"></span>
968 New API
969 </label>
970 <ul class="md-nav__list" data-md-scrollfix>
971
972
973
974
975
976
977 <li class="md-nav__item">
978 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
979 Writing a module
980 </a>
981 </li>
982
983
984
985
986
987
988
989
990
9aa5da67
WG
991 <li class="md-nav__item">
992 <a href="../../../javascript/new-api_core/" class="md-nav__link">
993 Core Functions
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_dom/" class="md-nav__link">
1007 DOM
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_events/" class="md-nav__link">
1021 Event Handling
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_ajax/" class="md-nav__link">
1035 Ajax
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_dialogs/" class="md-nav__link">
1049 Dialogs
1050 </a>
1051 </li>
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061 <li class="md-nav__item">
1062 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1063 Browser and Screen Sizes
1064 </a>
1065 </li>
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075 <li class="md-nav__item">
1076 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1077 User Interface
1078 </a>
1079 </li>
1080
1081
1082
1083
1084 </ul>
1085 </nav>
1086 </li>
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096 <li class="md-nav__item">
1097 <a href="../../../javascript/legacy-api/" class="md-nav__link">
1098 Legacy API
1099 </a>
1100 </li>
1101
1102
1103
1104
1105
1106
1107
1108
1109
9aa5da67
WG
1110 <li class="md-nav__item">
1111 <a href="../../../javascript/code-snippets/" class="md-nav__link">
1112 Code Snippets
1113 </a>
1114 </li>
1115
1116
1117
1118
1119 </ul>
1120 </nav>
1121 </li>
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1136
1137
9aa5da67
WG
1138
1139
51b70eee 1140 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
e02609d6 1141
9aa5da67
WG
1142
1143
51b70eee 1144 <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
9aa5da67
WG
1145 Package Components
1146 <span class="md-nav__icon md-icon"></span>
1147 </label>
1148
51b70eee 1149 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
9aa5da67
WG
1150 <label class="md-nav__title" for="__nav_5">
1151 <span class="md-nav__icon md-icon"></span>
1152 Package Components
1153 </label>
1154 <ul class="md-nav__list" data-md-scrollfix>
1155
1156
1157
1158
1159
1160
1161 <li class="md-nav__item">
1162 <a href="../../package-xml/" class="md-nav__link">
1163 package.xml
1164 </a>
1165 </li>
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1179
1180
9aa5da67
WG
1181
1182
51b70eee 1183 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" checked>
9aa5da67
WG
1184
1185
e02609d6 1186
51b70eee 1187 <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
9aa5da67
WG
1188 PIPs
1189 <span class="md-nav__icon md-icon"></span>
1190 </label>
1191
51b70eee 1192 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="true">
9aa5da67
WG
1193 <label class="md-nav__title" for="__nav_5_2">
1194 <span class="md-nav__icon md-icon"></span>
1195 PIPs
1196 </label>
1197 <ul class="md-nav__list" data-md-scrollfix>
1198
1199
1200
1201
1202
1203
1204 <li class="md-nav__item">
1205 <a href="../" class="md-nav__link">
1206 Overview
1207 </a>
1208 </li>
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218 <li class="md-nav__item">
1219 <a href="../acl-option/" class="md-nav__link">
1220 aclOption
1221 </a>
1222 </li>
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232 <li class="md-nav__item">
1233 <a href="../acp-menu/" class="md-nav__link">
1234 acpMenu
1235 </a>
1236 </li>
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246 <li class="md-nav__item">
1247 <a href="../acp-search-provider/" class="md-nav__link">
1248 acpSearchProvider
1249 </a>
1250 </li>
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260 <li class="md-nav__item">
1261 <a href="../acp-template/" class="md-nav__link">
1262 acpTemplate
1263 </a>
1264 </li>
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274 <li class="md-nav__item">
1275 <a href="../acp-template-delete/" class="md-nav__link">
1276 acpTemplateDelete
1277 </a>
1278 </li>
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288 <li class="md-nav__item">
1289 <a href="../bbcode/" class="md-nav__link">
1290 bbcode
1291 </a>
1292 </li>
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302 <li class="md-nav__item">
1303 <a href="../box/" class="md-nav__link">
1304 box
1305 </a>
1306 </li>
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316 <li class="md-nav__item">
1317 <a href="../clipboard-action/" class="md-nav__link">
1318 clipboardAction
1319 </a>
1320 </li>
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330 <li class="md-nav__item">
1331 <a href="../core-object/" class="md-nav__link">
1332 coreObject
1333 </a>
1334 </li>
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344 <li class="md-nav__item">
1345 <a href="../cronjob/" class="md-nav__link">
1346 cronjob
1347 </a>
1348 </li>
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358 <li class="md-nav__item">
1359 <a href="../database/" class="md-nav__link">
1360 database
1361 </a>
1362 </li>
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372 <li class="md-nav__item">
1373 <a href="../event-listener/" class="md-nav__link">
1374 eventListener
1375 </a>
1376 </li>
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386 <li class="md-nav__item">
1387 <a href="../file/" class="md-nav__link">
1388 file
1389 </a>
1390 </li>
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400 <li class="md-nav__item">
1401 <a href="../file-delete/" class="md-nav__link">
1402 fileDelete
1403 </a>
1404 </li>
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414 <li class="md-nav__item">
1415 <a href="../language/" class="md-nav__link">
1416 language
1417 </a>
1418 </li>
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428 <li class="md-nav__item">
1429 <a href="../media-provider/" class="md-nav__link">
1430 mediaProvider
1431 </a>
1432 </li>
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442 <li class="md-nav__item">
1443 <a href="../menu/" class="md-nav__link">
1444 menu
1445 </a>
1446 </li>
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456 <li class="md-nav__item">
1457 <a href="../menu-item/" class="md-nav__link">
1458 menuItem
1459 </a>
1460 </li>
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470 <li class="md-nav__item">
1471 <a href="../object-type/" class="md-nav__link">
1472 objectType
1473 </a>
1474 </li>
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484 <li class="md-nav__item">
1485 <a href="../object-type-definition/" class="md-nav__link">
1486 objectTypeDefinition
1487 </a>
1488 </li>
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498 <li class="md-nav__item">
1499 <a href="../option/" class="md-nav__link">
1500 option
1501 </a>
1502 </li>
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512 <li class="md-nav__item">
1513 <a href="../page/" class="md-nav__link">
1514 page
1515 </a>
1516 </li>
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526 <li class="md-nav__item">
1527 <a href="../pip/" class="md-nav__link">
1528 pip
1529 </a>
1530 </li>
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540 <li class="md-nav__item">
1541 <a href="../script/" class="md-nav__link">
1542 script
1543 </a>
1544 </li>
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554 <li class="md-nav__item">
1555 <a href="../smiley/" class="md-nav__link">
1556 smiley
1557 </a>
1558 </li>
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568 <li class="md-nav__item">
1569 <a href="../sql/" class="md-nav__link">
1570 sql
1571 </a>
1572 </li>
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582 <li class="md-nav__item">
1583 <a href="../style/" class="md-nav__link">
1584 style
1585 </a>
1586 </li>
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596 <li class="md-nav__item">
1597 <a href="../template/" class="md-nav__link">
1598 template
1599 </a>
1600 </li>
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610 <li class="md-nav__item">
1611 <a href="../template-delete/" class="md-nav__link">
1612 templateDelete
1613 </a>
1614 </li>
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624 <li class="md-nav__item">
1625 <a href="../template-listener/" class="md-nav__link">
1626 templateListener
1627 </a>
1628 </li>
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638 <li class="md-nav__item">
1639 <a href="../user-group-option/" class="md-nav__link">
1640 userGroupOption
1641 </a>
1642 </li>
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654 <li class="md-nav__item md-nav__item--active">
1655
51b70eee 1656 <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
9aa5da67
WG
1657
1658
1659
1660
1661
1662 <label class="md-nav__link md-nav__link--active" for="__toc">
1663 userMenu
1664 <span class="md-nav__icon md-icon"></span>
1665 </label>
1666
1667 <a href="./" class="md-nav__link md-nav__link--active">
1668 userMenu
1669 </a>
1670
1671
1672
1673<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1674
1675
1676
1677
1678
1679
1680 <label class="md-nav__title" for="__toc">
1681 <span class="md-nav__icon md-icon"></span>
1682 Table of contents
1683 </label>
1684 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1685
1686 <li class="md-nav__item">
1687 <a href="#components" class="md-nav__link">
1688 Components
1689 </a>
1690
1691 <nav class="md-nav" aria-label="Components">
1692 <ul class="md-nav__list">
1693
1694 <li class="md-nav__item">
1695 <a href="#parent" class="md-nav__link">
1696 &lt;parent&gt;
1697 </a>
1698
1699</li>
1700
1701 <li class="md-nav__item">
1702 <a href="#showorder" class="md-nav__link">
1703 &lt;showorder&gt;
1704 </a>
1705
1706</li>
1707
1708 <li class="md-nav__item">
1709 <a href="#controller" class="md-nav__link">
1710 &lt;controller&gt;
1711 </a>
1712
1713</li>
1714
1715 <li class="md-nav__item">
1716 <a href="#link" class="md-nav__link">
1717 &lt;link&gt;
1718 </a>
1719
1720</li>
1721
1722 <li class="md-nav__item">
1723 <a href="#iconclassname" class="md-nav__link">
1724 &lt;iconclassname&gt;
1725 </a>
1726
1727</li>
1728
1729 <li class="md-nav__item">
1730 <a href="#options" class="md-nav__link">
1731 &lt;options&gt;
1732 </a>
1733
1734</li>
1735
1736 <li class="md-nav__item">
1737 <a href="#permissions" class="md-nav__link">
1738 &lt;permissions&gt;
1739 </a>
1740
1741</li>
1742
1743 <li class="md-nav__item">
1744 <a href="#classname" class="md-nav__link">
1745 &lt;classname&gt;
1746 </a>
1747
1748</li>
1749
1750 </ul>
1751 </nav>
1752
1753</li>
1754
1755 <li class="md-nav__item">
1756 <a href="#example" class="md-nav__link">
1757 Example
1758 </a>
1759
1760</li>
1761
1762 </ul>
1763
1764</nav>
1765
1766 </li>
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776 <li class="md-nav__item">
1777 <a href="../user-notification-event/" class="md-nav__link">
1778 userNotificationEvent
1779 </a>
1780 </li>
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790 <li class="md-nav__item">
1791 <a href="../user-option/" class="md-nav__link">
1792 userOption
1793 </a>
1794 </li>
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804 <li class="md-nav__item">
1805 <a href="../user-profile-menu/" class="md-nav__link">
1806 userProfileMenu
1807 </a>
1808 </li>
1809
1810
1811
1812
1813 </ul>
1814 </nav>
1815 </li>
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825 <li class="md-nav__item">
1826 <a href="../../database-php-api/" class="md-nav__link">
1827 Database PHP API
1828 </a>
1829 </li>
1830
1831
1832
1833
1834 </ul>
1835 </nav>
1836 </li>
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848 <li class="md-nav__item md-nav__item--nested">
1849
1850
9aa5da67
WG
1851
1852
51b70eee 1853 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
e02609d6 1854
9aa5da67
WG
1855
1856
51b70eee 1857 <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
9aa5da67
WG
1858 Migration
1859 <span class="md-nav__icon md-icon"></span>
1860 </label>
1861
51b70eee 1862 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
9aa5da67
WG
1863 <label class="md-nav__title" for="__nav_6">
1864 <span class="md-nav__icon md-icon"></span>
1865 Migration
1866 </label>
1867 <ul class="md-nav__list" data-md-scrollfix>
1868
1869
1870
1871
1872
1873
1874
1875 <li class="md-nav__item md-nav__item--nested">
1876
1877
9aa5da67
WG
1878
1879
51b70eee 1880 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
e02609d6 1881
9aa5da67
WG
1882
1883
51b70eee 1884 <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
9aa5da67
WG
1885 From WoltLab Suite 5.5
1886 <span class="md-nav__icon md-icon"></span>
1887 </label>
1888
51b70eee 1889 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
9aa5da67
WG
1890 <label class="md-nav__title" for="__nav_6_1">
1891 <span class="md-nav__icon md-icon"></span>
1892 From WoltLab Suite 5.5
1893 </label>
1894 <ul class="md-nav__list" data-md-scrollfix>
1895
1896
1897
1898
1899
1900
1901 <li class="md-nav__item">
1902 <a href="../../../migration/wsc55/php/" class="md-nav__link">
1903 PHP API
1904 </a>
1905 </li>
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915 <li class="md-nav__item">
1916 <a href="../../../migration/wsc55/javascript/" class="md-nav__link">
1917 TypeScript and JavaScript
1918 </a>
1919 </li>
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929 <li class="md-nav__item">
1930 <a href="../../../migration/wsc55/templates/" class="md-nav__link">
1931 Templates
1932 </a>
1933 </li>
1934
1935
1936
1937
1938
1939
1940
1941
1942
024038ef
WG
1943 <li class="md-nav__item">
1944 <a href="../../../migration/wsc55/icons/" class="md-nav__link">
1945 Icons
1946 </a>
1947 </li>
1948
1949
1950
1951
1952
1953
1954
1955
1956
6d611e8a
WG
1957 <li class="md-nav__item">
1958 <a href="../../../migration/wsc55/dialogs/" class="md-nav__link">
1959 Dialogs
1960 </a>
1961 </li>
1962
1963
1964
1965
1966
1967
1968
1969
1970
9aa5da67
WG
1971 <li class="md-nav__item">
1972 <a href="../../../migration/wsc55/libraries/" class="md-nav__link">
1973 Third Party Libraries
1974 </a>
1975 </li>
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985 <li class="md-nav__item">
1986 <a href="../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1987 Deprecations and Removals
1988 </a>
1989 </li>
1990
1991
1992
1993
1994 </ul>
1995 </nav>
1996 </li>
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007 <li class="md-nav__item md-nav__item--nested">
2008
2009
9aa5da67
WG
2010
2011
51b70eee 2012 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
9aa5da67
WG
2013
2014
e02609d6 2015
51b70eee 2016 <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
9aa5da67
WG
2017 From WoltLab Suite 5.4
2018 <span class="md-nav__icon md-icon"></span>
2019 </label>
2020
51b70eee 2021 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
9aa5da67
WG
2022 <label class="md-nav__title" for="__nav_6_2">
2023 <span class="md-nav__icon md-icon"></span>
2024 From WoltLab Suite 5.4
2025 </label>
2026 <ul class="md-nav__list" data-md-scrollfix>
2027
2028
2029
2030
2031
2032
2033 <li class="md-nav__item">
2034 <a href="../../../migration/wsc54/php/" class="md-nav__link">
2035 PHP API
2036 </a>
2037 </li>
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047 <li class="md-nav__item">
2048 <a href="../../../migration/wsc54/javascript/" class="md-nav__link">
2049 TypeScript and JavaScript
2050 </a>
2051 </li>
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061 <li class="md-nav__item">
2062 <a href="../../../migration/wsc54/templates/" class="md-nav__link">
2063 Templates
2064 </a>
2065 </li>
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075 <li class="md-nav__item">
2076 <a href="../../../migration/wsc54/libraries/" class="md-nav__link">
2077 Third Party Libraries
2078 </a>
2079 </li>
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089 <li class="md-nav__item">
2090 <a href="../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2091 Deprecations and Removals
2092 </a>
2093 </li>
2094
2095
2096
2097
2098 </ul>
2099 </nav>
2100 </li>
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111 <li class="md-nav__item md-nav__item--nested">
2112
2113
9aa5da67
WG
2114
2115
51b70eee 2116 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
e02609d6 2117
9aa5da67
WG
2118
2119
51b70eee 2120 <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
9aa5da67
WG
2121 From WoltLab Suite 5.3
2122 <span class="md-nav__icon md-icon"></span>
2123 </label>
2124
51b70eee 2125 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
9aa5da67
WG
2126 <label class="md-nav__title" for="__nav_6_3">
2127 <span class="md-nav__icon md-icon"></span>
2128 From WoltLab Suite 5.3
2129 </label>
2130 <ul class="md-nav__list" data-md-scrollfix>
2131
2132
2133
2134
2135
2136
2137 <li class="md-nav__item">
2138 <a href="../../../migration/wsc53/php/" class="md-nav__link">
2139 PHP API
2140 </a>
2141 </li>
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151 <li class="md-nav__item">
2152 <a href="../../../migration/wsc53/session/" class="md-nav__link">
2153 Session Handling and Authentication
2154 </a>
2155 </li>
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165 <li class="md-nav__item">
2166 <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
2167 TypeScript and JavaScript
2168 </a>
2169 </li>
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179 <li class="md-nav__item">
2180 <a href="../../../migration/wsc53/templates/" class="md-nav__link">
2181 Templates
2182 </a>
2183 </li>
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193 <li class="md-nav__item">
2194 <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
2195 Third Party Libraries
2196 </a>
2197 </li>
2198
2199
2200
2201
2202 </ul>
2203 </nav>
2204 </li>
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215 <li class="md-nav__item md-nav__item--nested">
2216
2217
9aa5da67
WG
2218
2219
51b70eee 2220 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
e02609d6 2221
9aa5da67
WG
2222
2223
51b70eee 2224 <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
9aa5da67
WG
2225 From WoltLab Suite 5.2
2226 <span class="md-nav__icon md-icon"></span>
2227 </label>
2228
51b70eee 2229 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
9aa5da67
WG
2230 <label class="md-nav__title" for="__nav_6_4">
2231 <span class="md-nav__icon md-icon"></span>
2232 From WoltLab Suite 5.2
2233 </label>
2234 <ul class="md-nav__list" data-md-scrollfix>
2235
2236
2237
2238
2239
2240
2241 <li class="md-nav__item">
2242 <a href="../../../migration/wsc52/php/" class="md-nav__link">
2243 PHP API
2244 </a>
2245 </li>
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255 <li class="md-nav__item">
2256 <a href="../../../migration/wsc52/templates/" class="md-nav__link">
2257 Templates and Languages
2258 </a>
2259 </li>
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269 <li class="md-nav__item">
2270 <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
2271 Third Party Libraries
2272 </a>
2273 </li>
2274
2275
2276
2277
2278 </ul>
2279 </nav>
2280 </li>
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291 <li class="md-nav__item md-nav__item--nested">
2292
2293
9aa5da67
WG
2294
2295
51b70eee 2296 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
9aa5da67
WG
2297
2298
e02609d6 2299
51b70eee 2300 <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
9aa5da67
WG
2301 From WoltLab Suite 3.1
2302 <span class="md-nav__icon md-icon"></span>
2303 </label>
2304
51b70eee 2305 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
9aa5da67
WG
2306 <label class="md-nav__title" for="__nav_6_5">
2307 <span class="md-nav__icon md-icon"></span>
2308 From WoltLab Suite 3.1
2309 </label>
2310 <ul class="md-nav__list" data-md-scrollfix>
2311
2312
2313
2314
2315
2316
2317 <li class="md-nav__item">
2318 <a href="../../../migration/wsc31/php/" class="md-nav__link">
2319 PHP API
2320 </a>
2321 </li>
2322
2323
2324
2325
2326 </ul>
2327 </nav>
2328 </li>
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339 <li class="md-nav__item md-nav__item--nested">
2340
2341
9aa5da67
WG
2342
2343
51b70eee 2344 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
e02609d6 2345
9aa5da67
WG
2346
2347
51b70eee 2348 <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
9aa5da67
WG
2349 From WoltLab Suite 3.0
2350 <span class="md-nav__icon md-icon"></span>
2351 </label>
2352
51b70eee 2353 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
9aa5da67
WG
2354 <label class="md-nav__title" for="__nav_6_6">
2355 <span class="md-nav__icon md-icon"></span>
2356 From WoltLab Suite 3.0
2357 </label>
2358 <ul class="md-nav__list" data-md-scrollfix>
2359
2360
2361
2362
2363
2364
2365 <li class="md-nav__item">
2366 <a href="../../../migration/wsc30/php/" class="md-nav__link">
2367 PHP API
2368 </a>
2369 </li>
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379 <li class="md-nav__item">
2380 <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
2381 JavaScript API
2382 </a>
2383 </li>
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393 <li class="md-nav__item">
2394 <a href="../../../migration/wsc30/templates/" class="md-nav__link">
2395 Templates
2396 </a>
2397 </li>
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407 <li class="md-nav__item">
2408 <a href="../../../migration/wsc30/css/" class="md-nav__link">
2409 CSS
2410 </a>
2411 </li>
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421 <li class="md-nav__item">
2422 <a href="../../../migration/wsc30/package/" class="md-nav__link">
2423 Package Components
2424 </a>
2425 </li>
2426
2427
2428
2429
2430 </ul>
2431 </nav>
2432 </li>
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443 <li class="md-nav__item md-nav__item--nested">
2444
2445
9aa5da67
WG
2446
2447
51b70eee 2448 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
e02609d6 2449
9aa5da67
WG
2450
2451
51b70eee 2452 <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
9aa5da67
WG
2453 From WCF 2.1
2454 <span class="md-nav__icon md-icon"></span>
2455 </label>
2456
51b70eee 2457 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
9aa5da67
WG
2458 <label class="md-nav__title" for="__nav_6_7">
2459 <span class="md-nav__icon md-icon"></span>
2460 From WCF 2.1
2461 </label>
2462 <ul class="md-nav__list" data-md-scrollfix>
2463
2464
2465
2466
2467
2468
2469 <li class="md-nav__item">
2470 <a href="../../../migration/wcf21/php/" class="md-nav__link">
2471 PHP API
2472 </a>
2473 </li>
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483 <li class="md-nav__item">
2484 <a href="../../../migration/wcf21/templates/" class="md-nav__link">
2485 Templates
2486 </a>
2487 </li>
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497 <li class="md-nav__item">
2498 <a href="../../../migration/wcf21/css/" class="md-nav__link">
2499 CSS
2500 </a>
2501 </li>
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511 <li class="md-nav__item">
2512 <a href="../../../migration/wcf21/package/" class="md-nav__link">
2513 Package Components
2514 </a>
2515 </li>
2516
2517
2518
2519
2520 </ul>
2521 </nav>
2522 </li>
2523
2524
2525
2526
2527 </ul>
2528 </nav>
2529 </li>
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541 <li class="md-nav__item md-nav__item--nested">
2542
2543
9aa5da67
WG
2544
2545
51b70eee 2546 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
9aa5da67
WG
2547
2548
e02609d6 2549
51b70eee 2550 <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
9aa5da67
WG
2551 Tutorials
2552 <span class="md-nav__icon md-icon"></span>
2553 </label>
2554
51b70eee 2555 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
9aa5da67
WG
2556 <label class="md-nav__title" for="__nav_7">
2557 <span class="md-nav__icon md-icon"></span>
2558 Tutorials
2559 </label>
2560 <ul class="md-nav__list" data-md-scrollfix>
2561
2562
2563
2564
2565
2566
2567
2568 <li class="md-nav__item md-nav__item--nested">
2569
2570
9aa5da67
WG
2571
2572
51b70eee 2573 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
e02609d6 2574
9aa5da67
WG
2575
2576
51b70eee 2577 <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
9aa5da67
WG
2578 Tutorial Series
2579 <span class="md-nav__icon md-icon"></span>
2580 </label>
2581
51b70eee 2582 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
9aa5da67
WG
2583 <label class="md-nav__title" for="__nav_7_1">
2584 <span class="md-nav__icon md-icon"></span>
2585 Tutorial Series
2586 </label>
2587 <ul class="md-nav__list" data-md-scrollfix>
2588
2589
2590
2591
2592
2593
2594 <li class="md-nav__item">
2595 <a href="../../../tutorial/series/overview/" class="md-nav__link">
2596 Overview
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_1/" class="md-nav__link">
2610 Part 1
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_2/" class="md-nav__link">
2624 Part 2
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_3/" class="md-nav__link">
2638 Part 3
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_4/" class="md-nav__link">
2652 Part 4
2653 </a>
2654 </li>
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664 <li class="md-nav__item">
2665 <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2666 Part 5
2667 </a>
2668 </li>
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678 <li class="md-nav__item">
2679 <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2680 Part 6
2681 </a>
2682 </li>
2683
2684
2685
2686
2687 </ul>
2688 </nav>
2689 </li>
2690
2691
2692
2693
2694 </ul>
2695 </nav>
2696 </li>
2697
2698
2699
2700 </ul>
2701</nav>
2702 </div>
2703 </div>
2704 </div>
2705
2706
2707
2708 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2709 <div class="md-sidebar__scrollwrap">
2710 <div class="md-sidebar__inner">
2711
2712
2713<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2714
2715
2716
2717
2718
2719
2720 <label class="md-nav__title" for="__toc">
2721 <span class="md-nav__icon md-icon"></span>
2722 Table of contents
2723 </label>
2724 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2725
2726 <li class="md-nav__item">
2727 <a href="#components" class="md-nav__link">
2728 Components
2729 </a>
2730
2731 <nav class="md-nav" aria-label="Components">
2732 <ul class="md-nav__list">
2733
2734 <li class="md-nav__item">
2735 <a href="#parent" class="md-nav__link">
2736 &lt;parent&gt;
2737 </a>
2738
2739</li>
2740
2741 <li class="md-nav__item">
2742 <a href="#showorder" class="md-nav__link">
2743 &lt;showorder&gt;
2744 </a>
2745
2746</li>
2747
2748 <li class="md-nav__item">
2749 <a href="#controller" class="md-nav__link">
2750 &lt;controller&gt;
2751 </a>
2752
2753</li>
2754
2755 <li class="md-nav__item">
2756 <a href="#link" class="md-nav__link">
2757 &lt;link&gt;
2758 </a>
2759
2760</li>
2761
2762 <li class="md-nav__item">
2763 <a href="#iconclassname" class="md-nav__link">
2764 &lt;iconclassname&gt;
2765 </a>
2766
2767</li>
2768
2769 <li class="md-nav__item">
2770 <a href="#options" class="md-nav__link">
2771 &lt;options&gt;
2772 </a>
2773
2774</li>
2775
2776 <li class="md-nav__item">
2777 <a href="#permissions" class="md-nav__link">
2778 &lt;permissions&gt;
2779 </a>
2780
2781</li>
2782
2783 <li class="md-nav__item">
2784 <a href="#classname" class="md-nav__link">
2785 &lt;classname&gt;
2786 </a>
2787
2788</li>
2789
2790 </ul>
2791 </nav>
2792
2793</li>
2794
2795 <li class="md-nav__item">
2796 <a href="#example" class="md-nav__link">
2797 Example
2798 </a>
2799
2800</li>
2801
2802 </ul>
2803
2804</nav>
2805 </div>
2806 </div>
2807 </div>
2808
2809
7f9945cf
WG
2810
2811 <div class="md-content" data-md-component="content">
2812 <article class="md-content__inner md-typeset">
9aa5da67 2813
7f9945cf
WG
2814
2815
e02609d6
WG
2816
2817
2818
9aa5da67 2819
9aa5da67
WG
2820<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>
2821<p>Registers new user menu items.</p>
2822<h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
2823<p>Each item is described as an <code>&lt;usermenuitem&gt;</code> element with the mandatory attribute <code>name</code>.</p>
2824<h3 id="parent"><code>&lt;parent&gt;</code><a class="headerlink" href="#parent" title="Permanent link">#</a></h3>
2825<p><span class="label label-info">Optional</span></p>
2826<p>The item’s parent item.</p>
2827<h3 id="showorder"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder" title="Permanent link">#</a></h3>
2828<p><span class="label label-info">Optional</span></p>
2829<p>Specifies the order of this item within the parent item.</p>
2830<h3 id="controller"><code>&lt;controller&gt;</code><a class="headerlink" href="#controller" title="Permanent link">#</a></h3>
2831<p>The fully qualified class name of the target controller.
2832If not specified this item serves as a category.</p>
2833<h3 id="link"><code>&lt;link&gt;</code><a class="headerlink" href="#link" title="Permanent link">#</a></h3>
2834<p>Additional components if <code>&lt;controller&gt;</code> is set,
2835the full external link otherwise.</p>
2836<h3 id="iconclassname"><code>&lt;iconclassname&gt;</code><a class="headerlink" href="#iconclassname" title="Permanent link">#</a></h3>
2837<div class="admonition info">
2838<p class="admonition-title">Use an icon only for top-level items.</p>
2839</div>
2840<p>Name of the Font Awesome icon class.</p>
2841<h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2842<p><span class="label label-info">Optional</span></p>
2843<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>
2844<h3 id="permissions"><code>&lt;permissions&gt;</code><a class="headerlink" href="#permissions" title="Permanent link">#</a></h3>
2845<p><span class="label label-info">Optional</span></p>
2846<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>
2847<h3 id="classname"><code>&lt;classname&gt;</code><a class="headerlink" href="#classname" title="Permanent link">#</a></h3>
2848<p>The name of the class providing the user menu item’s behaviour,
2849the class has to implement the <code>wcf\system\menu\user\IUserMenuItemProvider</code> interface.</p>
2850<h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2851<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>
2852<span class="normal"> 2</span>
2853<span class="normal"> 3</span>
2854<span class="normal"> 4</span>
2855<span class="normal"> 5</span>
2856<span class="normal"> 6</span>
2857<span class="normal"> 7</span>
2858<span class="normal"> 8</span>
2859<span class="normal"> 9</span>
2860<span class="normal">10</span>
2861<span class="normal">11</span>
2862<span class="normal">12</span>
2863<span class="normal">13</span>
2864<span class="normal">14</span>
2865<span class="normal">15</span>
2866<span class="normal">16</span>
2867<span class="normal">17</span>
2868<span class="normal">18</span>
2869<span class="normal">19</span>
2870<span class="normal">20</span>
2871<span class="normal">21</span>
2872<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
2873<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>
2874<span class="w"> </span><span class="nt">&lt;import&gt;</span>
2875<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>
2876<span class="w"> </span><span class="nt">&lt;iconclassname&gt;</span>fa-home<span class="nt">&lt;/iconclassname&gt;</span>
2877<span class="w"> </span><span class="nt">&lt;/usermenuitem&gt;</span>
2878
2879<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>
2880<span class="w"> </span><span class="nt">&lt;controller&gt;</span>wcf\page\FooBarListPage<span class="nt">&lt;/controller&gt;</span>
2881<span class="w"> </span><span class="nt">&lt;parent&gt;</span>wcf.user.menu.foo<span class="nt">&lt;/parent&gt;</span>
2882<span class="w"> </span><span class="nt">&lt;permissions&gt;</span>user.foo.canBar<span class="nt">&lt;/permissions&gt;</span>
2883<span class="w"> </span><span class="nt">&lt;classname&gt;</span>wcf\system\menu\user\FooBarMenuItemProvider<span class="nt">&lt;/classname&gt;</span>
2884<span class="w"> </span><span class="nt">&lt;/usermenuitem&gt;</span>
2885
2886<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>
2887<span class="w"> </span><span class="nt">&lt;controller&gt;</span>wcf\page\FooBazListPage<span class="nt">&lt;/controller&gt;</span>
2888<span class="w"> </span><span class="nt">&lt;parent&gt;</span>wcf.user.menu.foo<span class="nt">&lt;/parent&gt;</span>
2889<span class="w"> </span><span class="nt">&lt;permissions&gt;</span>user.foo.canBaz<span class="nt">&lt;/permissions&gt;</span>
2890<span class="w"> </span><span class="nt">&lt;options&gt;</span>module_foo_bar<span class="nt">&lt;/options&gt;</span>
2891<span class="w"> </span><span class="nt">&lt;/usermenuitem&gt;</span>
2892<span class="w"> </span><span class="nt">&lt;/import&gt;</span>
9aa5da67
WG
2893<span class="nt">&lt;/data&gt;</span>
2894</code></pre></div></td></tr></table></div>
2895
2896 <hr>
2897<div class="md-source-file">
2898 <small>
2899
2900 Last update:
2901 2021-04-23
2902
2903 </small>
2904</div>
2905
a06fd3b1
WG
2906
2907
2908
7f9945cf
WG
2909
2910
2911 </article>
2912 </div>
2913
2914
9aa5da67
WG
2915 </div>
2916
2917 </main>
2918
2919 <footer class="md-footer">
2920
9aa5da67
WG
2921 <div class="md-footer-meta md-typeset">
2922 <div class="md-footer-meta__inner md-grid">
2923 <div class="md-copyright">
2924
2925 <div class="md-copyright__highlight">
2926 Copyright © 2020 WoltLab GmbH
2927 </div>
2928
2929
2930 Made with
2931 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2932 Material for MkDocs
2933 </a>
2934
2935</div>
2936
2937 <div class="md-copyright">
2938 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2939 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2940</div>
2941
2942 </div>
2943 </div>
2944</footer>
2945
2946 </div>
2947 <div class="md-dialog" data-md-component="dialog">
2948 <div class="md-dialog__inner md-typeset"></div>
2949 </div>
a06fd3b1 2950
e06c8b5f 2951 <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.74e28a9f.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
2952
2953
e06c8b5f 2954 <script src="../../../assets/javascripts/bundle.220ee61c.min.js"></script>
9aa5da67
WG
2955
2956
2957 </body>
2958</html>