6.0/package/pip/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         <link rel="canonical" href="https://docs.woltlab.com/6.0/package/pip/menu/">
  12
  13
  14         <link rel="prev" href="../media-provider/">
  15
  16
  17         <link rel="next" href="../menu-item/">
  18
  19       <link rel="icon" href="../../../assets/default.favicon.ico">
  20       <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.15">
  21
  22
  23
  24         <title>menu - WoltLab Suite Documentation</title>
  25
  26
  27
  28       <link rel="stylesheet" href="../../../assets/stylesheets/main.26e3688c.min.css">
  29
  30
  31         <link rel="stylesheet" href="../../../assets/stylesheets/palette.ecc896b0.min.css">
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  42
  43     <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  44
  45
  46
  47
  48
  49
  50   </head>
  51
  52
  53
  54
  55
  56
  57
  58     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  59
  60
  61
  62     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  63     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  64     <label class="md-overlay" for="__drawer"></label>
  65     <div data-md-component="skip">
  66
  67
  68         <a href="#menu-package-installation-plugin" class="md-skip">
  69           Skip to content
  70         </a>
  71
  72     </div>
  73     <div data-md-component="announce">
  74
  75         <aside class="md-banner">
  76           <div class="md-banner__inner md-grid md-typeset">
  77
  78
  79     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  80
  81           </div>
  82
  83         </aside>
  84
  85     </div>
  86
  87       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  88
  89       </div>
  90
  91
  92
  93
  94
  95
  96 <header class="md-header md-header--shadow" data-md-component="header">
  97   <nav class="md-header__inner md-grid" aria-label="Header">
  98     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  99
 100   <img src="../../../assets/logo.png" alt="logo">
 101
 102     </a>
 103     <label class="md-header__button md-icon" for="__drawer">
 104       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 105     </label>
 106     <div class="md-header__title" data-md-component="header-title">
 107       <div class="md-header__ellipsis">
 108         <div class="md-header__topic">
 109           <span class="md-ellipsis">
 110             WoltLab Suite Documentation
 111           </span>
 112         </div>
 113         <div class="md-header__topic" data-md-component="header-topic">
 114           <span class="md-ellipsis">
 115
 116               menu
 117
 118           </span>
 119         </div>
 120       </div>
 121     </div>
 122
 123
 124
 125
 126
 127       <label class="md-header__button md-icon" for="__search">
 128         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
 129       </label>
 130       <div class="md-search" data-md-component="search" role="dialog">
 131   <label class="md-search__overlay" for="__search"></label>
 132   <div class="md-search__inner" role="search">
 133     <form class="md-search__form" name="search">
 134       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
 135       <label class="md-search__icon md-icon" for="__search">
 136         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
 137         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
 138       </label>
 139       <nav class="md-search__options" aria-label="Search">
 140
 141         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 142           <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
 143         </button>
 144       </nav>
 145
 146     </form>
 147     <div class="md-search__output">
 148       <div class="md-search__scrollwrap" data-md-scrollfix>
 149         <div class="md-search-result" data-md-component="search-result">
 150           <div class="md-search-result__meta">
 151             Initializing search
 152           </div>
 153           <ol class="md-search-result__list" role="presentation"></ol>
 154         </div>
 155       </div>
 156     </div>
 157   </div>
 158 </div>
 159
 160
 161       <div class="md-header__source">
 162         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 163   <div class="md-source__icon md-icon">
 164
 165     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 166   </div>
 167   <div class="md-source__repository">
 168     GitHub
 169   </div>
 170 </a>
 171       </div>
 172
 173   </nav>
 174
 175 </header>
 176
 177     <div class="md-container" data-md-component="container">
 178
 179
 180
 181
 182
 183
 184       <main class="md-main" data-md-component="main">
 185         <div class="md-main__inner md-grid">
 186
 187
 188
 189               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 190                 <div class="md-sidebar__scrollwrap">
 191                   <div class="md-sidebar__inner">
 192
 193
 194
 195 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 196   <label class="md-nav__title" for="__drawer">
 197     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 198
 199   <img src="../../../assets/logo.png" alt="logo">
 200
 201     </a>
 202     WoltLab Suite Documentation
 203   </label>
 204
 205     <div class="md-nav__source">
 206       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 207   <div class="md-source__icon md-icon">
 208
 209     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 210   </div>
 211   <div class="md-source__repository">
 212     GitHub
 213   </div>
 214 </a>
 215     </div>
 216
 217   <ul class="md-nav__list" data-md-scrollfix>
 218
 219
 220
 221
 222
 223
 224
 225
 226     <li class="md-nav__item">
 227       <a href="../../../getting-started/" class="md-nav__link">
 228         Getting Started
 229       </a>
 230     </li>
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242     <li class="md-nav__item md-nav__item--nested">
 243
 244
 245
 246
 247       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 248
 249
 250
 251         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 252           PHP API
 253           <span class="md-nav__icon md-icon"></span>
 254         </label>
 255
 256       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 257         <label class="md-nav__title" for="__nav_2">
 258           <span class="md-nav__icon md-icon"></span>
 259           PHP API
 260         </label>
 261         <ul class="md-nav__list" data-md-scrollfix>
 262
 263
 264
 265
 266
 267
 268     <li class="md-nav__item">
 269       <a href="../../../php/pages/" class="md-nav__link">
 270         Pages
 271       </a>
 272     </li>
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282     <li class="md-nav__item">
 283       <a href="../../../php/database-objects/" class="md-nav__link">
 284         Database Objects
 285       </a>
 286     </li>
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296     <li class="md-nav__item">
 297       <a href="../../../php/database-access/" class="md-nav__link">
 298         Database Access
 299       </a>
 300     </li>
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item">
 311       <a href="../../../php/exceptions/" class="md-nav__link">
 312         Exceptions
 313       </a>
 314     </li>
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325     <li class="md-nav__item md-nav__item--nested">
 326
 327
 328
 329
 330       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 331
 332
 333
 334         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 335           API
 336           <span class="md-nav__icon md-icon"></span>
 337         </label>
 338
 339       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 340         <label class="md-nav__title" for="__nav_2_5">
 341           <span class="md-nav__icon md-icon"></span>
 342           API
 343         </label>
 344         <ul class="md-nav__list" data-md-scrollfix>
 345
 346
 347
 348
 349
 350
 351
 352     <li class="md-nav__item md-nav__item--nested">
 353
 354
 355
 356
 357       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 358
 359
 360
 361         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 362           Caches
 363           <span class="md-nav__icon md-icon"></span>
 364         </label>
 365
 366       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 367         <label class="md-nav__title" for="__nav_2_5_1">
 368           <span class="md-nav__icon md-icon"></span>
 369           Caches
 370         </label>
 371         <ul class="md-nav__list" data-md-scrollfix>
 372
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../../php/api/caches/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392     <li class="md-nav__item">
 393       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 394         Persistent Caches
 395       </a>
 396     </li>
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406     <li class="md-nav__item">
 407       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 408         Runtime Caches
 409       </a>
 410     </li>
 411
 412
 413
 414
 415         </ul>
 416       </nav>
 417     </li>
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427     <li class="md-nav__item">
 428       <a href="../../../php/api/comments/" class="md-nav__link">
 429         Comments
 430       </a>
 431     </li>
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 443         Cronjobs
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455     <li class="md-nav__item">
 456       <a href="../../../php/api/events/" class="md-nav__link">
 457         Events
 458       </a>
 459     </li>
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470     <li class="md-nav__item md-nav__item--nested">
 471
 472
 473
 474
 475       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 476
 477
 478
 479         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 480           Form Builder
 481           <span class="md-nav__icon md-icon"></span>
 482         </label>
 483
 484       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 485         <label class="md-nav__title" for="__nav_2_5_5">
 486           <span class="md-nav__icon md-icon"></span>
 487           Form Builder
 488         </label>
 489         <ul class="md-nav__list" data-md-scrollfix>
 490
 491
 492
 493
 494
 495
 496     <li class="md-nav__item">
 497       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 498         Overview
 499       </a>
 500     </li>
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 512         Structure
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524     <li class="md-nav__item">
 525       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 526         Fields
 527       </a>
 528     </li>
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538     <li class="md-nav__item">
 539       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 540         Validation and Data
 541       </a>
 542     </li>
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552     <li class="md-nav__item">
 553       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 554         Dependencies
 555       </a>
 556     </li>
 557
 558
 559
 560
 561         </ul>
 562       </nav>
 563     </li>
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 575         Package Installation Plugins
 576       </a>
 577     </li>
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587     <li class="md-nav__item">
 588       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 589         User Activity Points
 590       </a>
 591     </li>
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601     <li class="md-nav__item">
 602       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 603         User Notifications
 604       </a>
 605     </li>
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 617         Sitemaps
 618       </a>
 619     </li>
 620
 621
 622
 623
 624         </ul>
 625       </nav>
 626     </li>
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636     <li class="md-nav__item">
 637       <a href="../../../php/code-style/" class="md-nav__link">
 638         Code Style
 639       </a>
 640     </li>
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650     <li class="md-nav__item">
 651       <a href="../../../php/apps/" class="md-nav__link">
 652         Apps
 653       </a>
 654     </li>
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664     <li class="md-nav__item">
 665       <a href="../../../php/gdpr/" class="md-nav__link">
 666         GDPR
 667       </a>
 668     </li>
 669
 670
 671
 672
 673         </ul>
 674       </nav>
 675     </li>
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item md-nav__item--nested">
 688
 689
 690
 691
 692       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 693
 694
 695
 696         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 697           Languages, Templates & CSS
 698           <span class="md-nav__icon md-icon"></span>
 699         </label>
 700
 701       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 702         <label class="md-nav__title" for="__nav_3">
 703           <span class="md-nav__icon md-icon"></span>
 704           Languages, Templates & CSS
 705         </label>
 706         <ul class="md-nav__list" data-md-scrollfix>
 707
 708
 709
 710
 711
 712
 713     <li class="md-nav__item">
 714       <a href="../../../view/languages/" class="md-nav__link">
 715         Languages
 716       </a>
 717     </li>
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727     <li class="md-nav__item">
 728       <a href="../../../view/templates/" class="md-nav__link">
 729         Templates
 730       </a>
 731     </li>
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741     <li class="md-nav__item">
 742       <a href="../../../view/template-modifiers/" class="md-nav__link">
 743         Template Modifiers
 744       </a>
 745     </li>
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755     <li class="md-nav__item">
 756       <a href="../../../view/template-plugins/" class="md-nav__link">
 757         Template Plugins
 758       </a>
 759     </li>
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769     <li class="md-nav__item">
 770       <a href="../../../view/css/" class="md-nav__link">
 771         CSS
 772       </a>
 773     </li>
 774
 775
 776
 777
 778         </ul>
 779       </nav>
 780     </li>
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792     <li class="md-nav__item md-nav__item--nested">
 793
 794
 795
 796
 797       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
 798
 799
 800
 801         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
 802           TypeScript and JavaScript API
 803           <span class="md-nav__icon md-icon"></span>
 804         </label>
 805
 806       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
 807         <label class="md-nav__title" for="__nav_4">
 808           <span class="md-nav__icon md-icon"></span>
 809           TypeScript and JavaScript API
 810         </label>
 811         <ul class="md-nav__list" data-md-scrollfix>
 812
 813
 814
 815
 816
 817
 818     <li class="md-nav__item">
 819       <a href="../../../javascript/general-usage/" class="md-nav__link">
 820         General Usage
 821       </a>
 822     </li>
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832     <li class="md-nav__item">
 833       <a href="../../../javascript/typescript/" class="md-nav__link">
 834         TypeScript
 835       </a>
 836     </li>
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847     <li class="md-nav__item md-nav__item--nested">
 848
 849
 850
 851
 852       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
 853
 854
 855
 856         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
 857           Components
 858           <span class="md-nav__icon md-icon"></span>
 859         </label>
 860
 861       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
 862         <label class="md-nav__title" for="__nav_4_3">
 863           <span class="md-nav__icon md-icon"></span>
 864           Components
 865         </label>
 866         <ul class="md-nav__list" data-md-scrollfix>
 867
 868
 869
 870
 871
 872
 873     <li class="md-nav__item">
 874       <a href="../../../javascript/components_confirmation/" class="md-nav__link">
 875         Confirmation
 876       </a>
 877     </li>
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887     <li class="md-nav__item">
 888       <a href="../../../javascript/components_dialog/" class="md-nav__link">
 889         Dialog
 890       </a>
 891     </li>
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901     <li class="md-nav__item">
 902       <a href="../../../javascript/components_google_maps/" class="md-nav__link">
 903         Google Maps
 904       </a>
 905     </li>
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915     <li class="md-nav__item">
 916       <a href="../../../javascript/components_pagination/" class="md-nav__link">
 917         Pagination
 918       </a>
 919     </li>
 920
 921
 922
 923
 924         </ul>
 925       </nav>
 926     </li>
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937     <li class="md-nav__item md-nav__item--nested">
 938
 939
 940
 941
 942       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
 943
 944
 945
 946         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
 947           New API
 948           <span class="md-nav__icon md-icon"></span>
 949         </label>
 950
 951       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
 952         <label class="md-nav__title" for="__nav_4_4">
 953           <span class="md-nav__icon md-icon"></span>
 954           New API
 955         </label>
 956         <ul class="md-nav__list" data-md-scrollfix>
 957
 958
 959
 960
 961
 962
 963     <li class="md-nav__item">
 964       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 965         Writing a module
 966       </a>
 967     </li>
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977     <li class="md-nav__item">
 978       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 979         Core Functions
 980       </a>
 981     </li>
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991     <li class="md-nav__item">
 992       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 993         DOM
 994       </a>
 995     </li>
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005     <li class="md-nav__item">
1006       <a href="../../../javascript/new-api_events/" class="md-nav__link">
1007         Event Handling
1008       </a>
1009     </li>
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019     <li class="md-nav__item">
1020       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1021         Ajax
1022       </a>
1023     </li>
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033     <li class="md-nav__item">
1034       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1035         Dialogs
1036       </a>
1037     </li>
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047     <li class="md-nav__item">
1048       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1049         Browser and Screen Sizes
1050       </a>
1051     </li>
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061     <li class="md-nav__item">
1062       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1063         User Interface
1064       </a>
1065     </li>
1066
1067
1068
1069
1070         </ul>
1071       </nav>
1072     </li>
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082     <li class="md-nav__item">
1083       <a href="../../../javascript/legacy-api/" class="md-nav__link">
1084         Legacy API
1085       </a>
1086     </li>
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096     <li class="md-nav__item">
1097       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1098         Code Snippets
1099       </a>
1100     </li>
1101
1102
1103
1104
1105         </ul>
1106       </nav>
1107     </li>
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1122
1123
1124
1125
1126       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
1127
1128
1129
1130         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1131           Package Components
1132           <span class="md-nav__icon md-icon"></span>
1133         </label>
1134
1135       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
1136         <label class="md-nav__title" for="__nav_5">
1137           <span class="md-nav__icon md-icon"></span>
1138           Package Components
1139         </label>
1140         <ul class="md-nav__list" data-md-scrollfix>
1141
1142
1143
1144
1145
1146
1147     <li class="md-nav__item">
1148       <a href="../../package-xml/" class="md-nav__link">
1149         package.xml
1150       </a>
1151     </li>
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1165
1166
1167
1168
1169       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" checked>
1170
1171
1172
1173         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1174           PIPs
1175           <span class="md-nav__icon md-icon"></span>
1176         </label>
1177
1178       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="true">
1179         <label class="md-nav__title" for="__nav_5_2">
1180           <span class="md-nav__icon md-icon"></span>
1181           PIPs
1182         </label>
1183         <ul class="md-nav__list" data-md-scrollfix>
1184
1185
1186
1187
1188
1189
1190     <li class="md-nav__item">
1191       <a href="../" class="md-nav__link">
1192         Overview
1193       </a>
1194     </li>
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204     <li class="md-nav__item">
1205       <a href="../acl-option/" class="md-nav__link">
1206         aclOption
1207       </a>
1208     </li>
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218     <li class="md-nav__item">
1219       <a href="../acp-menu/" class="md-nav__link">
1220         acpMenu
1221       </a>
1222     </li>
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232     <li class="md-nav__item">
1233       <a href="../acp-search-provider/" class="md-nav__link">
1234         acpSearchProvider
1235       </a>
1236     </li>
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246     <li class="md-nav__item">
1247       <a href="../acp-template/" class="md-nav__link">
1248         acpTemplate
1249       </a>
1250     </li>
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260     <li class="md-nav__item">
1261       <a href="../acp-template-delete/" class="md-nav__link">
1262         acpTemplateDelete
1263       </a>
1264     </li>
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274     <li class="md-nav__item">
1275       <a href="../bbcode/" class="md-nav__link">
1276         bbcode
1277       </a>
1278     </li>
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288     <li class="md-nav__item">
1289       <a href="../box/" class="md-nav__link">
1290         box
1291       </a>
1292     </li>
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302     <li class="md-nav__item">
1303       <a href="../clipboard-action/" class="md-nav__link">
1304         clipboardAction
1305       </a>
1306     </li>
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316     <li class="md-nav__item">
1317       <a href="../core-object/" class="md-nav__link">
1318         coreObject
1319       </a>
1320     </li>
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330     <li class="md-nav__item">
1331       <a href="../cronjob/" class="md-nav__link">
1332         cronjob
1333       </a>
1334     </li>
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344     <li class="md-nav__item">
1345       <a href="../database/" class="md-nav__link">
1346         database
1347       </a>
1348     </li>
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358     <li class="md-nav__item">
1359       <a href="../event-listener/" class="md-nav__link">
1360         eventListener
1361       </a>
1362     </li>
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372     <li class="md-nav__item">
1373       <a href="../file/" class="md-nav__link">
1374         file
1375       </a>
1376     </li>
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386     <li class="md-nav__item">
1387       <a href="../file-delete/" class="md-nav__link">
1388         fileDelete
1389       </a>
1390     </li>
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400     <li class="md-nav__item">
1401       <a href="../language/" class="md-nav__link">
1402         language
1403       </a>
1404     </li>
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414     <li class="md-nav__item">
1415       <a href="../media-provider/" class="md-nav__link">
1416         mediaProvider
1417       </a>
1418     </li>
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430     <li class="md-nav__item md-nav__item--active">
1431
1432       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1433
1434
1435
1436
1437
1438         <label class="md-nav__link md-nav__link--active" for="__toc">
1439           menu
1440           <span class="md-nav__icon md-icon"></span>
1441         </label>
1442
1443       <a href="./" class="md-nav__link md-nav__link--active">
1444         menu
1445       </a>
1446
1447
1448
1449 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1450
1451
1452
1453
1454
1455
1456     <label class="md-nav__title" for="__toc">
1457       <span class="md-nav__icon md-icon"></span>
1458       Table of contents
1459     </label>
1460     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1461
1462         <li class="md-nav__item">
1463   <a href="#components" class="md-nav__link">
1464     Components
1465   </a>
1466
1467     <nav class="md-nav" aria-label="Components">
1468       <ul class="md-nav__list">
1469
1470           <li class="md-nav__item">
1471   <a href="#title" class="md-nav__link">
1472     &lt;title&gt;
1473   </a>
1474
1475 </li>
1476
1477           <li class="md-nav__item">
1478   <a href="#box" class="md-nav__link">
1479     &lt;box&gt;
1480   </a>
1481
1482 </li>
1483
1484       </ul>
1485     </nav>
1486
1487 </li>
1488
1489         <li class="md-nav__item">
1490   <a href="#example" class="md-nav__link">
1491     Example
1492   </a>
1493
1494 </li>
1495
1496     </ul>
1497
1498 </nav>
1499
1500     </li>
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510     <li class="md-nav__item">
1511       <a href="../menu-item/" class="md-nav__link">
1512         menuItem
1513       </a>
1514     </li>
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524     <li class="md-nav__item">
1525       <a href="../object-type/" class="md-nav__link">
1526         objectType
1527       </a>
1528     </li>
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538     <li class="md-nav__item">
1539       <a href="../object-type-definition/" class="md-nav__link">
1540         objectTypeDefinition
1541       </a>
1542     </li>
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552     <li class="md-nav__item">
1553       <a href="../option/" class="md-nav__link">
1554         option
1555       </a>
1556     </li>
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566     <li class="md-nav__item">
1567       <a href="../page/" class="md-nav__link">
1568         page
1569       </a>
1570     </li>
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580     <li class="md-nav__item">
1581       <a href="../pip/" class="md-nav__link">
1582         pip
1583       </a>
1584     </li>
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594     <li class="md-nav__item">
1595       <a href="../script/" class="md-nav__link">
1596         script
1597       </a>
1598     </li>
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608     <li class="md-nav__item">
1609       <a href="../smiley/" class="md-nav__link">
1610         smiley
1611       </a>
1612     </li>
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622     <li class="md-nav__item">
1623       <a href="../sql/" class="md-nav__link">
1624         sql
1625       </a>
1626     </li>
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636     <li class="md-nav__item">
1637       <a href="../style/" class="md-nav__link">
1638         style
1639       </a>
1640     </li>
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650     <li class="md-nav__item">
1651       <a href="../template/" class="md-nav__link">
1652         template
1653       </a>
1654     </li>
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664     <li class="md-nav__item">
1665       <a href="../template-delete/" class="md-nav__link">
1666         templateDelete
1667       </a>
1668     </li>
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678     <li class="md-nav__item">
1679       <a href="../template-listener/" class="md-nav__link">
1680         templateListener
1681       </a>
1682     </li>
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692     <li class="md-nav__item">
1693       <a href="../user-group-option/" class="md-nav__link">
1694         userGroupOption
1695       </a>
1696     </li>
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706     <li class="md-nav__item">
1707       <a href="../user-menu/" class="md-nav__link">
1708         userMenu
1709       </a>
1710     </li>
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720     <li class="md-nav__item">
1721       <a href="../user-notification-event/" class="md-nav__link">
1722         userNotificationEvent
1723       </a>
1724     </li>
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734     <li class="md-nav__item">
1735       <a href="../user-option/" class="md-nav__link">
1736         userOption
1737       </a>
1738     </li>
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748     <li class="md-nav__item">
1749       <a href="../user-profile-menu/" class="md-nav__link">
1750         userProfileMenu
1751       </a>
1752     </li>
1753
1754
1755
1756
1757         </ul>
1758       </nav>
1759     </li>
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769     <li class="md-nav__item">
1770       <a href="../../database-php-api/" class="md-nav__link">
1771         Database PHP API
1772       </a>
1773     </li>
1774
1775
1776
1777
1778         </ul>
1779       </nav>
1780     </li>
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792     <li class="md-nav__item md-nav__item--nested">
1793
1794
1795
1796
1797       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1798
1799
1800
1801         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1802           Migration
1803           <span class="md-nav__icon md-icon"></span>
1804         </label>
1805
1806       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1807         <label class="md-nav__title" for="__nav_6">
1808           <span class="md-nav__icon md-icon"></span>
1809           Migration
1810         </label>
1811         <ul class="md-nav__list" data-md-scrollfix>
1812
1813
1814
1815
1816
1817
1818
1819     <li class="md-nav__item md-nav__item--nested">
1820
1821
1822
1823
1824       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1825
1826
1827
1828         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1829           From WoltLab Suite 5.5
1830           <span class="md-nav__icon md-icon"></span>
1831         </label>
1832
1833       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1834         <label class="md-nav__title" for="__nav_6_1">
1835           <span class="md-nav__icon md-icon"></span>
1836           From WoltLab Suite 5.5
1837         </label>
1838         <ul class="md-nav__list" data-md-scrollfix>
1839
1840
1841
1842
1843
1844
1845     <li class="md-nav__item">
1846       <a href="../../../migration/wsc55/php/" class="md-nav__link">
1847         PHP API
1848       </a>
1849     </li>
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859     <li class="md-nav__item">
1860       <a href="../../../migration/wsc55/javascript/" class="md-nav__link">
1861         TypeScript and JavaScript
1862       </a>
1863     </li>
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873     <li class="md-nav__item">
1874       <a href="../../../migration/wsc55/templates/" class="md-nav__link">
1875         Templates
1876       </a>
1877     </li>
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887     <li class="md-nav__item">
1888       <a href="../../../migration/wsc55/icons/" class="md-nav__link">
1889         Icons
1890       </a>
1891     </li>
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901     <li class="md-nav__item">
1902       <a href="../../../migration/wsc55/dialogs/" class="md-nav__link">
1903         Dialogs
1904       </a>
1905     </li>
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915     <li class="md-nav__item">
1916       <a href="../../../migration/wsc55/libraries/" class="md-nav__link">
1917         Third Party Libraries
1918       </a>
1919     </li>
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929     <li class="md-nav__item">
1930       <a href="../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1931         Deprecations and Removals
1932       </a>
1933     </li>
1934
1935
1936
1937
1938         </ul>
1939       </nav>
1940     </li>
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951     <li class="md-nav__item md-nav__item--nested">
1952
1953
1954
1955
1956       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
1957
1958
1959
1960         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
1961           From WoltLab Suite 5.4
1962           <span class="md-nav__icon md-icon"></span>
1963         </label>
1964
1965       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
1966         <label class="md-nav__title" for="__nav_6_2">
1967           <span class="md-nav__icon md-icon"></span>
1968           From WoltLab Suite 5.4
1969         </label>
1970         <ul class="md-nav__list" data-md-scrollfix>
1971
1972
1973
1974
1975
1976
1977     <li class="md-nav__item">
1978       <a href="../../../migration/wsc54/php/" class="md-nav__link">
1979         PHP API
1980       </a>
1981     </li>
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991     <li class="md-nav__item">
1992       <a href="../../../migration/wsc54/javascript/" class="md-nav__link">
1993         TypeScript and JavaScript
1994       </a>
1995     </li>
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005     <li class="md-nav__item">
2006       <a href="../../../migration/wsc54/templates/" class="md-nav__link">
2007         Templates
2008       </a>
2009     </li>
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019     <li class="md-nav__item">
2020       <a href="../../../migration/wsc54/libraries/" class="md-nav__link">
2021         Third Party Libraries
2022       </a>
2023     </li>
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033     <li class="md-nav__item">
2034       <a href="../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2035         Deprecations and Removals
2036       </a>
2037     </li>
2038
2039
2040
2041
2042         </ul>
2043       </nav>
2044     </li>
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055     <li class="md-nav__item md-nav__item--nested">
2056
2057
2058
2059
2060       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2061
2062
2063
2064         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2065           From WoltLab Suite 5.3
2066           <span class="md-nav__icon md-icon"></span>
2067         </label>
2068
2069       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2070         <label class="md-nav__title" for="__nav_6_3">
2071           <span class="md-nav__icon md-icon"></span>
2072           From WoltLab Suite 5.3
2073         </label>
2074         <ul class="md-nav__list" data-md-scrollfix>
2075
2076
2077
2078
2079
2080
2081     <li class="md-nav__item">
2082       <a href="../../../migration/wsc53/php/" class="md-nav__link">
2083         PHP API
2084       </a>
2085     </li>
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095     <li class="md-nav__item">
2096       <a href="../../../migration/wsc53/session/" class="md-nav__link">
2097         Session Handling and Authentication
2098       </a>
2099     </li>
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109     <li class="md-nav__item">
2110       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
2111         TypeScript and JavaScript
2112       </a>
2113     </li>
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123     <li class="md-nav__item">
2124       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
2125         Templates
2126       </a>
2127     </li>
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137     <li class="md-nav__item">
2138       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
2139         Third Party Libraries
2140       </a>
2141     </li>
2142
2143
2144
2145
2146         </ul>
2147       </nav>
2148     </li>
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159     <li class="md-nav__item md-nav__item--nested">
2160
2161
2162
2163
2164       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2165
2166
2167
2168         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2169           From WoltLab Suite 5.2
2170           <span class="md-nav__icon md-icon"></span>
2171         </label>
2172
2173       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2174         <label class="md-nav__title" for="__nav_6_4">
2175           <span class="md-nav__icon md-icon"></span>
2176           From WoltLab Suite 5.2
2177         </label>
2178         <ul class="md-nav__list" data-md-scrollfix>
2179
2180
2181
2182
2183
2184
2185     <li class="md-nav__item">
2186       <a href="../../../migration/wsc52/php/" class="md-nav__link">
2187         PHP API
2188       </a>
2189     </li>
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199     <li class="md-nav__item">
2200       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
2201         Templates and Languages
2202       </a>
2203     </li>
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213     <li class="md-nav__item">
2214       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
2215         Third Party Libraries
2216       </a>
2217     </li>
2218
2219
2220
2221
2222         </ul>
2223       </nav>
2224     </li>
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235     <li class="md-nav__item md-nav__item--nested">
2236
2237
2238
2239
2240       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2241
2242
2243
2244         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2245           From WoltLab Suite 3.1
2246           <span class="md-nav__icon md-icon"></span>
2247         </label>
2248
2249       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2250         <label class="md-nav__title" for="__nav_6_5">
2251           <span class="md-nav__icon md-icon"></span>
2252           From WoltLab Suite 3.1
2253         </label>
2254         <ul class="md-nav__list" data-md-scrollfix>
2255
2256
2257
2258
2259
2260
2261     <li class="md-nav__item">
2262       <a href="../../../migration/wsc31/php/" class="md-nav__link">
2263         PHP API
2264       </a>
2265     </li>
2266
2267
2268
2269
2270         </ul>
2271       </nav>
2272     </li>
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283     <li class="md-nav__item md-nav__item--nested">
2284
2285
2286
2287
2288       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2289
2290
2291
2292         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2293           From WoltLab Suite 3.0
2294           <span class="md-nav__icon md-icon"></span>
2295         </label>
2296
2297       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2298         <label class="md-nav__title" for="__nav_6_6">
2299           <span class="md-nav__icon md-icon"></span>
2300           From WoltLab Suite 3.0
2301         </label>
2302         <ul class="md-nav__list" data-md-scrollfix>
2303
2304
2305
2306
2307
2308
2309     <li class="md-nav__item">
2310       <a href="../../../migration/wsc30/php/" class="md-nav__link">
2311         PHP API
2312       </a>
2313     </li>
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323     <li class="md-nav__item">
2324       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
2325         JavaScript API
2326       </a>
2327     </li>
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337     <li class="md-nav__item">
2338       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
2339         Templates
2340       </a>
2341     </li>
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351     <li class="md-nav__item">
2352       <a href="../../../migration/wsc30/css/" class="md-nav__link">
2353         CSS
2354       </a>
2355     </li>
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365     <li class="md-nav__item">
2366       <a href="../../../migration/wsc30/package/" class="md-nav__link">
2367         Package Components
2368       </a>
2369     </li>
2370
2371
2372
2373
2374         </ul>
2375       </nav>
2376     </li>
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387     <li class="md-nav__item md-nav__item--nested">
2388
2389
2390
2391
2392       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2393
2394
2395
2396         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2397           From WCF 2.1
2398           <span class="md-nav__icon md-icon"></span>
2399         </label>
2400
2401       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2402         <label class="md-nav__title" for="__nav_6_7">
2403           <span class="md-nav__icon md-icon"></span>
2404           From WCF 2.1
2405         </label>
2406         <ul class="md-nav__list" data-md-scrollfix>
2407
2408
2409
2410
2411
2412
2413     <li class="md-nav__item">
2414       <a href="../../../migration/wcf21/php/" class="md-nav__link">
2415         PHP API
2416       </a>
2417     </li>
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427     <li class="md-nav__item">
2428       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
2429         Templates
2430       </a>
2431     </li>
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441     <li class="md-nav__item">
2442       <a href="../../../migration/wcf21/css/" class="md-nav__link">
2443         CSS
2444       </a>
2445     </li>
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455     <li class="md-nav__item">
2456       <a href="../../../migration/wcf21/package/" class="md-nav__link">
2457         Package Components
2458       </a>
2459     </li>
2460
2461
2462
2463
2464         </ul>
2465       </nav>
2466     </li>
2467
2468
2469
2470
2471         </ul>
2472       </nav>
2473     </li>
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485     <li class="md-nav__item md-nav__item--nested">
2486
2487
2488
2489
2490       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2491
2492
2493
2494         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2495           Tutorials
2496           <span class="md-nav__icon md-icon"></span>
2497         </label>
2498
2499       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2500         <label class="md-nav__title" for="__nav_7">
2501           <span class="md-nav__icon md-icon"></span>
2502           Tutorials
2503         </label>
2504         <ul class="md-nav__list" data-md-scrollfix>
2505
2506
2507
2508
2509
2510
2511
2512     <li class="md-nav__item md-nav__item--nested">
2513
2514
2515
2516
2517       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2518
2519
2520
2521         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2522           Tutorial Series
2523           <span class="md-nav__icon md-icon"></span>
2524         </label>
2525
2526       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2527         <label class="md-nav__title" for="__nav_7_1">
2528           <span class="md-nav__icon md-icon"></span>
2529           Tutorial Series
2530         </label>
2531         <ul class="md-nav__list" data-md-scrollfix>
2532
2533
2534
2535
2536
2537
2538     <li class="md-nav__item">
2539       <a href="../../../tutorial/series/overview/" class="md-nav__link">
2540         Overview
2541       </a>
2542     </li>
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552     <li class="md-nav__item">
2553       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2554         Part 1
2555       </a>
2556     </li>
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566     <li class="md-nav__item">
2567       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2568         Part 2
2569       </a>
2570     </li>
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580     <li class="md-nav__item">
2581       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2582         Part 3
2583       </a>
2584     </li>
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594     <li class="md-nav__item">
2595       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2596         Part 4
2597       </a>
2598     </li>
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608     <li class="md-nav__item">
2609       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2610         Part 5
2611       </a>
2612     </li>
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622     <li class="md-nav__item">
2623       <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2624         Part 6
2625       </a>
2626     </li>
2627
2628
2629
2630
2631         </ul>
2632       </nav>
2633     </li>
2634
2635
2636
2637
2638         </ul>
2639       </nav>
2640     </li>
2641
2642
2643
2644   </ul>
2645 </nav>
2646                   </div>
2647                 </div>
2648               </div>
2649
2650
2651
2652               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2653                 <div class="md-sidebar__scrollwrap">
2654                   <div class="md-sidebar__inner">
2655
2656
2657 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2658
2659
2660
2661
2662
2663
2664     <label class="md-nav__title" for="__toc">
2665       <span class="md-nav__icon md-icon"></span>
2666       Table of contents
2667     </label>
2668     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2669
2670         <li class="md-nav__item">
2671   <a href="#components" class="md-nav__link">
2672     Components
2673   </a>
2674
2675     <nav class="md-nav" aria-label="Components">
2676       <ul class="md-nav__list">
2677
2678           <li class="md-nav__item">
2679   <a href="#title" class="md-nav__link">
2680     &lt;title&gt;
2681   </a>
2682
2683 </li>
2684
2685           <li class="md-nav__item">
2686   <a href="#box" class="md-nav__link">
2687     &lt;box&gt;
2688   </a>
2689
2690 </li>
2691
2692       </ul>
2693     </nav>
2694
2695 </li>
2696
2697         <li class="md-nav__item">
2698   <a href="#example" class="md-nav__link">
2699     Example
2700   </a>
2701
2702 </li>
2703
2704     </ul>
2705
2706 </nav>
2707                   </div>
2708                 </div>
2709               </div>
2710
2711
2712
2713             <div class="md-content" data-md-component="content">
2714               <article class="md-content__inner md-typeset">
2715
2716
2717
2718
2719
2720
2721
2722 <h1 id="menu-package-installation-plugin">Menu Package Installation Plugin<a class="headerlink" href="#menu-package-installation-plugin" title="Permanent link">#</a></h1>
2723 <p>Deploy and manage menus that can be placed anywhere on the site.</p>
2724 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
2725 <p>Each item is described as a <code>&lt;menu&gt;</code> element with the mandatory attribute <code>identifier</code> that should follow the naming pattern <code>&lt;packageIdentifier&gt;.&lt;MenuName&gt;</code>, e.g. <code>com.woltlab.wcf.MainMenu</code>.</p>
2726 <h3 id="title"><code>&lt;title&gt;</code><a class="headerlink" href="#title" title="Permanent link">#</a></h3>
2727 <div class="admonition info">
2728 <p class="admonition-title">The <code>language</code> attribute is required and should specify the <a href="https://en.wikipedia.org/wiki/ISO_639-1">ISO-639-1</a> language code.</p>
2729 </div>
2730 <p>The internal name displayed in the admin panel only, can be fully customized by the administrator and is immutable. Only one value is accepted and will be picked based on the site's default language, but you can provide localized values by including multiple <code>&lt;title&gt;</code> elements.</p>
2731 <h3 id="box"><code>&lt;box&gt;</code><a class="headerlink" href="#box" title="Permanent link">#</a></h3>
2732 <p>The following elements of the <a href="../box/">box PIP</a> are supported, please refer to the documentation to learn more about them:</p>
2733 <ul>
2734 <li><code>&lt;position&gt;</code></li>
2735 <li><code>&lt;showHeader&gt;</code></li>
2736 <li><code>&lt;visibleEverywhere&gt;</code></li>
2737 <li><code>&lt;visibilityExceptions&gt;</code></li>
2738 <li><code>cssClassName</code></li>
2739 </ul>
2740 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2741 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">menu.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/package/pip/menu.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2742 <span class="normal"> 2</span>
2743 <span class="normal"> 3</span>
2744 <span class="normal"> 4</span>
2745 <span class="normal"> 5</span>
2746 <span class="normal"> 6</span>
2747 <span class="normal"> 7</span>
2748 <span class="normal"> 8</span>
2749 <span class="normal"> 9</span>
2750 <span class="normal">10</span>
2751 <span class="normal">11</span>
2752 <span class="normal">12</span>
2753 <span class="normal">13</span>
2754 <span class="normal">14</span>
2755 <span class="normal">15</span>
2756 <span class="normal">16</span>
2757 <span class="normal">17</span>
2758 <span class="normal">18</span>
2759 <span class="normal">19</span>
2760 <span class="normal">20</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2761 <span class="nt">&lt;data</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/menu.xsd&quot;</span><span class="nt">&gt;</span>
2762 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
2763 <span class="w">        </span><span class="nt">&lt;menu</span><span class="w"> </span><span class="na">identifier=</span><span class="s">&quot;com.woltlab.wcf.FooterLinks&quot;</span><span class="nt">&gt;</span>
2764 <span class="w">            </span><span class="nt">&lt;title</span><span class="w"> </span><span class="na">language=</span><span class="s">&quot;de&quot;</span><span class="nt">&gt;</span>Footer-Links<span class="nt">&lt;/title&gt;</span>
2765 <span class="w">            </span><span class="nt">&lt;title</span><span class="w"> </span><span class="na">language=</span><span class="s">&quot;en&quot;</span><span class="nt">&gt;</span>Footer<span class="w"> </span>Links<span class="nt">&lt;/title&gt;</span>
2766
2767 <span class="w">            </span><span class="nt">&lt;box&gt;</span>
2768 <span class="w">                </span><span class="nt">&lt;position&gt;</span>footer<span class="nt">&lt;/position&gt;</span>
2769 <span class="w">                </span><span class="nt">&lt;cssClassName&gt;</span>boxMenuLinkGroup<span class="nt">&lt;/cssClassName&gt;</span>
2770 <span class="w">                </span><span class="nt">&lt;showHeader&gt;</span>0<span class="nt">&lt;/showHeader&gt;</span>
2771 <span class="w">                </span><span class="nt">&lt;visibleEverywhere&gt;</span>1<span class="nt">&lt;/visibleEverywhere&gt;</span>
2772 <span class="w">            </span><span class="nt">&lt;/box&gt;</span>
2773 <span class="w">        </span><span class="nt">&lt;/menu&gt;</span>
2774 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
2775
2776 <span class="w">    </span><span class="nt">&lt;delete&gt;</span>
2777 <span class="w">        </span><span class="nt">&lt;menu</span><span class="w"> </span><span class="na">identifier=</span><span class="s">&quot;com.woltlab.wcf.FooterLinks&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
2778 <span class="w">    </span><span class="nt">&lt;/delete&gt;</span>
2779 <span class="nt">&lt;/data&gt;</span>
2780 </code></pre></div></td></tr></table></div>
2781
2782   <hr>
2783 <div class="md-source-file">
2784   <small>
2785
2786       Last update:
2787       2021-04-23
2788
2789   </small>
2790 </div>
2791
2792
2793
2794
2795
2796
2797               </article>
2798             </div>
2799
2800
2801         </div>
2802
2803       </main>
2804
2805         <footer class="md-footer">
2806
2807   <div class="md-footer-meta md-typeset">
2808     <div class="md-footer-meta__inner md-grid">
2809       <div class="md-copyright">
2810
2811     <div class="md-copyright__highlight">
2812       Copyright © 2020 WoltLab GmbH
2813     </div>
2814
2815
2816     Made with
2817     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2818       Material for MkDocs
2819     </a>
2820
2821 </div>
2822
2823         <div class="md-copyright">
2824         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2825         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2826 </div>
2827
2828     </div>
2829   </div>
2830 </footer>
2831
2832     </div>
2833     <div class="md-dialog" data-md-component="dialog">
2834       <div class="md-dialog__inner md-typeset"></div>
2835     </div>
2836
2837     <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
2838
2839
2840       <script src="../../../assets/javascripts/bundle.b4d07000.min.js"></script>
2841
2842
2843   </body>
2844 </html>