latest/package/pip/acp-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>acpMenu - 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="#acp-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               acpMenu
 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
 980
 981     <li class="md-nav__item md-nav__item--active">
 982
 983       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 984
 985
 986
 987
 988         <label class="md-nav__link md-nav__link--active" for="__toc">
 989           acpMenu
 990           <span class="md-nav__icon md-icon"></span>
 991         </label>
 992
 993       <a href="./" class="md-nav__link md-nav__link--active">
 994         acpMenu
 995       </a>
 996
 997
 998 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 999
1000
1001
1002
1003
1004     <label class="md-nav__title" for="__toc">
1005       <span class="md-nav__icon md-icon"></span>
1006       Table of contents
1007     </label>
1008     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1009
1010         <li class="md-nav__item">
1011   <a href="#components" class="md-nav__link">
1012     Components
1013   </a>
1014
1015     <nav class="md-nav" aria-label="Components">
1016       <ul class="md-nav__list">
1017
1018           <li class="md-nav__item">
1019   <a href="#parent" class="md-nav__link">
1020     &lt;parent&gt;
1021   </a>
1022
1023 </li>
1024
1025           <li class="md-nav__item">
1026   <a href="#showorder" class="md-nav__link">
1027     &lt;showorder&gt;
1028   </a>
1029
1030 </li>
1031
1032           <li class="md-nav__item">
1033   <a href="#controller" class="md-nav__link">
1034     &lt;controller&gt;
1035   </a>
1036
1037 </li>
1038
1039           <li class="md-nav__item">
1040   <a href="#link" class="md-nav__link">
1041     &lt;link&gt;
1042   </a>
1043
1044 </li>
1045
1046           <li class="md-nav__item">
1047   <a href="#icon" class="md-nav__link">
1048     &lt;icon&gt;
1049   </a>
1050
1051 </li>
1052
1053           <li class="md-nav__item">
1054   <a href="#options" class="md-nav__link">
1055     &lt;options&gt;
1056   </a>
1057
1058 </li>
1059
1060           <li class="md-nav__item">
1061   <a href="#permissions" class="md-nav__link">
1062     &lt;permissions&gt;
1063   </a>
1064
1065 </li>
1066
1067       </ul>
1068     </nav>
1069
1070 </li>
1071
1072         <li class="md-nav__item">
1073   <a href="#example" class="md-nav__link">
1074     Example
1075   </a>
1076
1077 </li>
1078
1079     </ul>
1080
1081 </nav>
1082
1083     </li>
1084
1085
1086
1087
1088
1089
1090
1091     <li class="md-nav__item">
1092       <a href="../acp-search-provider/" class="md-nav__link">
1093         acpSearchProvider
1094       </a>
1095     </li>
1096
1097
1098
1099
1100
1101
1102
1103     <li class="md-nav__item">
1104       <a href="../acp-template/" class="md-nav__link">
1105         acpTemplate
1106       </a>
1107     </li>
1108
1109
1110
1111
1112
1113
1114
1115     <li class="md-nav__item">
1116       <a href="../bbcode/" class="md-nav__link">
1117         bbcode
1118       </a>
1119     </li>
1120
1121
1122
1123
1124
1125
1126
1127     <li class="md-nav__item">
1128       <a href="../box/" class="md-nav__link">
1129         box
1130       </a>
1131     </li>
1132
1133
1134
1135
1136
1137
1138
1139     <li class="md-nav__item">
1140       <a href="../clipboard-action/" class="md-nav__link">
1141         clipboardAction
1142       </a>
1143     </li>
1144
1145
1146
1147
1148
1149
1150
1151     <li class="md-nav__item">
1152       <a href="../core-object/" class="md-nav__link">
1153         coreObject
1154       </a>
1155     </li>
1156
1157
1158
1159
1160
1161
1162
1163     <li class="md-nav__item">
1164       <a href="../cronjob/" class="md-nav__link">
1165         cronjob
1166       </a>
1167     </li>
1168
1169
1170
1171
1172
1173
1174
1175     <li class="md-nav__item">
1176       <a href="../database/" class="md-nav__link">
1177         database
1178       </a>
1179     </li>
1180
1181
1182
1183
1184
1185
1186
1187     <li class="md-nav__item">
1188       <a href="../event-listener/" class="md-nav__link">
1189         eventListener
1190       </a>
1191     </li>
1192
1193
1194
1195
1196
1197
1198
1199     <li class="md-nav__item">
1200       <a href="../file/" class="md-nav__link">
1201         file
1202       </a>
1203     </li>
1204
1205
1206
1207
1208
1209
1210
1211     <li class="md-nav__item">
1212       <a href="../language/" class="md-nav__link">
1213         language
1214       </a>
1215     </li>
1216
1217
1218
1219
1220
1221
1222
1223     <li class="md-nav__item">
1224       <a href="../media-provider/" class="md-nav__link">
1225         mediaProvider
1226       </a>
1227     </li>
1228
1229
1230
1231
1232
1233
1234
1235     <li class="md-nav__item">
1236       <a href="../menu/" class="md-nav__link">
1237         menu
1238       </a>
1239     </li>
1240
1241
1242
1243
1244
1245
1246
1247     <li class="md-nav__item">
1248       <a href="../menu-item/" class="md-nav__link">
1249         menuItem
1250       </a>
1251     </li>
1252
1253
1254
1255
1256
1257
1258
1259     <li class="md-nav__item">
1260       <a href="../object-type/" class="md-nav__link">
1261         objectType
1262       </a>
1263     </li>
1264
1265
1266
1267
1268
1269
1270
1271     <li class="md-nav__item">
1272       <a href="../object-type-definition/" class="md-nav__link">
1273         objectTypeDefinition
1274       </a>
1275     </li>
1276
1277
1278
1279
1280
1281
1282
1283     <li class="md-nav__item">
1284       <a href="../option/" class="md-nav__link">
1285         option
1286       </a>
1287     </li>
1288
1289
1290
1291
1292
1293
1294
1295     <li class="md-nav__item">
1296       <a href="../page/" class="md-nav__link">
1297         page
1298       </a>
1299     </li>
1300
1301
1302
1303
1304
1305
1306
1307     <li class="md-nav__item">
1308       <a href="../pip/" class="md-nav__link">
1309         pip
1310       </a>
1311     </li>
1312
1313
1314
1315
1316
1317
1318
1319     <li class="md-nav__item">
1320       <a href="../script/" class="md-nav__link">
1321         script
1322       </a>
1323     </li>
1324
1325
1326
1327
1328
1329
1330
1331     <li class="md-nav__item">
1332       <a href="../smiley/" class="md-nav__link">
1333         smiley
1334       </a>
1335     </li>
1336
1337
1338
1339
1340
1341
1342
1343     <li class="md-nav__item">
1344       <a href="../sql/" class="md-nav__link">
1345         sql
1346       </a>
1347     </li>
1348
1349
1350
1351
1352
1353
1354
1355     <li class="md-nav__item">
1356       <a href="../style/" class="md-nav__link">
1357         style
1358       </a>
1359     </li>
1360
1361
1362
1363
1364
1365
1366
1367     <li class="md-nav__item">
1368       <a href="../template/" class="md-nav__link">
1369         template
1370       </a>
1371     </li>
1372
1373
1374
1375
1376
1377
1378
1379     <li class="md-nav__item">
1380       <a href="../template-listener/" class="md-nav__link">
1381         templateListener
1382       </a>
1383     </li>
1384
1385
1386
1387
1388
1389
1390
1391     <li class="md-nav__item">
1392       <a href="../user-group-option/" class="md-nav__link">
1393         userGroupOption
1394       </a>
1395     </li>
1396
1397
1398
1399
1400
1401
1402
1403     <li class="md-nav__item">
1404       <a href="../user-menu/" class="md-nav__link">
1405         userMenu
1406       </a>
1407     </li>
1408
1409
1410
1411
1412
1413
1414
1415     <li class="md-nav__item">
1416       <a href="../user-notification-event/" class="md-nav__link">
1417         userNotificationEvent
1418       </a>
1419     </li>
1420
1421
1422
1423
1424
1425
1426
1427     <li class="md-nav__item">
1428       <a href="../user-option/" class="md-nav__link">
1429         userOption
1430       </a>
1431     </li>
1432
1433
1434
1435
1436
1437
1438
1439     <li class="md-nav__item">
1440       <a href="../user-profile-menu/" class="md-nav__link">
1441         userProfileMenu
1442       </a>
1443     </li>
1444
1445
1446
1447         </ul>
1448       </nav>
1449     </li>
1450
1451
1452
1453
1454
1455
1456
1457     <li class="md-nav__item">
1458       <a href="../../database-php-api/" class="md-nav__link">
1459         Database PHP API
1460       </a>
1461     </li>
1462
1463
1464
1465         </ul>
1466       </nav>
1467     </li>
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479     <li class="md-nav__item md-nav__item--nested">
1480
1481
1482         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1483
1484       <label class="md-nav__link" for="__nav_6">
1485         Migration
1486         <span class="md-nav__icon md-icon"></span>
1487       </label>
1488       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1489         <label class="md-nav__title" for="__nav_6">
1490           <span class="md-nav__icon md-icon"></span>
1491           Migration
1492         </label>
1493         <ul class="md-nav__list" data-md-scrollfix>
1494
1495
1496
1497
1498
1499
1500     <li class="md-nav__item md-nav__item--nested">
1501
1502
1503         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1504
1505       <label class="md-nav__link" for="__nav_6_1">
1506         Migrating from WSC 5.3
1507         <span class="md-nav__icon md-icon"></span>
1508       </label>
1509       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1510         <label class="md-nav__title" for="__nav_6_1">
1511           <span class="md-nav__icon md-icon"></span>
1512           Migrating from WSC 5.3
1513         </label>
1514         <ul class="md-nav__list" data-md-scrollfix>
1515
1516
1517
1518
1519
1520     <li class="md-nav__item">
1521       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1522         PHP API
1523       </a>
1524     </li>
1525
1526
1527
1528
1529
1530
1531
1532     <li class="md-nav__item">
1533       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1534         Session Handling and Authentication
1535       </a>
1536     </li>
1537
1538
1539
1540
1541
1542
1543
1544     <li class="md-nav__item">
1545       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1546         TypeScript and JavaScript
1547       </a>
1548     </li>
1549
1550
1551
1552
1553
1554
1555
1556     <li class="md-nav__item">
1557       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1558         Templates
1559       </a>
1560     </li>
1561
1562
1563
1564
1565
1566
1567
1568     <li class="md-nav__item">
1569       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1570         Third Party Libraries
1571       </a>
1572     </li>
1573
1574
1575
1576         </ul>
1577       </nav>
1578     </li>
1579
1580
1581
1582
1583
1584
1585
1586
1587     <li class="md-nav__item md-nav__item--nested">
1588
1589
1590         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1591
1592       <label class="md-nav__link" for="__nav_6_2">
1593         Migrating from WSC 5.2
1594         <span class="md-nav__icon md-icon"></span>
1595       </label>
1596       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1597         <label class="md-nav__title" for="__nav_6_2">
1598           <span class="md-nav__icon md-icon"></span>
1599           Migrating from WSC 5.2
1600         </label>
1601         <ul class="md-nav__list" data-md-scrollfix>
1602
1603
1604
1605
1606
1607     <li class="md-nav__item">
1608       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1609         PHP API
1610       </a>
1611     </li>
1612
1613
1614
1615
1616
1617
1618
1619     <li class="md-nav__item">
1620       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1621         Templates and Languages
1622       </a>
1623     </li>
1624
1625
1626
1627
1628
1629
1630
1631     <li class="md-nav__item">
1632       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1633         Third Party Libraries
1634       </a>
1635     </li>
1636
1637
1638
1639         </ul>
1640       </nav>
1641     </li>
1642
1643
1644
1645
1646
1647
1648
1649
1650     <li class="md-nav__item md-nav__item--nested">
1651
1652
1653         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1654
1655       <label class="md-nav__link" for="__nav_6_3">
1656         Migrating from WSC 3.1
1657         <span class="md-nav__icon md-icon"></span>
1658       </label>
1659       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1660         <label class="md-nav__title" for="__nav_6_3">
1661           <span class="md-nav__icon md-icon"></span>
1662           Migrating from WSC 3.1
1663         </label>
1664         <ul class="md-nav__list" data-md-scrollfix>
1665
1666
1667
1668
1669
1670     <li class="md-nav__item">
1671       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1672         PHP API
1673       </a>
1674     </li>
1675
1676
1677
1678         </ul>
1679       </nav>
1680     </li>
1681
1682
1683
1684
1685
1686
1687
1688
1689     <li class="md-nav__item md-nav__item--nested">
1690
1691
1692         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1693
1694       <label class="md-nav__link" for="__nav_6_4">
1695         Migrating from WSC 3.0
1696         <span class="md-nav__icon md-icon"></span>
1697       </label>
1698       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1699         <label class="md-nav__title" for="__nav_6_4">
1700           <span class="md-nav__icon md-icon"></span>
1701           Migrating from WSC 3.0
1702         </label>
1703         <ul class="md-nav__list" data-md-scrollfix>
1704
1705
1706
1707
1708
1709     <li class="md-nav__item">
1710       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1711         PHP API
1712       </a>
1713     </li>
1714
1715
1716
1717
1718
1719
1720
1721     <li class="md-nav__item">
1722       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1723         JavaScript API
1724       </a>
1725     </li>
1726
1727
1728
1729
1730
1731
1732
1733     <li class="md-nav__item">
1734       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1735         Templates
1736       </a>
1737     </li>
1738
1739
1740
1741
1742
1743
1744
1745     <li class="md-nav__item">
1746       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1747         CSS
1748       </a>
1749     </li>
1750
1751
1752
1753
1754
1755
1756
1757     <li class="md-nav__item">
1758       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1759         Package Components
1760       </a>
1761     </li>
1762
1763
1764
1765         </ul>
1766       </nav>
1767     </li>
1768
1769
1770
1771
1772
1773
1774
1775
1776     <li class="md-nav__item md-nav__item--nested">
1777
1778
1779         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1780
1781       <label class="md-nav__link" for="__nav_6_5">
1782         Migrating from WCF 2.1
1783         <span class="md-nav__icon md-icon"></span>
1784       </label>
1785       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1786         <label class="md-nav__title" for="__nav_6_5">
1787           <span class="md-nav__icon md-icon"></span>
1788           Migrating from WCF 2.1
1789         </label>
1790         <ul class="md-nav__list" data-md-scrollfix>
1791
1792
1793
1794
1795
1796     <li class="md-nav__item">
1797       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1798         PHP API
1799       </a>
1800     </li>
1801
1802
1803
1804
1805
1806
1807
1808     <li class="md-nav__item">
1809       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1810         Templates
1811       </a>
1812     </li>
1813
1814
1815
1816
1817
1818
1819
1820     <li class="md-nav__item">
1821       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1822         CSS
1823       </a>
1824     </li>
1825
1826
1827
1828
1829
1830
1831
1832     <li class="md-nav__item">
1833       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1834         Package Components
1835       </a>
1836     </li>
1837
1838
1839
1840         </ul>
1841       </nav>
1842     </li>
1843
1844
1845
1846         </ul>
1847       </nav>
1848     </li>
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860     <li class="md-nav__item md-nav__item--nested">
1861
1862
1863         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1864
1865       <label class="md-nav__link" for="__nav_7">
1866         Tutorials
1867         <span class="md-nav__icon md-icon"></span>
1868       </label>
1869       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1870         <label class="md-nav__title" for="__nav_7">
1871           <span class="md-nav__icon md-icon"></span>
1872           Tutorials
1873         </label>
1874         <ul class="md-nav__list" data-md-scrollfix>
1875
1876
1877
1878
1879
1880
1881     <li class="md-nav__item md-nav__item--nested">
1882
1883
1884         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1885
1886       <label class="md-nav__link" for="__nav_7_1">
1887         Tutorial Series
1888         <span class="md-nav__icon md-icon"></span>
1889       </label>
1890       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1891         <label class="md-nav__title" for="__nav_7_1">
1892           <span class="md-nav__icon md-icon"></span>
1893           Tutorial Series
1894         </label>
1895         <ul class="md-nav__list" data-md-scrollfix>
1896
1897
1898
1899
1900
1901     <li class="md-nav__item">
1902       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1903         Overview
1904       </a>
1905     </li>
1906
1907
1908
1909
1910
1911
1912
1913     <li class="md-nav__item">
1914       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1915         Part 1
1916       </a>
1917     </li>
1918
1919
1920
1921
1922
1923
1924
1925     <li class="md-nav__item">
1926       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1927         Part 2
1928       </a>
1929     </li>
1930
1931
1932
1933
1934
1935
1936
1937     <li class="md-nav__item">
1938       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1939         Part 3
1940       </a>
1941     </li>
1942
1943
1944
1945         </ul>
1946       </nav>
1947     </li>
1948
1949
1950
1951         </ul>
1952       </nav>
1953     </li>
1954
1955
1956
1957   </ul>
1958 </nav>
1959                   </div>
1960                 </div>
1961               </div>
1962
1963
1964
1965               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1966                 <div class="md-sidebar__scrollwrap">
1967                   <div class="md-sidebar__inner">
1968
1969 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1970
1971
1972
1973
1974
1975     <label class="md-nav__title" for="__toc">
1976       <span class="md-nav__icon md-icon"></span>
1977       Table of contents
1978     </label>
1979     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1980
1981         <li class="md-nav__item">
1982   <a href="#components" class="md-nav__link">
1983     Components
1984   </a>
1985
1986     <nav class="md-nav" aria-label="Components">
1987       <ul class="md-nav__list">
1988
1989           <li class="md-nav__item">
1990   <a href="#parent" class="md-nav__link">
1991     &lt;parent&gt;
1992   </a>
1993
1994 </li>
1995
1996           <li class="md-nav__item">
1997   <a href="#showorder" class="md-nav__link">
1998     &lt;showorder&gt;
1999   </a>
2000
2001 </li>
2002
2003           <li class="md-nav__item">
2004   <a href="#controller" class="md-nav__link">
2005     &lt;controller&gt;
2006   </a>
2007
2008 </li>
2009
2010           <li class="md-nav__item">
2011   <a href="#link" class="md-nav__link">
2012     &lt;link&gt;
2013   </a>
2014
2015 </li>
2016
2017           <li class="md-nav__item">
2018   <a href="#icon" class="md-nav__link">
2019     &lt;icon&gt;
2020   </a>
2021
2022 </li>
2023
2024           <li class="md-nav__item">
2025   <a href="#options" class="md-nav__link">
2026     &lt;options&gt;
2027   </a>
2028
2029 </li>
2030
2031           <li class="md-nav__item">
2032   <a href="#permissions" class="md-nav__link">
2033     &lt;permissions&gt;
2034   </a>
2035
2036 </li>
2037
2038       </ul>
2039     </nav>
2040
2041 </li>
2042
2043         <li class="md-nav__item">
2044   <a href="#example" class="md-nav__link">
2045     Example
2046   </a>
2047
2048 </li>
2049
2050     </ul>
2051
2052 </nav>
2053                   </div>
2054                 </div>
2055               </div>
2056
2057
2058           <div class="md-content" data-md-component="content">
2059             <article class="md-content__inner md-typeset">
2060
2061
2062                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/acp-menu.md" title="Edit this page" class="md-content__button md-icon">
2063                     <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>
2064                   </a>
2065
2066
2067                 <h1 id="acp-menu-package-installation-plugin">ACP Menu Package Installation Plugin<a class="headerlink" href="#acp-menu-package-installation-plugin" title="Permanent link">#</a></h1>
2068 <p>Registers new ACP menu items.</p>
2069 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
2070 <p>Each item is described as an <code>&lt;acpmenuitem&gt;</code> element with the mandatory attribute <code>name</code>.</p>
2071 <h3 id="parent"><code>&lt;parent&gt;</code><a class="headerlink" href="#parent" title="Permanent link">#</a></h3>
2072 <p><span class="label label-info">Optional</span></p>
2073 <p>The item’s parent item.</p>
2074 <h3 id="showorder"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder" title="Permanent link">#</a></h3>
2075 <p><span class="label label-info">Optional</span></p>
2076 <p>Specifies the order of this item within the parent item.</p>
2077 <h3 id="controller"><code>&lt;controller&gt;</code><a class="headerlink" href="#controller" title="Permanent link">#</a></h3>
2078 <p>The fully qualified class name of the target controller.
2079 If not specified this item serves as a category.</p>
2080 <h3 id="link"><code>&lt;link&gt;</code><a class="headerlink" href="#link" title="Permanent link">#</a></h3>
2081 <p>Additional components if <code>&lt;controller&gt;</code> is set,
2082 the full external link otherwise.</p>
2083 <h3 id="icon"><code>&lt;icon&gt;</code><a class="headerlink" href="#icon" title="Permanent link">#</a></h3>
2084 <div class="admonition info">
2085 <p class="admonition-title">Use an icon only for top-level and 4th-level items.</p>
2086 </div>
2087 <p>Name of the Font Awesome icon class.</p>
2088 <h3 id="options"><code>&lt;options&gt;</code><a class="headerlink" href="#options" title="Permanent link">#</a></h3>
2089 <p><span class="label label-info">Optional</span></p>
2090 <p>The options element can contain a comma-separated list of options of which at least one needs to be enabled for the tab to be shown.</p>
2091 <h3 id="permissions"><code>&lt;permissions&gt;</code><a class="headerlink" href="#permissions" title="Permanent link">#</a></h3>
2092 <p><span class="label label-info">Optional</span></p>
2093 <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 tab to be shown.</p>
2094 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2095 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2096 <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/acpMenu.xsd&quot;</span><span class="nt">&gt;</span>
2097     <span class="nt">&lt;import&gt;</span>
2098         <span class="nt">&lt;acpmenuitem</span> <span class="na">name=</span><span class="s">&quot;foo.acp.menu.link.example&quot;</span><span class="nt">&gt;</span>
2099             <span class="nt">&lt;parent&gt;</span>wcf.acp.menu.link.application<span class="nt">&lt;/parent&gt;</span>
2100         <span class="nt">&lt;/acpmenuitem&gt;</span>
2101
2102         <span class="nt">&lt;acpmenuitem</span> <span class="na">name=</span><span class="s">&quot;foo.acp.menu.link.example.list&quot;</span><span class="nt">&gt;</span>
2103             <span class="nt">&lt;controller&gt;</span>foo\acp\page\ExampleListPage<span class="nt">&lt;/controller&gt;</span>
2104             <span class="nt">&lt;parent&gt;</span>foo.acp.menu.link.example<span class="nt">&lt;/parent&gt;</span>
2105             <span class="nt">&lt;permissions&gt;</span>admin.foo.canManageExample<span class="nt">&lt;/permissions&gt;</span>
2106             <span class="nt">&lt;showorder&gt;</span>1<span class="nt">&lt;/showorder&gt;</span>
2107         <span class="nt">&lt;/acpmenuitem&gt;</span>
2108
2109         <span class="nt">&lt;acpmenuitem</span> <span class="na">name=</span><span class="s">&quot;foo.acp.menu.link.example.add&quot;</span><span class="nt">&gt;</span>
2110             <span class="nt">&lt;controller&gt;</span>foo\acp\form\ExampleAddForm<span class="nt">&lt;/controller&gt;</span>
2111             <span class="nt">&lt;parent&gt;</span>foo.acp.menu.link.example.list<span class="nt">&lt;/parent&gt;</span>
2112             <span class="nt">&lt;permissions&gt;</span>admin.foo.canManageExample<span class="nt">&lt;/permissions&gt;</span>
2113             <span class="nt">&lt;icon&gt;</span>fa-plus<span class="nt">&lt;/icon&gt;</span>
2114         <span class="nt">&lt;/acpmenuitem&gt;</span>
2115     <span class="nt">&lt;/import&gt;</span>
2116 <span class="nt">&lt;/data&gt;</span>
2117 </code></pre></div>
2118
2119
2120
2121
2122 <hr>
2123 <div class="md-source-date">
2124   <small>
2125
2126       Last update: 2021-01-08
2127
2128   </small>
2129 </div>
2130
2131
2132
2133
2134
2135
2136
2137
2138             </article>
2139           </div>
2140         </div>
2141
2142       </main>
2143
2144
2145 <footer class="md-footer">
2146
2147     <nav class="md-footer__inner md-grid" aria-label="Footer">
2148
2149         <a href="../acl-option/" class="md-footer__link md-footer__link--prev" rel="prev">
2150           <div class="md-footer__button md-icon">
2151             <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>
2152           </div>
2153           <div class="md-footer__title">
2154             <div class="md-ellipsis">
2155               <span class="md-footer__direction">
2156                 Previous
2157               </span>
2158               aclOption
2159             </div>
2160           </div>
2161         </a>
2162
2163
2164         <a href="../acp-search-provider/" class="md-footer__link md-footer__link--next" rel="next">
2165           <div class="md-footer__title">
2166             <div class="md-ellipsis">
2167               <span class="md-footer__direction">
2168                 Next
2169               </span>
2170               acpSearchProvider
2171             </div>
2172           </div>
2173           <div class="md-footer__button md-icon">
2174             <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>
2175           </div>
2176         </a>
2177
2178     </nav>
2179
2180   <div class="md-footer-meta md-typeset">
2181     <div class="md-footer-meta__inner md-grid">
2182       <div class="md-footer-copyright">
2183
2184           <div class="md-footer-copyright__highlight">
2185             Copyright © 2020 WoltLab GmbH
2186           </div>
2187
2188         Made with
2189         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2190           Material for MkDocs
2191         </a>
2192
2193       </div>
2194       <div class="md-footer-copyright">
2195         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2196         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2197 </div>
2198     </div>
2199   </div>
2200 </footer>
2201
2202     </div>
2203     <div class="md-dialog" data-md-component="dialog">
2204       <div class="md-dialog__inner md-typeset"></div>
2205     </div>
2206     <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>
2207
2208
2209       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2210
2211
2212   </body>
2213 </html>