5.4/package/pip/user-menu/index.html

   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
  12       <link rel="icon" href="../../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0">
  14
  15
  16
  17         <title>userMenu - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../../assets/stylesheets/main.33e2939f.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  39
  40
  41
  42
  43
  44   </head>
  45
  46
  47
  48
  49
  50
  51
  52     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  53
  54
  55     <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  56
  57     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  58     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  59     <label class="md-overlay" for="__drawer"></label>
  60     <div data-md-component="skip">
  61
  62
  63         <a href="#user-menu-package-installation-plugin" class="md-skip">
  64           Skip to content
  65         </a>
  66
  67     </div>
  68     <div data-md-component="announce">
  69
  70         <aside class="md-announce">
  71           <div class="md-announce__inner md-grid md-typeset">
  72
  73     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  74
  75           </div>
  76         </aside>
  77
  78     </div>
  79
  80       <header class="md-header" data-md-component="header">
  81   <nav class="md-header__inner md-grid" aria-label="Header">
  82     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  83
  84   <img src="../../../assets/logo.png" alt="logo">
  85
  86     </a>
  87     <label class="md-header__button md-icon" for="__drawer">
  88       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  89     </label>
  90     <div class="md-header__title" data-md-component="header-title">
  91       <div class="md-header__ellipsis">
  92         <div class="md-header__topic">
  93           <span class="md-ellipsis">
  94             WoltLab Suite Documentation
  95           </span>
  96         </div>
  97         <div class="md-header__topic" data-md-component="header-topic">
  98           <span class="md-ellipsis">
  99
 100               userMenu
 101
 102           </span>
 103         </div>
 104       </div>
 105     </div>
 106
 107
 108
 109       <label class="md-header__button md-icon" for="__search">
 110         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 111       </label>
 112
 113 <div class="md-search" data-md-component="search" role="dialog">
 114   <label class="md-search__overlay" for="__search"></label>
 115   <div class="md-search__inner" role="search">
 116     <form class="md-search__form" name="search">
 117       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
 118       <label class="md-search__icon md-icon" for="__search">
 119         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 120         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
 121       </label>
 122       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 123         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
 124       </button>
 125     </form>
 126     <div class="md-search__output">
 127       <div class="md-search__scrollwrap" data-md-scrollfix>
 128         <div class="md-search-result" data-md-component="search-result">
 129           <div class="md-search-result__meta">
 130             Initializing search
 131           </div>
 132           <ol class="md-search-result__list"></ol>
 133         </div>
 134       </div>
 135     </div>
 136   </div>
 137 </div>
 138
 139
 140       <div class="md-header__source">
 141
 142 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 143   <div class="md-source__icon md-icon">
 144
 145     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 146   </div>
 147   <div class="md-source__repository">
 148     GitHub
 149   </div>
 150 </a>
 151       </div>
 152
 153   </nav>
 154 </header>
 155
 156     <div class="md-container" data-md-component="container">
 157
 158
 159
 160
 161       <main class="md-main" data-md-component="main">
 162         <div class="md-main__inner md-grid">
 163
 164
 165
 166               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 167                 <div class="md-sidebar__scrollwrap">
 168                   <div class="md-sidebar__inner">
 169
 170
 171
 172 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 173   <label class="md-nav__title" for="__drawer">
 174     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 175
 176   <img src="../../../assets/logo.png" alt="logo">
 177
 178     </a>
 179     WoltLab Suite Documentation
 180   </label>
 181
 182     <div class="md-nav__source">
 183
 184 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 185   <div class="md-source__icon md-icon">
 186
 187     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 188   </div>
 189   <div class="md-source__repository">
 190     GitHub
 191   </div>
 192 </a>
 193     </div>
 194
 195   <ul class="md-nav__list" data-md-scrollfix>
 196
 197
 198
 199
 200
 201
 202
 203
 204     <li class="md-nav__item">
 205       <a href="../../../getting-started/" class="md-nav__link">
 206         Getting Started
 207       </a>
 208     </li>
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220     <li class="md-nav__item md-nav__item--nested">
 221
 222
 223         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 224
 225       <label class="md-nav__link" for="__nav_2">
 226         PHP API
 227         <span class="md-nav__icon md-icon"></span>
 228       </label>
 229       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 230         <label class="md-nav__title" for="__nav_2">
 231           <span class="md-nav__icon md-icon"></span>
 232           PHP API
 233         </label>
 234         <ul class="md-nav__list" data-md-scrollfix>
 235
 236
 237
 238
 239
 240     <li class="md-nav__item">
 241       <a href="../../../php/pages/" class="md-nav__link">
 242         Pages
 243       </a>
 244     </li>
 245
 246
 247
 248
 249
 250
 251
 252     <li class="md-nav__item">
 253       <a href="../../../php/database-objects/" class="md-nav__link">
 254         Database Objects
 255       </a>
 256     </li>
 257
 258
 259
 260
 261
 262
 263
 264     <li class="md-nav__item">
 265       <a href="../../../php/database-access/" class="md-nav__link">
 266         Database Access
 267       </a>
 268     </li>
 269
 270
 271
 272
 273
 274
 275
 276     <li class="md-nav__item">
 277       <a href="../../../php/exceptions/" class="md-nav__link">
 278         Exceptions
 279       </a>
 280     </li>
 281
 282
 283
 284
 285
 286
 287
 288
 289     <li class="md-nav__item md-nav__item--nested">
 290
 291
 292         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 293
 294       <label class="md-nav__link" for="__nav_2_5">
 295         API
 296         <span class="md-nav__icon md-icon"></span>
 297       </label>
 298       <nav class="md-nav" aria-label="API" data-md-level="2">
 299         <label class="md-nav__title" for="__nav_2_5">
 300           <span class="md-nav__icon md-icon"></span>
 301           API
 302         </label>
 303         <ul class="md-nav__list" data-md-scrollfix>
 304
 305
 306
 307
 308
 309     <li class="md-nav__item">
 310       <a href="../../../php/api/caches/" class="md-nav__link">
 311         Caches
 312       </a>
 313     </li>
 314
 315
 316
 317
 318
 319
 320
 321     <li class="md-nav__item">
 322       <a href="../../../php/api/comments/" class="md-nav__link">
 323         Comments
 324       </a>
 325     </li>
 326
 327
 328
 329
 330
 331
 332
 333     <li class="md-nav__item">
 334       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 335         Cronjobs
 336       </a>
 337     </li>
 338
 339
 340
 341
 342
 343
 344
 345     <li class="md-nav__item">
 346       <a href="../../../php/api/events/" class="md-nav__link">
 347         Events
 348       </a>
 349     </li>
 350
 351
 352
 353
 354
 355
 356
 357
 358     <li class="md-nav__item md-nav__item--nested">
 359
 360
 361         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 362
 363       <label class="md-nav__link" for="__nav_2_5_5">
 364         Form Builder
 365         <span class="md-nav__icon md-icon"></span>
 366       </label>
 367       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 368         <label class="md-nav__title" for="__nav_2_5_5">
 369           <span class="md-nav__icon md-icon"></span>
 370           Form Builder
 371         </label>
 372         <ul class="md-nav__list" data-md-scrollfix>
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390     <li class="md-nav__item">
 391       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 392         Structure
 393       </a>
 394     </li>
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 404         Fields
 405       </a>
 406     </li>
 407
 408
 409
 410
 411
 412
 413
 414     <li class="md-nav__item">
 415       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 416         Validation and Data
 417       </a>
 418     </li>
 419
 420
 421
 422
 423
 424
 425
 426     <li class="md-nav__item">
 427       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 428         Dependencies
 429       </a>
 430     </li>
 431
 432
 433
 434         </ul>
 435       </nav>
 436     </li>
 437
 438
 439
 440
 441
 442
 443
 444     <li class="md-nav__item">
 445       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 446         Package Installation Plugins
 447       </a>
 448     </li>
 449
 450
 451
 452
 453
 454
 455
 456     <li class="md-nav__item">
 457       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 458         User Activity Points
 459       </a>
 460     </li>
 461
 462
 463
 464
 465
 466
 467
 468     <li class="md-nav__item">
 469       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 470         User Notifications
 471       </a>
 472     </li>
 473
 474
 475
 476
 477
 478
 479
 480     <li class="md-nav__item">
 481       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 482         Sitemaps
 483       </a>
 484     </li>
 485
 486
 487
 488         </ul>
 489       </nav>
 490     </li>
 491
 492
 493
 494
 495
 496
 497
 498     <li class="md-nav__item">
 499       <a href="../../../php/code-style/" class="md-nav__link">
 500         Code Style
 501       </a>
 502     </li>
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../../php/apps/" class="md-nav__link">
 512         Apps
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522     <li class="md-nav__item">
 523       <a href="../../../php/gdpr/" class="md-nav__link">
 524         GDPR
 525       </a>
 526     </li>
 527
 528
 529
 530         </ul>
 531       </nav>
 532     </li>
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544     <li class="md-nav__item md-nav__item--nested">
 545
 546
 547         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 548
 549       <label class="md-nav__link" for="__nav_3">
 550         Languages, Templates & CSS
 551         <span class="md-nav__icon md-icon"></span>
 552       </label>
 553       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 554         <label class="md-nav__title" for="__nav_3">
 555           <span class="md-nav__icon md-icon"></span>
 556           Languages, Templates & CSS
 557         </label>
 558         <ul class="md-nav__list" data-md-scrollfix>
 559
 560
 561
 562
 563
 564     <li class="md-nav__item">
 565       <a href="../../../view/languages/" class="md-nav__link">
 566         Languages
 567       </a>
 568     </li>
 569
 570
 571
 572
 573
 574
 575
 576     <li class="md-nav__item">
 577       <a href="../../../view/templates/" class="md-nav__link">
 578         Templates
 579       </a>
 580     </li>
 581
 582
 583
 584
 585
 586
 587
 588     <li class="md-nav__item">
 589       <a href="../../../view/css/" class="md-nav__link">
 590         CSS
 591       </a>
 592     </li>
 593
 594
 595
 596         </ul>
 597       </nav>
 598     </li>
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610     <li class="md-nav__item md-nav__item--nested">
 611
 612
 613         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 614
 615       <label class="md-nav__link" for="__nav_4">
 616         JavaScript API
 617         <span class="md-nav__icon md-icon"></span>
 618       </label>
 619       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 620         <label class="md-nav__title" for="__nav_4">
 621           <span class="md-nav__icon md-icon"></span>
 622           JavaScript API
 623         </label>
 624         <ul class="md-nav__list" data-md-scrollfix>
 625
 626
 627
 628
 629
 630     <li class="md-nav__item">
 631       <a href="../../../javascript/general-usage/" class="md-nav__link">
 632         General Usage
 633       </a>
 634     </li>
 635
 636
 637
 638
 639
 640
 641
 642
 643     <li class="md-nav__item md-nav__item--nested">
 644
 645
 646         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 647
 648       <label class="md-nav__link" for="__nav_4_2">
 649         New API
 650         <span class="md-nav__icon md-icon"></span>
 651       </label>
 652       <nav class="md-nav" aria-label="New API" data-md-level="2">
 653         <label class="md-nav__title" for="__nav_4_2">
 654           <span class="md-nav__icon md-icon"></span>
 655           New API
 656         </label>
 657         <ul class="md-nav__list" data-md-scrollfix>
 658
 659
 660
 661
 662
 663     <li class="md-nav__item">
 664       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 665         Writing a module
 666       </a>
 667     </li>
 668
 669
 670
 671
 672
 673
 674
 675     <li class="md-nav__item">
 676       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 677         Data Structures
 678       </a>
 679     </li>
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item">
 688       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 689         Core Functions
 690       </a>
 691     </li>
 692
 693
 694
 695
 696
 697
 698
 699     <li class="md-nav__item">
 700       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 701         DOM
 702       </a>
 703     </li>
 704
 705
 706
 707
 708
 709
 710
 711     <li class="md-nav__item">
 712       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 713         Event Handling
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 725         Ajax
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735     <li class="md-nav__item">
 736       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 737         Dialogs
 738       </a>
 739     </li>
 740
 741
 742
 743
 744
 745
 746
 747     <li class="md-nav__item">
 748       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 749         Browser and Screen Sizes
 750       </a>
 751     </li>
 752
 753
 754
 755
 756
 757
 758
 759     <li class="md-nav__item">
 760       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 761         User Interface
 762       </a>
 763     </li>
 764
 765
 766
 767         </ul>
 768       </nav>
 769     </li>
 770
 771
 772
 773
 774
 775
 776
 777     <li class="md-nav__item">
 778       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 779         Legacy API
 780       </a>
 781     </li>
 782
 783
 784
 785
 786
 787
 788
 789     <li class="md-nav__item">
 790       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 791         Helper Functions
 792       </a>
 793     </li>
 794
 795
 796
 797
 798
 799
 800
 801     <li class="md-nav__item">
 802       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 803         Code Snippets
 804       </a>
 805     </li>
 806
 807
 808
 809         </ul>
 810       </nav>
 811     </li>
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 826
 827
 828         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 829
 830       <label class="md-nav__link" for="__nav_5">
 831         Package Components
 832         <span class="md-nav__icon md-icon"></span>
 833       </label>
 834       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 835         <label class="md-nav__title" for="__nav_5">
 836           <span class="md-nav__icon md-icon"></span>
 837           Package Components
 838         </label>
 839         <ul class="md-nav__list" data-md-scrollfix>
 840
 841
 842
 843
 844
 845     <li class="md-nav__item">
 846       <a href="../../package-xml/" class="md-nav__link">
 847         package.xml
 848       </a>
 849     </li>
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 861
 862
 863         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
 864
 865       <label class="md-nav__link" for="__nav_5_2">
 866         PIPs
 867         <span class="md-nav__icon md-icon"></span>
 868       </label>
 869       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 870         <label class="md-nav__title" for="__nav_5_2">
 871           <span class="md-nav__icon md-icon"></span>
 872           PIPs
 873         </label>
 874         <ul class="md-nav__list" data-md-scrollfix>
 875
 876
 877
 878
 879
 880     <li class="md-nav__item">
 881       <a href="../" class="md-nav__link">
 882         Overview
 883       </a>
 884     </li>
 885
 886
 887
 888
 889
 890
 891
 892     <li class="md-nav__item">
 893       <a href="../acl-option/" class="md-nav__link">
 894         aclOption
 895       </a>
 896     </li>
 897
 898
 899
 900
 901
 902
 903
 904     <li class="md-nav__item">
 905       <a href="../acp-menu/" class="md-nav__link">
 906         acpMenu
 907       </a>
 908     </li>
 909
 910
 911
 912
 913
 914
 915
 916     <li class="md-nav__item">
 917       <a href="../acp-search-provider/" class="md-nav__link">
 918         acpSearchProvider
 919       </a>
 920     </li>
 921
 922
 923
 924
 925
 926
 927
 928     <li class="md-nav__item">
 929       <a href="../acp-template/" class="md-nav__link">
 930         acpTemplate
 931       </a>
 932     </li>
 933
 934
 935
 936
 937
 938
 939
 940     <li class="md-nav__item">
 941       <a href="../bbcode/" class="md-nav__link">
 942         bbcode
 943       </a>
 944     </li>
 945
 946
 947
 948
 949
 950
 951
 952     <li class="md-nav__item">
 953       <a href="../box/" class="md-nav__link">
 954         box
 955       </a>
 956     </li>
 957
 958
 959
 960
 961
 962
 963
 964     <li class="md-nav__item">
 965       <a href="../clipboard-action/" class="md-nav__link">
 966         clipboardAction
 967       </a>
 968     </li>
 969
 970
 971
 972
 973
 974
 975
 976     <li class="md-nav__item">
 977       <a href="../core-object/" class="md-nav__link">
 978         coreObject
 979       </a>
 980     </li>
 981
 982
 983
 984
 985
 986
 987
 988     <li class="md-nav__item">
 989       <a href="../cronjob/" class="md-nav__link">
 990         cronjob
 991       </a>
 992     </li>
 993
 994
 995
 996
 997
 998
 999
