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
 310     <li class="md-nav__item md-nav__item--nested">
 311
 312
 313         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 314
 315       <label class="md-nav__link" for="__nav_2_5_1">
 316         Caches
 317         <span class="md-nav__icon md-icon"></span>
 318       </label>
 319       <nav class="md-nav" aria-label="Caches" data-md-level="3">
 320         <label class="md-nav__title" for="__nav_2_5_1">
 321           <span class="md-nav__icon md-icon"></span>
 322           Caches
 323         </label>
 324         <ul class="md-nav__list" data-md-scrollfix>
 325
 326
 327
 328
 329
 330     <li class="md-nav__item">
 331       <a href="../../../php/api/caches/" class="md-nav__link">
 332         Overview
 333       </a>
 334     </li>
 335
 336
 337
 338
 339
 340
 341
 342     <li class="md-nav__item">
 343       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 344         Persistent Caches
 345       </a>
 346     </li>
 347
 348
 349
 350
 351
 352
 353
 354     <li class="md-nav__item">
 355       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 356         Runtime Caches
 357       </a>
 358     </li>
 359
 360
 361
 362         </ul>
 363       </nav>
 364     </li>
 365
 366
 367
 368
 369
 370
 371
 372     <li class="md-nav__item">
 373       <a href="../../../php/api/comments/" class="md-nav__link">
 374         Comments
 375       </a>
 376     </li>
 377
 378
 379
 380
 381
 382
 383
 384     <li class="md-nav__item">
 385       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 386         Cronjobs
 387       </a>
 388     </li>
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../../../php/api/events/" class="md-nav__link">
 398         Events
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409     <li class="md-nav__item md-nav__item--nested">
 410
 411
 412         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 413
 414       <label class="md-nav__link" for="__nav_2_5_5">
 415         Form Builder
 416         <span class="md-nav__icon md-icon"></span>
 417       </label>
 418       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 419         <label class="md-nav__title" for="__nav_2_5_5">
 420           <span class="md-nav__icon md-icon"></span>
 421           Form Builder
 422         </label>
 423         <ul class="md-nav__list" data-md-scrollfix>
 424
 425
 426
 427
 428
 429     <li class="md-nav__item">
 430       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 431         Overview
 432       </a>
 433     </li>
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 443         Structure
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item">
 454       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 455         Fields
 456       </a>
 457     </li>
 458
 459
 460
 461
 462
 463
 464
 465     <li class="md-nav__item">
 466       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 467         Validation and Data
 468       </a>
 469     </li>
 470
 471
 472
 473
 474
 475
 476
 477     <li class="md-nav__item">
 478       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 479         Dependencies
 480       </a>
 481     </li>
 482
 483
 484
 485         </ul>
 486       </nav>
 487     </li>
 488
 489
 490
 491
 492
 493
 494
 495     <li class="md-nav__item">
 496       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 497         Package Installation Plugins
 498       </a>
 499     </li>
 500
 501
 502
 503
 504
 505
 506
 507     <li class="md-nav__item">
 508       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 509         User Activity Points
 510       </a>
 511     </li>
 512
 513
 514
 515
 516
 517
 518
 519     <li class="md-nav__item">
 520       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 521         User Notifications
 522       </a>
 523     </li>
 524
 525
 526
 527
 528
 529
 530
 531     <li class="md-nav__item">
 532       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 533         Sitemaps
 534       </a>
 535     </li>
 536
 537
 538
 539         </ul>
 540       </nav>
 541     </li>
 542
 543
 544
 545
 546
 547
 548
 549     <li class="md-nav__item">
 550       <a href="../../../php/code-style/" class="md-nav__link">
 551         Code Style
 552       </a>
 553     </li>
 554
 555
 556
 557
 558
 559
 560
 561     <li class="md-nav__item">
 562       <a href="../../../php/apps/" class="md-nav__link">
 563         Apps
 564       </a>
 565     </li>
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../../php/gdpr/" class="md-nav__link">
 575         GDPR
 576       </a>
 577     </li>
 578
 579
 580
 581         </ul>
 582       </nav>
 583     </li>
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595     <li class="md-nav__item md-nav__item--nested">
 596
 597
 598         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 599
 600       <label class="md-nav__link" for="__nav_3">
 601         Languages, Templates & CSS
 602         <span class="md-nav__icon md-icon"></span>
 603       </label>
 604       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 605         <label class="md-nav__title" for="__nav_3">
 606           <span class="md-nav__icon md-icon"></span>
 607           Languages, Templates & CSS
 608         </label>
 609         <ul class="md-nav__list" data-md-scrollfix>
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../../view/languages/" class="md-nav__link">
 617         Languages
 618       </a>
 619     </li>
 620
 621
 622
 623
 624
 625
 626
 627     <li class="md-nav__item">
 628       <a href="../../../view/templates/" class="md-nav__link">
 629         Templates
 630       </a>
 631     </li>
 632
 633
 634
 635
 636
 637
 638
 639     <li class="md-nav__item">
 640       <a href="../../../view/template-plugins/" class="md-nav__link">
 641         Template Plugins
 642       </a>
 643     </li>
 644
 645
 646
 647
 648
 649
 650
 651     <li class="md-nav__item">
 652       <a href="../../../view/css/" class="md-nav__link">
 653         CSS
 654       </a>
 655     </li>
 656
 657
 658
 659         </ul>
 660       </nav>
 661     </li>
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673     <li class="md-nav__item md-nav__item--nested">
 674
 675
 676         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 677
 678       <label class="md-nav__link" for="__nav_4">
 679         TypeScript and JavaScript API
 680         <span class="md-nav__icon md-icon"></span>
 681       </label>
 682       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 683         <label class="md-nav__title" for="__nav_4">
 684           <span class="md-nav__icon md-icon"></span>
 685           TypeScript and JavaScript API
 686         </label>
 687         <ul class="md-nav__list" data-md-scrollfix>
 688
 689
 690
 691
 692
 693     <li class="md-nav__item">
 694       <a href="../../../javascript/general-usage/" class="md-nav__link">
 695         General Usage
 696       </a>
 697     </li>
 698
 699
 700
 701
 702
 703
 704
 705     <li class="md-nav__item">
 706       <a href="../../../javascript/typescript/" class="md-nav__link">
 707         TypeScript
 708       </a>
 709     </li>
 710
 711
 712
 713
 714
 715
 716
 717
 718     <li class="md-nav__item md-nav__item--nested">
 719
 720
 721         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 722
 723       <label class="md-nav__link" for="__nav_4_3">
 724         New API
 725         <span class="md-nav__icon md-icon"></span>
 726       </label>
 727       <nav class="md-nav" aria-label="New API" data-md-level="2">
 728         <label class="md-nav__title" for="__nav_4_3">
 729           <span class="md-nav__icon md-icon"></span>
 730           New API
 731         </label>
 732         <ul class="md-nav__list" data-md-scrollfix>
 733
 734
 735
 736
 737
 738     <li class="md-nav__item">
 739       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 740         Writing a module
 741       </a>
 742     </li>
 743
 744
 745
 746
 747
 748
 749
 750     <li class="md-nav__item">
 751       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 752         Data Structures
 753       </a>
 754     </li>
 755
 756
 757
 758
 759
 760
 761
 762     <li class="md-nav__item">
 763       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 764         Core Functions
 765       </a>
 766     </li>
 767
 768
 769
 770
 771
 772
 773
 774     <li class="md-nav__item">
 775       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 776         DOM
 777       </a>
 778     </li>
 779
 780
 781
 782
 783
 784
 785
 786     <li class="md-nav__item">
 787       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 788         Event Handling
 789       </a>
 790     </li>
 791
 792
 793
 794
 795
 796
 797
 798     <li class="md-nav__item">
 799       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 800         Ajax
 801       </a>
 802     </li>
 803
 804
 805
 806
 807
 808
 809
 810     <li class="md-nav__item">
 811       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 812         Dialogs
 813       </a>
 814     </li>
 815
 816
 817
 818
 819
 820
 821
 822     <li class="md-nav__item">
 823       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 824         Browser and Screen Sizes
 825       </a>
 826     </li>
 827
 828
 829
 830
 831
 832
 833
 834     <li class="md-nav__item">
 835       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 836         User Interface
 837       </a>
 838     </li>
 839
 840
 841
 842         </ul>
 843       </nav>
 844     </li>
 845
 846
 847
 848
 849
 850
 851
 852     <li class="md-nav__item">
 853       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 854         Legacy API
 855       </a>
 856     </li>
 857
 858
 859
 860
 861
 862
 863
 864     <li class="md-nav__item">
 865       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 866         Helper Functions
 867       </a>
 868     </li>
 869
 870
 871
 872
 873
 874
 875
 876     <li class="md-nav__item">
 877       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 878         Code Snippets
 879       </a>
 880     </li>
 881
 882
 883
 884         </ul>
 885       </nav>
 886     </li>
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 901
 902
 903         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 904
 905       <label class="md-nav__link" for="__nav_5">
 906         Package Components
 907         <span class="md-nav__icon md-icon"></span>
 908       </label>
 909       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 910         <label class="md-nav__title" for="__nav_5">
 911           <span class="md-nav__icon md-icon"></span>
 912           Package Components
 913         </label>
 914         <ul class="md-nav__list" data-md-scrollfix>
 915
 916
 917
 918
 919
 920     <li class="md-nav__item">
 921       <a href="../../package-xml/" class="md-nav__link">
 922         package.xml
 923       </a>
 924     </li>
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 936
 937
 938         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
 939
 940       <label class="md-nav__link" for="__nav_5_2">
 941         PIPs
 942         <span class="md-nav__icon md-icon"></span>
 943       </label>
 944       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 945         <label class="md-nav__title" for="__nav_5_2">
 946           <span class="md-nav__icon md-icon"></span>
 947           PIPs
 948         </label>
 949         <ul class="md-nav__list" data-md-scrollfix>
 950
 951
 952
 953
 954
 955     <li class="md-nav__item">
 956       <a href="../" class="md-nav__link">
 957         Overview
 958       </a>
 959     </li>
 960
 961
 962
 963
 964
 965
 966
 967     <li class="md-nav__item">
 968       <a href="../acl-option/" class="md-nav__link">
 969         aclOption
 970       </a>
 971     </li>
 972
 973
 974
 975
 976
 977
 978
 979     <li class="md-nav__item">
 980       <a href="../acp-menu/" class="md-nav__link">
 981         acpMenu
 982       </a>
 983     </li>
 984
 985
 986
 987
 988
 989
 990
 991     <li class="md-nav__item">
 992       <a href="../acp-search-provider/" class="md-nav__link">
 993         acpSearchProvider
 994       </a>
 995     </li>
 996
 997
 998
 999
