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