1000     <li class="md-nav__item">
1001       <a href="../event-listener/" class="md-nav__link">
1002         eventListener
1003       </a>
1004     </li>
1005
1006
1007
1008
1009
1010
1011
1012     <li class="md-nav__item">
1013       <a href="../file/" class="md-nav__link">
1014         file
1015       </a>
1016     </li>
1017
1018
1019
1020
1021
1022
1023
1024     <li class="md-nav__item">
1025       <a href="../language/" class="md-nav__link">
1026         language
1027       </a>
1028     </li>
1029
1030
1031
1032
1033
1034
1035
1036     <li class="md-nav__item">
1037       <a href="../media-provider/" class="md-nav__link">
1038         mediaProvider
1039       </a>
1040     </li>
1041
1042
1043
1044
1045
1046
1047
1048     <li class="md-nav__item">
1049       <a href="../menu/" class="md-nav__link">
1050         menu
1051       </a>
1052     </li>
1053
1054
1055
1056
1057
1058
1059
1060     <li class="md-nav__item">
1061       <a href="../menu-item/" class="md-nav__link">
1062         menuItem
1063       </a>
1064     </li>
1065
1066
1067
1068
1069
1070
1071
1072     <li class="md-nav__item">
1073       <a href="../object-type/" class="md-nav__link">
1074         objectType
1075       </a>
1076     </li>
1077
1078
1079
1080
1081
1082
1083
1084     <li class="md-nav__item">
1085       <a href="../object-type-definition/" class="md-nav__link">
1086         objectTypeDefinition
1087       </a>
1088     </li>
1089
1090
1091
1092
1093
1094
1095
1096     <li class="md-nav__item">
1097       <a href="../option/" class="md-nav__link">
1098         option
1099       </a>
1100     </li>
1101
1102
1103
1104
1105
1106
1107
1108     <li class="md-nav__item">
1109       <a href="../page/" class="md-nav__link">
1110         page
1111       </a>
1112     </li>
1113
1114
1115
1116
1117
1118
1119
1120     <li class="md-nav__item">
1121       <a href="../pip/" class="md-nav__link">
1122         pip
1123       </a>
1124     </li>
1125
1126
1127
1128
1129
1130
1131
1132     <li class="md-nav__item">
1133       <a href="../script/" class="md-nav__link">
1134         script
1135       </a>
1136     </li>
1137
1138
1139
1140
1141
1142
1143
1144     <li class="md-nav__item">
1145       <a href="../smiley/" class="md-nav__link">
1146         smiley
1147       </a>
1148     </li>
1149
1150
1151
1152
1153
1154
1155
1156     <li class="md-nav__item">
1157       <a href="../sql/" class="md-nav__link">
1158         sql
1159       </a>
1160     </li>
1161
1162
1163
1164
1165
1166
1167
1168     <li class="md-nav__item">
1169       <a href="../style/" class="md-nav__link">
1170         style
1171       </a>
1172     </li>
1173
1174
1175
1176
1177
1178
1179
1180     <li class="md-nav__item">
1181       <a href="../template/" class="md-nav__link">
1182         template
1183       </a>
1184     </li>
1185
1186
1187
1188
1189
1190
1191
1192     <li class="md-nav__item">
1193       <a href="../template-listener/" class="md-nav__link">
1194         templateListener
1195       </a>
1196     </li>
1197
1198
1199
1200
1201
1202
1203
1204     <li class="md-nav__item">
1205       <a href="../user-group-option/" class="md-nav__link">
1206         userGroupOption
1207       </a>
1208     </li>
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218     <li class="md-nav__item md-nav__item--active">
1219
1220       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1221
1222
1223
1224
1225         <label class="md-nav__link md-nav__link--active" for="__toc">
1226           userMenu
1227           <span class="md-nav__icon md-icon"></span>
1228         </label>
1229
1230       <a href="./" class="md-nav__link md-nav__link--active">
1231         userMenu
1232       </a>
1233
1234
1235 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1236
1237
1238
1239
1240
1241     <label class="md-nav__title" for="__toc">
1242       <span class="md-nav__icon md-icon"></span>
1243       Table of contents
1244     </label>
1245     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1246
1247         <li class="md-nav__item">
1248   <a href="#components" class="md-nav__link">
1249     Components
1250   </a>
1251
1252     <nav class="md-nav" aria-label="Components">
1253       <ul class="md-nav__list">
1254
1255           <li class="md-nav__item">
1256   <a href="#parent" class="md-nav__link">
1257     &lt;parent&gt;
1258   </a>
1259
1260 </li>
1261
1262           <li class="md-nav__item">
1263   <a href="#showorder" class="md-nav__link">
1264     &lt;showorder&gt;
1265   </a>
1266
1267 </li>
1268
1269           <li class="md-nav__item">
1270   <a href="#controller" class="md-nav__link">
1271     &lt;controller&gt;
1272   </a>
1273
1274 </li>
1275
1276           <li class="md-nav__item">
1277   <a href="#link" class="md-nav__link">
1278     &lt;link&gt;
1279   </a>
1280
1281 </li>
1282
1283           <li class="md-nav__item">
1284   <a href="#iconclassname" class="md-nav__link">
1285     &lt;iconclassname&gt;
1286   </a>
1287
1288 </li>
1289
1290           <li class="md-nav__item">
1291   <a href="#options" class="md-nav__link">
1292     &lt;options&gt;
1293   </a>
1294
1295 </li>
1296
1297           <li class="md-nav__item">
1298   <a href="#permissions" class="md-nav__link">
1299     &lt;permissions&gt;
1300   </a>
1301
1302 </li>
1303
1304           <li class="md-nav__item">
1305   <a href="#classname" class="md-nav__link">
1306     &lt;classname&gt;
1307   </a>
1308
1309 </li>
1310
1311       </ul>
1312     </nav>
1313
1314 </li>
1315
1316         <li class="md-nav__item">
1317   <a href="#example" class="md-nav__link">
1318     Example
1319   </a>
1320
1321 </li>
1322
1323     </ul>
1324
1325 </nav>
1326
1327     </li>
1328
1329
1330
1331
1332
1333
1334
1335     <li class="md-nav__item">
1336       <a href="../user-notification-event/" class="md-nav__link">
1337         userNotificationEvent
1338       </a>
1339     </li>
1340
1341
1342
1343
1344
1345
1346
1347     <li class="md-nav__item">
1348       <a href="../user-option/" class="md-nav__link">
1349         userOption
1350       </a>
1351     </li>
1352
1353
1354
1355
1356
1357
1358
1359     <li class="md-nav__item">
1360       <a href="../user-profile-menu/" class="md-nav__link">
1361         userProfileMenu
1362       </a>
1363     </li>
1364
1365
1366
1367         </ul>
1368       </nav>
1369     </li>
1370
1371
1372
1373
1374
1375
1376
1377     <li class="md-nav__item">
1378       <a href="../../database-php-api/" class="md-nav__link">
1379         Database PHP API
1380       </a>
1381     </li>
1382
1383
1384
1385         </ul>
1386       </nav>
1387     </li>
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399     <li class="md-nav__item md-nav__item--nested">
1400
1401
1402         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1403
1404       <label class="md-nav__link" for="__nav_6">
1405         Migration
1406         <span class="md-nav__icon md-icon"></span>
1407       </label>
1408       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1409         <label class="md-nav__title" for="__nav_6">
1410           <span class="md-nav__icon md-icon"></span>
1411           Migration
1412         </label>
1413         <ul class="md-nav__list" data-md-scrollfix>
1414
1415
1416
1417
1418
1419
1420     <li class="md-nav__item md-nav__item--nested">
1421
1422
1423         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1424
1425       <label class="md-nav__link" for="__nav_6_1">
1426         Migrating from WSC 5.3
1427         <span class="md-nav__icon md-icon"></span>
1428       </label>
1429       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1430         <label class="md-nav__title" for="__nav_6_1">
1431           <span class="md-nav__icon md-icon"></span>
1432           Migrating from WSC 5.3
1433         </label>
1434         <ul class="md-nav__list" data-md-scrollfix>
1435
1436
1437
1438
1439
1440     <li class="md-nav__item">
1441       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1442         PHP API
1443       </a>
1444     </li>
1445
1446
1447
1448
1449
1450
1451
1452     <li class="md-nav__item">
1453       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1454         Session Handling and Authentication
1455       </a>
1456     </li>
1457
1458
1459
1460
1461
1462
1463
1464     <li class="md-nav__item">
1465       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1466         JavaScript
1467       </a>
1468     </li>
1469
1470
1471
1472
1473
1474
1475
1476     <li class="md-nav__item">
1477       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1478         Templates
1479       </a>
1480     </li>
1481
1482
1483
1484
1485
1486
1487
1488     <li class="md-nav__item">
1489       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1490         Third Party Libraries
1491       </a>
1492     </li>
1493
1494
1495
1496         </ul>
1497       </nav>
1498     </li>
1499
1500
1501
1502
1503
1504
1505
1506
1507     <li class="md-nav__item md-nav__item--nested">
1508
1509
1510         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1511
1512       <label class="md-nav__link" for="__nav_6_2">
1513         Migrating from WSC 5.2
1514         <span class="md-nav__icon md-icon"></span>
1515       </label>
1516       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1517         <label class="md-nav__title" for="__nav_6_2">
1518           <span class="md-nav__icon md-icon"></span>
1519           Migrating from WSC 5.2
1520         </label>
1521         <ul class="md-nav__list" data-md-scrollfix>
1522
1523
1524
1525
1526
1527     <li class="md-nav__item">
1528       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1529         PHP API
1530       </a>
1531     </li>
1532
1533
1534
1535
1536
1537
1538
1539     <li class="md-nav__item">
1540       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1541         Templates and Languages
1542       </a>
1543     </li>
1544
1545
1546
1547
1548
1549
1550
1551     <li class="md-nav__item">
1552       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1553         Third Party Libraries
1554       </a>
1555     </li>
1556
1557
1558
1559         </ul>
1560       </nav>
1561     </li>
1562
1563
1564
1565
1566
1567
1568
1569
1570     <li class="md-nav__item md-nav__item--nested">
1571
1572
1573         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1574
1575       <label class="md-nav__link" for="__nav_6_3">
1576         Migrating from WSC 3.1
1577         <span class="md-nav__icon md-icon"></span>
1578       </label>
1579       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1580         <label class="md-nav__title" for="__nav_6_3">
1581           <span class="md-nav__icon md-icon"></span>
1582           Migrating from WSC 3.1
1583         </label>
1584         <ul class="md-nav__list" data-md-scrollfix>
1585
1586
1587
1588
1589
1590     <li class="md-nav__item">
1591       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1592         PHP API
1593       </a>
1594     </li>
1595
1596
1597
1598         </ul>
1599       </nav>
1600     </li>
1601
1602
1603
1604
1605
1606
1607
1608
1609     <li class="md-nav__item md-nav__item--nested">
1610
1611
1612         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1613
1614       <label class="md-nav__link" for="__nav_6_4">
1615         Migrating from WSC 3.0
1616         <span class="md-nav__icon md-icon"></span>
1617       </label>
1618       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1619         <label class="md-nav__title" for="__nav_6_4">
1620           <span class="md-nav__icon md-icon"></span>
1621           Migrating from WSC 3.0
1622         </label>
1623         <ul class="md-nav__list" data-md-scrollfix>
1624
1625
1626
1627
1628
1629     <li class="md-nav__item">
1630       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1631         PHP API
1632       </a>
1633     </li>
1634
1635
1636
1637
1638
1639
1640
1641     <li class="md-nav__item">
1642       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1643         JavaScript API
1644       </a>
1645     </li>
1646
1647
1648
1649
1650
1651
1652
1653     <li class="md-nav__item">
1654       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1655         Templates
1656       </a>
1657     </li>
1658
1659
1660
1661
1662
1663
1664
1665     <li class="md-nav__item">
1666       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1667         CSS
1668       </a>
1669     </li>
1670
1671
1672
1673
1674
1675
1676
1677     <li class="md-nav__item">
1678       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1679         Package Components
1680       </a>
1681     </li>
1682
1683
1684
1685         </ul>
1686       </nav>
1687     </li>
1688
1689
1690
1691
1692
1693
1694
1695
1696     <li class="md-nav__item md-nav__item--nested">
1697
1698
1699         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1700
1701       <label class="md-nav__link" for="__nav_6_5">
1702         Migrating from WCF 2.1
1703         <span class="md-nav__icon md-icon"></span>
1704       </label>
1705       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1706         <label class="md-nav__title" for="__nav_6_5">
1707           <span class="md-nav__icon md-icon"></span>
1708           Migrating from WCF 2.1
1709         </label>
1710         <ul class="md-nav__list" data-md-scrollfix>
1711
1712
1713
1714
1715
1716     <li class="md-nav__item">
1717       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1718         PHP API
1719       </a>
1720     </li>
1721
1722
1723
1724
1725
1726
1727
1728     <li class="md-nav__item">
1729       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1730         Templates
1731       </a>
1732     </li>
1733
1734
1735
1736
1737
1738
1739
1740     <li class="md-nav__item">
1741       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1742         CSS
1743       </a>
1744     </li>
1745
1746
1747
1748
1749
1750
1751
1752     <li class="md-nav__item">
1753       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1754         Package Components
1755       </a>
1756     </li>
1757
1758
1759
1760         </ul>
1761       </nav>
1762     </li>
1763
1764
1765
1766         </ul>
1767       </nav>
1768     </li>
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780     <li class="md-nav__item md-nav__item--nested">
1781
1782
1783         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1784
1785       <label class="md-nav__link" for="__nav_7">
1786         Tutorials
1787         <span class="md-nav__icon md-icon"></span>
1788       </label>
1789       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1790         <label class="md-nav__title" for="__nav_7">
1791           <span class="md-nav__icon md-icon"></span>
1792           Tutorials
1793         </label>
1794         <ul class="md-nav__list" data-md-scrollfix>
1795
1796
1797
1798
1799
1800
1801     <li class="md-nav__item md-nav__item--nested">
1802
1803
1804         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1805
1806       <label class="md-nav__link" for="__nav_7_1">
1807         Tutorial Series
1808         <span class="md-nav__icon md-icon"></span>
1809       </label>
1810       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1811         <label class="md-nav__title" for="__nav_7_1">
1812           <span class="md-nav__icon md-icon"></span>
1813           Tutorial Series
1814         </label>
1815         <ul class="md-nav__list" data-md-scrollfix>
1816
1817
1818
1819
1820
1821     <li class="md-nav__item">
1822       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1823         Overview
1824       </a>
1825     </li>
1826
1827
1828
1829
1830
1831
1832
1833     <li class="md-nav__item">
1834       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1835         Part 1
1836       </a>
1837     </li>
1838
1839
1840
1841
1842
1843
1844
1845     <li class="md-nav__item">
1846       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1847         Part 2
1848       </a>
1849     </li>
1850
1851
1852
1853
1854
1855
1856
1857     <li class="md-nav__item">
1858       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1859         Part 3
1860       </a>
1861     </li>
1862
1863
1864
1865         </ul>
1866       </nav>
1867     </li>
1868
1869
1870
1871         </ul>
1872       </nav>
1873     </li>
1874
1875
1876
1877   </ul>
1878 </nav>
1879                   </div>
1880                 </div>
1881               </div>
1882
1883
1884
1885               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1886                 <div class="md-sidebar__scrollwrap">
1887                   <div class="md-sidebar__inner">
1888
1889 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1890
1891
1892
1893
1894
1895     <label class="md-nav__title" for="__toc">
1896       <span class="md-nav__icon md-icon"></span>
1897       Table of contents
1898     </label>
1899     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1900
1901         <li class="md-nav__item">
1902   <a href="#components" class="md-nav__link">
1903     Components
1904   </a>
1905
1906     <nav class="md-nav" aria-label="Components">
1907       <ul class="md-nav__list">
1908
1909           <li class="md-nav__item">
1910   <a href="#parent" class="md-nav__link">
1911     &lt;parent&gt;
1912   </a>
1913
1914 </li>
1915
1916           <li class="md-nav__item">
1917   <a href="#showorder" class="md-nav__link">
1918     &lt;showorder&gt;
1919   </a>
1920
1921 </li>
1922
1923           <li class="md-nav__item">
1924   <a href="#controller" class="md-nav__link">
1925     &lt;controller&gt;
1926   </a>
1927
1928 </li>
1929
1930           <li class="md-nav__item">
1931   <a href="#link" class="md-nav__link">
1932     &lt;link&gt;
1933   </a>
1934
1935 </li>
1936
1937           <li class="md-nav__item">
1938   <a href="#iconclassname" class="md-nav__link">
1939     &lt;iconclassname&gt;
1940   </a>
1941
1942 </li>
1943
1944           <li class="md-nav__item">
1945   <a href="#options" class="md-nav__link">
1946     &lt;options&gt;
1947   </a>
1948
1949 </li>
1950
1951           <li class="md-nav__item">
1952   <a href="#permissions" class="md-nav__link">
1953     &lt;permissions&gt;
1954   </a>
1955
1956 </li>
1957
1958           <li class="md-nav__item">
1959   <a href="#classname" class="md-nav__link">
1960     &lt;classname&gt;
1961   </a>
1962
1963 </li>
1964
1965       </ul>
1966     </nav>
1967
1968 </li>
1969
1970         <li class="md-nav__item">
1971   <a href="#example" class="md-nav__link">
1972     Example
1973   </a>
1974
1975 </li>
1976
1977     </ul>
1978
1979 </nav>
1980                   </div>
1981                 </div>
1982               </div>
1983
1984
1985           <div class="md-content" data-md-component="content">
1986             <article class="md-content__inner md-typeset">
1987
1988
1989                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/user-menu.md" title="Edit this page" class="md-content__button md-icon">
1990                     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
1991                   </a>
1992
1993
1994                 <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>
1995 <p>Registers new user menu items.</p>
1996 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
1997 <p>Each item is described as an <code>&lt;usermenuitem&gt;</code> element with the mandatory attribute <code>name</code>.</p>
1998 <h3 id="parent"><code>&lt;parent&gt;</code><a class="headerlink" href="#parent" title="Permanent link">#</a></h3>
1999 <p><span class="label label-info">Optional</span></p>
2000 <p>The item’s parent item.</p>
2001 <h3 id="showorder"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder" title="Permanent link">#</a></h3>
2002 <p><span class="label label-info">Optional</span></p>
2003 <p>Specifies the order of this item within the parent item.</p>
2004 <h3 id="controller"><code>&lt;controller&gt;</code><a class="headerlink" href="#controller" title="Permanent link">#</a></h3>
2005 <p>The fully qualified class name of the target controller.
2006 If not specified this item serves as a category.</p>
2007 <h3 id="link"><code>&lt;link&gt;</code><a class="headerlink" href="#link" title="Permanent link">#</a></h3>
2008 <p>Additional components if <code>&lt;controller&gt;</code> is set,
2009 the full external link otherwise.</p>
2010 <h3 id="iconclassname"><code>&lt;iconclassname&gt;</code><a class="headerlink" href="#iconclassname" title="Permanent link">#</a></h3>
2011 <div class="admonition info">
2012 <p class="admonition-title">Use an icon only for top-level items.</p>
2013 </div>
2014 <p>Name of the Font Awesome icon class.</p>
2015 <h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2016 <p><span class="label label-info">Optional</span></p>
2017 <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>
2018 <h3 id="permissions"><code>&lt;permissions&gt;</code><a class="headerlink" href="#permissions" title="Permanent link">#</a></h3>
2019 <p><span class="label label-info">Optional</span></p>
2020 <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>
2021 <h3 id="classname"><code>&lt;classname&gt;</code><a class="headerlink" href="#classname" title="Permanent link">#</a></h3>
2022 <p>The name of the class providing the user menu item’s behaviour,
2023 the class has to implement the <code>wcf\system\menu\user\IUserMenuItemProvider</code> interface.</p>
2024 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2025 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2026 <span class="nt">&lt;data</span> <span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span> <span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</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>
2027     <span class="nt">&lt;import&gt;</span>
2028         <span class="nt">&lt;usermenuitem</span> <span class="na">name=</span><span class="s">&quot;wcf.user.menu.foo&quot;</span><span class="nt">&gt;</span>
2029             <span class="nt">&lt;iconclassname&gt;</span>fa-home<span class="nt">&lt;/iconclassname&gt;</span>
2030         <span class="nt">&lt;/usermenuitem&gt;</span>
2031
2032         <span class="nt">&lt;usermenuitem</span> <span class="na">name=</span><span class="s">&quot;wcf.user.menu.foo.bar&quot;</span><span class="nt">&gt;</span>
2033             <span class="nt">&lt;controller&gt;</span>wcf\page\FooBarListPage<span class="nt">&lt;/controller&gt;</span>
2034             <span class="nt">&lt;parent&gt;</span>wcf.user.menu.foo<span class="nt">&lt;/parent&gt;</span>
2035             <span class="nt">&lt;permissions&gt;</span>user.foo.canBar<span class="nt">&lt;/permissions&gt;</span>
2036             <span class="nt">&lt;classname&gt;</span>wcf\system\menu\user\FooBarMenuItemProvider<span class="nt">&lt;/classname&gt;</span>
2037         <span class="nt">&lt;/usermenuitem&gt;</span>
2038
2039         <span class="nt">&lt;usermenuitem</span> <span class="na">name=</span><span class="s">&quot;wcf.user.menu.foo.baz&quot;</span><span class="nt">&gt;</span>
2040             <span class="nt">&lt;controller&gt;</span>wcf\page\FooBazListPage<span class="nt">&lt;/controller&gt;</span>
2041             <span class="nt">&lt;parent&gt;</span>wcf.user.menu.foo<span class="nt">&lt;/parent&gt;</span>
2042             <span class="nt">&lt;permissions&gt;</span>user.foo.canBaz<span class="nt">&lt;/permissions&gt;</span>
2043             <span class="nt">&lt;options&gt;</span>module_foo_bar<span class="nt">&lt;/options&gt;</span>
2044         <span class="nt">&lt;/usermenuitem&gt;</span>
2045     <span class="nt">&lt;/import&gt;</span>
2046 <span class="nt">&lt;/data&gt;</span>
2047 </code></pre></div>
2048
2049
2050
2051
2052 <hr>
2053 <div class="md-source-date">
2054   <small>
2055
2056       Last update: 2021-01-08
2057
2058   </small>
2059 </div>
2060
2061
2062
2063
2064
2065
2066
2067
2068             </article>
2069           </div>
2070         </div>
2071
2072       </main>
2073
2074
2075 <footer class="md-footer">
2076
2077     <nav class="md-footer__inner md-grid" aria-label="Footer">
2078
2079         <a href="../user-group-option/" class="md-footer__link md-footer__link--prev" rel="prev">
2080           <div class="md-footer__button md-icon">
2081             <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>
2082           </div>
2083           <div class="md-footer__title">
2084             <div class="md-ellipsis">
2085               <span class="md-footer__direction">
2086                 Previous
2087               </span>
2088               userGroupOption
2089             </div>
2090           </div>
2091         </a>
2092
2093
2094         <a href="../user-notification-event/" class="md-footer__link md-footer__link--next" rel="next">
2095           <div class="md-footer__title">
2096             <div class="md-ellipsis">
2097               <span class="md-footer__direction">
2098                 Next
2099               </span>
2100               userNotificationEvent
2101             </div>
2102           </div>
2103           <div class="md-footer__button md-icon">
2104             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2105           </div>
2106         </a>
2107
2108     </nav>
2109
2110   <div class="md-footer-meta md-typeset">
2111     <div class="md-footer-meta__inner md-grid">
2112       <div class="md-footer-copyright">
2113
2114           <div class="md-footer-copyright__highlight">
2115             Copyright © 2020 WoltLab GmbH
2116           </div>
2117
2118         Made with
2119         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2120           Material for MkDocs
2121         </a>
2122
2123       </div>
2124       <div class="md-footer-copyright">
2125         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2126         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2127 </div>
2128     </div>
2129   </div>
2130 </footer>
2131
2132     </div>
2133     <div class="md-dialog" data-md-component="dialog">
2134       <div class="md-dialog__inner md-typeset"></div>
2135     </div>
2136     <script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script>
2137
2138
2139       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2140
2141
2142   </body>
2143 </html>