1000
1001
1002
1003     <li class="md-nav__item">
1004       <a href="../acp-template/" class="md-nav__link">
1005         acpTemplate
1006       </a>
1007     </li>
1008
1009
1010
1011
1012
1013
1014
1015     <li class="md-nav__item">
1016       <a href="../bbcode/" class="md-nav__link">
1017         bbcode
1018       </a>
1019     </li>
1020
1021
1022
1023
1024
1025
1026
1027     <li class="md-nav__item">
1028       <a href="../box/" class="md-nav__link">
1029         box
1030       </a>
1031     </li>
1032
1033
1034
1035
1036
1037
1038
1039     <li class="md-nav__item">
1040       <a href="../clipboard-action/" class="md-nav__link">
1041         clipboardAction
1042       </a>
1043     </li>
1044
1045
1046
1047
1048
1049
1050
1051     <li class="md-nav__item">
1052       <a href="../core-object/" class="md-nav__link">
1053         coreObject
1054       </a>
1055     </li>
1056
1057
1058
1059
1060
1061
1062
1063     <li class="md-nav__item">
1064       <a href="../cronjob/" class="md-nav__link">
1065         cronjob
1066       </a>
1067     </li>
1068
1069
1070
1071
1072
1073
1074
1075     <li class="md-nav__item">
1076       <a href="../database/" class="md-nav__link">
1077         database
1078       </a>
1079     </li>
1080
1081
1082
1083
1084
1085
1086
1087     <li class="md-nav__item">
1088       <a href="../event-listener/" class="md-nav__link">
1089         eventListener
1090       </a>
1091     </li>
1092
1093
1094
1095
1096
1097
1098
1099     <li class="md-nav__item">
1100       <a href="../file/" class="md-nav__link">
1101         file
1102       </a>
1103     </li>
1104
1105
1106
1107
1108
1109
1110
1111     <li class="md-nav__item">
1112       <a href="../language/" class="md-nav__link">
1113         language
1114       </a>
1115     </li>
1116
1117
1118
1119
1120
1121
1122
1123     <li class="md-nav__item">
1124       <a href="../media-provider/" class="md-nav__link">
1125         mediaProvider
1126       </a>
1127     </li>
1128
1129
1130
1131
1132
1133
1134
1135     <li class="md-nav__item">
1136       <a href="../menu/" class="md-nav__link">
1137         menu
1138       </a>
1139     </li>
1140
1141
1142
1143
1144
1145
1146
1147     <li class="md-nav__item">
1148       <a href="../menu-item/" class="md-nav__link">
1149         menuItem
1150       </a>
1151     </li>
1152
1153
1154
1155
1156
1157
1158
1159     <li class="md-nav__item">
1160       <a href="../object-type/" class="md-nav__link">
1161         objectType
1162       </a>
1163     </li>
1164
1165
1166
1167
1168
1169
1170
1171     <li class="md-nav__item">
1172       <a href="../object-type-definition/" class="md-nav__link">
1173         objectTypeDefinition
1174       </a>
1175     </li>
1176
1177
1178
1179
1180
1181
1182
1183     <li class="md-nav__item">
1184       <a href="../option/" class="md-nav__link">
1185         option
1186       </a>
1187     </li>
1188
1189
1190
1191
1192
1193
1194
1195     <li class="md-nav__item">
1196       <a href="../page/" class="md-nav__link">
1197         page
1198       </a>
1199     </li>
1200
1201
1202
1203
1204
1205
1206
1207     <li class="md-nav__item">
1208       <a href="../pip/" class="md-nav__link">
1209         pip
1210       </a>
1211     </li>
1212
1213
1214
1215
1216
1217
1218
1219     <li class="md-nav__item">
1220       <a href="../script/" class="md-nav__link">
1221         script
1222       </a>
1223     </li>
1224
1225
1226
1227
1228
1229
1230
1231     <li class="md-nav__item">
1232       <a href="../smiley/" class="md-nav__link">
1233         smiley
1234       </a>
1235     </li>
1236
1237
1238
1239
1240
1241
1242
1243     <li class="md-nav__item">
1244       <a href="../sql/" class="md-nav__link">
1245         sql
1246       </a>
1247     </li>
1248
1249
1250
1251
1252
1253
1254
1255     <li class="md-nav__item">
1256       <a href="../style/" class="md-nav__link">
1257         style
1258       </a>
1259     </li>
1260
1261
1262
1263
1264
1265
1266
1267     <li class="md-nav__item">
1268       <a href="../template/" class="md-nav__link">
1269         template
1270       </a>
1271     </li>
1272
1273
1274
1275
1276
1277
1278
1279     <li class="md-nav__item">
1280       <a href="../template-listener/" class="md-nav__link">
1281         templateListener
1282       </a>
1283     </li>
1284
1285
1286
1287
1288
1289
1290
1291     <li class="md-nav__item">
1292       <a href="../user-group-option/" class="md-nav__link">
1293         userGroupOption
1294       </a>
1295     </li>
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305     <li class="md-nav__item md-nav__item--active">
1306
1307       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1308
1309
1310
1311
1312         <label class="md-nav__link md-nav__link--active" for="__toc">
1313           userMenu
1314           <span class="md-nav__icon md-icon"></span>
1315         </label>
1316
1317       <a href="./" class="md-nav__link md-nav__link--active">
1318         userMenu
1319       </a>
1320
1321
1322 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1323
1324
1325
1326
1327
1328     <label class="md-nav__title" for="__toc">
1329       <span class="md-nav__icon md-icon"></span>
1330       Table of contents
1331     </label>
1332     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1333
1334         <li class="md-nav__item">
1335   <a href="#components" class="md-nav__link">
1336     Components
1337   </a>
1338
1339     <nav class="md-nav" aria-label="Components">
1340       <ul class="md-nav__list">
1341
1342           <li class="md-nav__item">
1343   <a href="#parent" class="md-nav__link">
1344     &lt;parent&gt;
1345   </a>
1346
1347 </li>
1348
1349           <li class="md-nav__item">
1350   <a href="#showorder" class="md-nav__link">
1351     &lt;showorder&gt;
1352   </a>
1353
1354 </li>
1355
1356           <li class="md-nav__item">
1357   <a href="#controller" class="md-nav__link">
1358     &lt;controller&gt;
1359   </a>
1360
1361 </li>
1362
1363           <li class="md-nav__item">
1364   <a href="#link" class="md-nav__link">
1365     &lt;link&gt;
1366   </a>
1367
1368 </li>
1369
1370           <li class="md-nav__item">
1371   <a href="#iconclassname" class="md-nav__link">
1372     &lt;iconclassname&gt;
1373   </a>
1374
1375 </li>
1376
1377           <li class="md-nav__item">
1378   <a href="#options" class="md-nav__link">
1379     &lt;options&gt;
1380   </a>
1381
1382 </li>
1383
1384           <li class="md-nav__item">
1385   <a href="#permissions" class="md-nav__link">
1386     &lt;permissions&gt;
1387   </a>
1388
1389 </li>
1390
1391           <li class="md-nav__item">
1392   <a href="#classname" class="md-nav__link">
1393     &lt;classname&gt;
1394   </a>
1395
1396 </li>
1397
1398       </ul>
1399     </nav>
1400
1401 </li>
1402
1403         <li class="md-nav__item">
1404   <a href="#example" class="md-nav__link">
1405     Example
1406   </a>
1407
1408 </li>
1409
1410     </ul>
1411
1412 </nav>
1413
1414     </li>
1415
1416
1417
1418
1419
1420
1421
1422     <li class="md-nav__item">
1423       <a href="../user-notification-event/" class="md-nav__link">
1424         userNotificationEvent
1425       </a>
1426     </li>
1427
1428
1429
1430
1431
1432
1433
1434     <li class="md-nav__item">
1435       <a href="../user-option/" class="md-nav__link">
1436         userOption
1437       </a>
1438     </li>
1439
1440
1441
1442
1443
1444
1445
1446     <li class="md-nav__item">
1447       <a href="../user-profile-menu/" class="md-nav__link">
1448         userProfileMenu
1449       </a>
1450     </li>
1451
1452
1453
1454         </ul>
1455       </nav>
1456     </li>
1457
1458
1459
1460
1461
1462
1463
1464     <li class="md-nav__item">
1465       <a href="../../database-php-api/" class="md-nav__link">
1466         Database PHP API
1467       </a>
1468     </li>
1469
1470
1471
1472         </ul>
1473       </nav>
1474     </li>
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486     <li class="md-nav__item md-nav__item--nested">
1487
1488
1489         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1490
1491       <label class="md-nav__link" for="__nav_6">
1492         Migration
1493         <span class="md-nav__icon md-icon"></span>
1494       </label>
1495       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1496         <label class="md-nav__title" for="__nav_6">
1497           <span class="md-nav__icon md-icon"></span>
1498           Migration
1499         </label>
1500         <ul class="md-nav__list" data-md-scrollfix>
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_1" type="checkbox" id="__nav_6_1" >
1511
1512       <label class="md-nav__link" for="__nav_6_1">
1513         Migrating from WSC 5.3
1514         <span class="md-nav__icon md-icon"></span>
1515       </label>
1516       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1517         <label class="md-nav__title" for="__nav_6_1">
1518           <span class="md-nav__icon md-icon"></span>
1519           Migrating from WSC 5.3
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/wsc53/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/wsc53/session/" class="md-nav__link">
1541         Session Handling and Authentication
1542       </a>
1543     </li>
1544
1545
1546
1547
1548
1549
1550
1551     <li class="md-nav__item">
1552       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1553         TypeScript and JavaScript
1554       </a>
1555     </li>
1556
1557
1558
1559
1560
1561
1562
1563     <li class="md-nav__item">
1564       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1565         Templates
1566       </a>
1567     </li>
1568
1569
1570
1571
1572
1573
1574
1575     <li class="md-nav__item">
1576       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1577         Third Party Libraries
1578       </a>
1579     </li>
1580
1581
1582
1583         </ul>
1584       </nav>
1585     </li>
1586
1587
1588
1589
1590
1591
1592
1593
1594     <li class="md-nav__item md-nav__item--nested">
1595
1596
1597         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1598
1599       <label class="md-nav__link" for="__nav_6_2">
1600         Migrating from WSC 5.2
1601         <span class="md-nav__icon md-icon"></span>
1602       </label>
1603       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1604         <label class="md-nav__title" for="__nav_6_2">
1605           <span class="md-nav__icon md-icon"></span>
1606           Migrating from WSC 5.2
1607         </label>
1608         <ul class="md-nav__list" data-md-scrollfix>
1609
1610
1611
1612
1613
1614     <li class="md-nav__item">
1615       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1616         PHP API
1617       </a>
1618     </li>
1619
1620
1621
1622
1623
1624
1625
1626     <li class="md-nav__item">
1627       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1628         Templates and Languages
1629       </a>
1630     </li>
1631
1632
1633
1634
1635
1636
1637
1638     <li class="md-nav__item">
1639       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1640         Third Party Libraries
1641       </a>
1642     </li>
1643
1644
1645
1646         </ul>
1647       </nav>
1648     </li>
1649
1650
1651
1652
1653
1654
1655
1656
1657     <li class="md-nav__item md-nav__item--nested">
1658
1659
1660         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1661
1662       <label class="md-nav__link" for="__nav_6_3">
1663         Migrating from WSC 3.1
1664         <span class="md-nav__icon md-icon"></span>
1665       </label>
1666       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1667         <label class="md-nav__title" for="__nav_6_3">
1668           <span class="md-nav__icon md-icon"></span>
1669           Migrating from WSC 3.1
1670         </label>
1671         <ul class="md-nav__list" data-md-scrollfix>
1672
1673
1674
1675
1676
1677     <li class="md-nav__item">
1678       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1679         PHP API
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_4" type="checkbox" id="__nav_6_4" >
1700
1701       <label class="md-nav__link" for="__nav_6_4">
1702         Migrating from WSC 3.0
1703         <span class="md-nav__icon md-icon"></span>
1704       </label>
1705       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1706         <label class="md-nav__title" for="__nav_6_4">
1707           <span class="md-nav__icon md-icon"></span>
1708           Migrating from WSC 3.0
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/wsc30/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/wsc30/javascript/" class="md-nav__link">
1730         JavaScript API
1731       </a>
1732     </li>
1733
1734
1735
1736
1737
1738
1739
1740     <li class="md-nav__item">
1741       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1742         Templates
1743       </a>
1744     </li>
1745
1746
1747
1748
1749
1750
1751
1752     <li class="md-nav__item">
1753       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1754         CSS
1755       </a>
1756     </li>
1757
1758
1759
1760
1761
1762
1763
1764     <li class="md-nav__item">
1765       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1766         Package Components
1767       </a>
1768     </li>
1769
1770
1771
1772         </ul>
1773       </nav>
1774     </li>
1775
1776
1777
1778
1779
1780
1781
1782
1783     <li class="md-nav__item md-nav__item--nested">
1784
1785
1786         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1787
1788       <label class="md-nav__link" for="__nav_6_5">
1789         Migrating from WCF 2.1
1790         <span class="md-nav__icon md-icon"></span>
1791       </label>
1792       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1793         <label class="md-nav__title" for="__nav_6_5">
1794           <span class="md-nav__icon md-icon"></span>
1795           Migrating from WCF 2.1
1796         </label>
1797         <ul class="md-nav__list" data-md-scrollfix>
1798
1799
1800
1801
1802
1803     <li class="md-nav__item">
1804       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1805         PHP API
1806       </a>
1807     </li>
1808
1809
1810
1811
1812
1813
1814
1815     <li class="md-nav__item">
1816       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1817         Templates
1818       </a>
1819     </li>
1820
1821
1822
1823
1824
1825
1826
1827     <li class="md-nav__item">
1828       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1829         CSS
1830       </a>
1831     </li>
1832
1833
1834
1835
1836
1837
1838
1839     <li class="md-nav__item">
1840       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1841         Package Components
1842       </a>
1843     </li>
1844
1845
1846
1847         </ul>
1848       </nav>
1849     </li>
1850
1851
1852
1853         </ul>
1854       </nav>
1855     </li>
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867     <li class="md-nav__item md-nav__item--nested">
1868
1869
1870         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1871
1872       <label class="md-nav__link" for="__nav_7">
1873         Tutorials
1874         <span class="md-nav__icon md-icon"></span>
1875       </label>
1876       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1877         <label class="md-nav__title" for="__nav_7">
1878           <span class="md-nav__icon md-icon"></span>
1879           Tutorials
1880         </label>
1881         <ul class="md-nav__list" data-md-scrollfix>
1882
1883
1884
1885
1886
1887
1888     <li class="md-nav__item md-nav__item--nested">
1889
1890
1891         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1892
1893       <label class="md-nav__link" for="__nav_7_1">
1894         Tutorial Series
1895         <span class="md-nav__icon md-icon"></span>
1896       </label>
1897       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1898         <label class="md-nav__title" for="__nav_7_1">
1899           <span class="md-nav__icon md-icon"></span>
1900           Tutorial Series
1901         </label>
1902         <ul class="md-nav__list" data-md-scrollfix>
1903
1904
1905
1906
1907
1908     <li class="md-nav__item">
1909       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1910         Overview
1911       </a>
1912     </li>
1913
1914
1915
1916
1917
1918
1919
1920     <li class="md-nav__item">
1921       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1922         Part 1
1923       </a>
1924     </li>
1925
1926
1927
1928
1929
1930
1931
1932     <li class="md-nav__item">
1933       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1934         Part 2
1935       </a>
1936     </li>
1937
1938
1939
1940
1941
1942
1943
1944     <li class="md-nav__item">
1945       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1946         Part 3
1947       </a>
1948     </li>
1949
1950
1951
1952         </ul>
1953       </nav>
1954     </li>
1955
1956
1957
1958         </ul>
1959       </nav>
1960     </li>
1961
1962
1963
1964   </ul>
1965 </nav>
1966                   </div>
1967                 </div>
1968               </div>
1969
1970
1971
1972               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1973                 <div class="md-sidebar__scrollwrap">
1974                   <div class="md-sidebar__inner">
1975
1976 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1977
1978
1979
1980
1981
1982     <label class="md-nav__title" for="__toc">
1983       <span class="md-nav__icon md-icon"></span>
1984       Table of contents
1985     </label>
1986     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1987
1988         <li class="md-nav__item">
1989   <a href="#components" class="md-nav__link">
1990     Components
1991   </a>
1992
1993     <nav class="md-nav" aria-label="Components">
1994       <ul class="md-nav__list">
1995
1996           <li class="md-nav__item">
1997   <a href="#parent" class="md-nav__link">
1998     &lt;parent&gt;
1999   </a>
2000
2001 </li>
2002
2003           <li class="md-nav__item">
2004   <a href="#showorder" class="md-nav__link">
2005     &lt;showorder&gt;
2006   </a>
2007
2008 </li>
2009
2010           <li class="md-nav__item">
2011   <a href="#controller" class="md-nav__link">
2012     &lt;controller&gt;
2013   </a>
2014
2015 </li>
2016
2017           <li class="md-nav__item">
2018   <a href="#link" class="md-nav__link">
2019     &lt;link&gt;
2020   </a>
2021
2022 </li>
2023
2024           <li class="md-nav__item">
2025   <a href="#iconclassname" class="md-nav__link">
2026     &lt;iconclassname&gt;
2027   </a>
2028
2029 </li>
2030
2031           <li class="md-nav__item">
2032   <a href="#options" class="md-nav__link">
2033     &lt;options&gt;
2034   </a>
2035
2036 </li>
2037
2038           <li class="md-nav__item">
2039   <a href="#permissions" class="md-nav__link">
2040     &lt;permissions&gt;
2041   </a>
2042
2043 </li>
2044
2045           <li class="md-nav__item">
2046   <a href="#classname" class="md-nav__link">
2047     &lt;classname&gt;
2048   </a>
2049
2050 </li>
2051
2052       </ul>
2053     </nav>
2054
2055 </li>
2056
2057         <li class="md-nav__item">
2058   <a href="#example" class="md-nav__link">
2059     Example
2060   </a>
2061
2062 </li>
2063
2064     </ul>
2065
2066 </nav>
2067                   </div>
2068                 </div>
2069               </div>
2070
2071
2072           <div class="md-content" data-md-component="content">
2073             <article class="md-content__inner md-typeset">
2074
2075
2076                   <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">
2077                     <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>
2078                   </a>
2079
2080
2081                 <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>
2082 <p>Registers new user menu items.</p>
2083 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
2084 <p>Each item is described as an <code>&lt;usermenuitem&gt;</code> element with the mandatory attribute <code>name</code>.</p>
2085 <h3 id="parent"><code>&lt;parent&gt;</code><a class="headerlink" href="#parent" title="Permanent link">#</a></h3>
2086 <p><span class="label label-info">Optional</span></p>
2087 <p>The item’s parent item.</p>
2088 <h3 id="showorder"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder" title="Permanent link">#</a></h3>
2089 <p><span class="label label-info">Optional</span></p>
2090 <p>Specifies the order of this item within the parent item.</p>
2091 <h3 id="controller"><code>&lt;controller&gt;</code><a class="headerlink" href="#controller" title="Permanent link">#</a></h3>
2092 <p>The fully qualified class name of the target controller.
2093 If not specified this item serves as a category.</p>
2094 <h3 id="link"><code>&lt;link&gt;</code><a class="headerlink" href="#link" title="Permanent link">#</a></h3>
2095 <p>Additional components if <code>&lt;controller&gt;</code> is set,
2096 the full external link otherwise.</p>
2097 <h3 id="iconclassname"><code>&lt;iconclassname&gt;</code><a class="headerlink" href="#iconclassname" title="Permanent link">#</a></h3>
2098 <div class="admonition info">
2099 <p class="admonition-title">Use an icon only for top-level items.</p>
2100 </div>
2101 <p>Name of the Font Awesome icon class.</p>
2102 <h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2103 <p><span class="label label-info">Optional</span></p>
2104 <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>
2105 <h3 id="permissions"><code>&lt;permissions&gt;</code><a class="headerlink" href="#permissions" title="Permanent link">#</a></h3>
2106 <p><span class="label label-info">Optional</span></p>
2107 <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>
2108 <h3 id="classname"><code>&lt;classname&gt;</code><a class="headerlink" href="#classname" title="Permanent link">#</a></h3>
2109 <p>The name of the class providing the user menu item’s behaviour,
2110 the class has to implement the <code>wcf\system\menu\user\IUserMenuItemProvider</code> interface.</p>
2111 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2112 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2113 <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>
2114     <span class="nt">&lt;import&gt;</span>
2115         <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>
2116             <span class="nt">&lt;iconclassname&gt;</span>fa-home<span class="nt">&lt;/iconclassname&gt;</span>
2117         <span class="nt">&lt;/usermenuitem&gt;</span>
2118
2119         <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>
2120             <span class="nt">&lt;controller&gt;</span>wcf\page\FooBarListPage<span class="nt">&lt;/controller&gt;</span>
2121             <span class="nt">&lt;parent&gt;</span>wcf.user.menu.foo<span class="nt">&lt;/parent&gt;</span>
2122             <span class="nt">&lt;permissions&gt;</span>user.foo.canBar<span class="nt">&lt;/permissions&gt;</span>
2123             <span class="nt">&lt;classname&gt;</span>wcf\system\menu\user\FooBarMenuItemProvider<span class="nt">&lt;/classname&gt;</span>
2124         <span class="nt">&lt;/usermenuitem&gt;</span>
2125
2126         <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>
2127             <span class="nt">&lt;controller&gt;</span>wcf\page\FooBazListPage<span class="nt">&lt;/controller&gt;</span>
2128             <span class="nt">&lt;parent&gt;</span>wcf.user.menu.foo<span class="nt">&lt;/parent&gt;</span>
2129             <span class="nt">&lt;permissions&gt;</span>user.foo.canBaz<span class="nt">&lt;/permissions&gt;</span>
2130             <span class="nt">&lt;options&gt;</span>module_foo_bar<span class="nt">&lt;/options&gt;</span>
2131         <span class="nt">&lt;/usermenuitem&gt;</span>
2132     <span class="nt">&lt;/import&gt;</span>
2133 <span class="nt">&lt;/data&gt;</span>
2134 </code></pre></div>
2135
2136
2137
2138
2139 <hr>
2140 <div class="md-source-date">
2141   <small>
2142
2143       Last update: 2021-01-08
2144
2145   </small>
2146 </div>
2147
2148
2149
2150
2151
2152
2153
2154
2155             </article>
2156           </div>
2157         </div>
2158
2159       </main>
2160
2161
2162 <footer class="md-footer">
2163
2164     <nav class="md-footer__inner md-grid" aria-label="Footer">
2165
2166         <a href="../user-group-option/" class="md-footer__link md-footer__link--prev" rel="prev">
2167           <div class="md-footer__button md-icon">
2168             <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>
2169           </div>
2170           <div class="md-footer__title">
2171             <div class="md-ellipsis">
2172               <span class="md-footer__direction">
2173                 Previous
2174               </span>
2175               userGroupOption
2176             </div>
2177           </div>
2178         </a>
2179
2180
2181         <a href="../user-notification-event/" class="md-footer__link md-footer__link--next" rel="next">
2182           <div class="md-footer__title">
2183             <div class="md-ellipsis">
2184               <span class="md-footer__direction">
2185                 Next
2186               </span>
2187               userNotificationEvent
2188             </div>
2189           </div>
2190           <div class="md-footer__button md-icon">
2191             <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>
2192           </div>
2193         </a>
2194
2195     </nav>
2196
2197   <div class="md-footer-meta md-typeset">
2198     <div class="md-footer-meta__inner md-grid">
2199       <div class="md-footer-copyright">
2200
2201           <div class="md-footer-copyright__highlight">
2202             Copyright © 2020 WoltLab GmbH
2203           </div>
2204
2205         Made with
2206         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2207           Material for MkDocs
2208         </a>
2209
2210       </div>
2211       <div class="md-footer-copyright">
2212         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2213         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2214 </div>
2215     </div>
2216   </div>
2217 </footer>
2218
2219     </div>
2220     <div class="md-dialog" data-md-component="dialog">
2221       <div class="md-dialog__inner md-typeset"></div>
2222     </div>
2223     <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>
2224
2225
2226       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2227
2228
2229   </body>
2230 </html>