6.0/package/pip/pip/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/pip/">
  12
  13
  14         <link rel="prev" href="../page/">
  15
  16
  17         <link rel="next" href="../script/">
  18
  19       <link rel="icon" href="../../../assets/default.favicon.ico">
  20       <meta name="generator" content="mkdocs-1.5.1, mkdocs-material-9.1.21">
  21
  22
  23
  24         <title>pip - WoltLab Suite Documentation</title>
  25
  26
  27
  28       <link rel="stylesheet" href="../../../assets/stylesheets/main.eebd395e.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="#package-installation-plugin-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               pip
 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_ckeditor5/" class="md-nav__link">
 875         CKEditor 5
 876       </a>
 877     </li>
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887     <li class="md-nav__item">
 888       <a href="../../../javascript/components_confirmation/" class="md-nav__link">
 889         Confirmation
 890       </a>
 891     </li>
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901     <li class="md-nav__item">
 902       <a href="../../../javascript/components_dialog/" class="md-nav__link">
 903         Dialog
 904       </a>
 905     </li>
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915     <li class="md-nav__item">
 916       <a href="../../../javascript/components_google_maps/" class="md-nav__link">
 917         Google Maps
 918       </a>
 919     </li>
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929     <li class="md-nav__item">
 930       <a href="../../../javascript/components_pagination/" class="md-nav__link">
 931         Pagination
 932       </a>
 933     </li>
 934
 935
 936
 937
 938         </ul>
 939       </nav>
 940     </li>
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951     <li class="md-nav__item md-nav__item--nested">
 952
 953
 954
 955
 956       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
 957
 958
 959
 960         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
 961           New API
 962           <span class="md-nav__icon md-icon"></span>
 963         </label>
 964
 965       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
 966         <label class="md-nav__title" for="__nav_4_4">
 967           <span class="md-nav__icon md-icon"></span>
 968           New API
 969         </label>
 970         <ul class="md-nav__list" data-md-scrollfix>
 971
 972
 973
 974
 975
 976
 977     <li class="md-nav__item">
 978       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 979         Writing a module
 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_core/" class="md-nav__link">
 993         Core Functions
 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_dom/" class="md-nav__link">
1007         DOM
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_events/" class="md-nav__link">
1021         Event Handling
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_ajax/" class="md-nav__link">
1035         Ajax
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_dialogs/" class="md-nav__link">
1049         Dialogs
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_browser/" class="md-nav__link">
1063         Browser and Screen Sizes
1064       </a>
1065     </li>
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075     <li class="md-nav__item">
1076       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1077         User Interface
1078       </a>
1079     </li>
1080
1081
1082
1083
1084         </ul>
1085       </nav>
1086     </li>
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096     <li class="md-nav__item">
1097       <a href="../../../javascript/legacy-api/" class="md-nav__link">
1098         Legacy API
1099       </a>
1100     </li>
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110     <li class="md-nav__item">
1111       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1112         Code Snippets
1113       </a>
1114     </li>
1115
1116
1117
1118
1119         </ul>
1120       </nav>
1121     </li>
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1136
1137
1138
1139
1140       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
1141
1142
1143
1144         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1145           Package Components
1146           <span class="md-nav__icon md-icon"></span>
1147         </label>
1148
1149       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
1150         <label class="md-nav__title" for="__nav_5">
1151           <span class="md-nav__icon md-icon"></span>
1152           Package Components
1153         </label>
1154         <ul class="md-nav__list" data-md-scrollfix>
1155
1156
1157
1158
1159
1160
1161     <li class="md-nav__item">
1162       <a href="../../package-xml/" class="md-nav__link">
1163         package.xml
1164       </a>
1165     </li>
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1179
1180
1181
1182
1183       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" checked>
1184
1185
1186
1187         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1188           PIPs
1189           <span class="md-nav__icon md-icon"></span>
1190         </label>
1191
1192       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="true">
1193         <label class="md-nav__title" for="__nav_5_2">
1194           <span class="md-nav__icon md-icon"></span>
1195           PIPs
1196         </label>
1197         <ul class="md-nav__list" data-md-scrollfix>
1198
1199
1200
1201
1202
1203
1204     <li class="md-nav__item">
1205       <a href="../" class="md-nav__link">
1206         Overview
1207       </a>
1208     </li>
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218     <li class="md-nav__item">
1219       <a href="../acl-option/" class="md-nav__link">
1220         aclOption
1221       </a>
1222     </li>
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232     <li class="md-nav__item">
1233       <a href="../acp-menu/" class="md-nav__link">
1234         acpMenu
1235       </a>
1236     </li>
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246     <li class="md-nav__item">
1247       <a href="../acp-search-provider/" class="md-nav__link">
1248         acpSearchProvider
1249       </a>
1250     </li>
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260     <li class="md-nav__item">
1261       <a href="../acp-template/" class="md-nav__link">
1262         acpTemplate
1263       </a>
1264     </li>
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274     <li class="md-nav__item">
1275       <a href="../acp-template-delete/" class="md-nav__link">
1276         acpTemplateDelete
1277       </a>
1278     </li>
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288     <li class="md-nav__item">
1289       <a href="../bbcode/" class="md-nav__link">
1290         bbcode
1291       </a>
1292     </li>
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302     <li class="md-nav__item">
1303       <a href="../box/" class="md-nav__link">
1304         box
1305       </a>
1306     </li>
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316     <li class="md-nav__item">
1317       <a href="../clipboard-action/" class="md-nav__link">
1318         clipboardAction
1319       </a>
1320     </li>
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330     <li class="md-nav__item">
1331       <a href="../core-object/" class="md-nav__link">
1332         coreObject
1333       </a>
1334     </li>
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344     <li class="md-nav__item">
1345       <a href="../cronjob/" class="md-nav__link">
1346         cronjob
1347       </a>
1348     </li>
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358     <li class="md-nav__item">
1359       <a href="../database/" class="md-nav__link">
1360         database
1361       </a>
1362     </li>
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372     <li class="md-nav__item">
1373       <a href="../event-listener/" class="md-nav__link">
1374         eventListener
1375       </a>
1376     </li>
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386     <li class="md-nav__item">
1387       <a href="../file/" class="md-nav__link">
1388         file
1389       </a>
1390     </li>
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400     <li class="md-nav__item">
1401       <a href="../file-delete/" class="md-nav__link">
1402         fileDelete
1403       </a>
1404     </li>
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414     <li class="md-nav__item">
1415       <a href="../language/" class="md-nav__link">
1416         language
1417       </a>
1418     </li>
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428     <li class="md-nav__item">
1429       <a href="../media-provider/" class="md-nav__link">
1430         mediaProvider
1431       </a>
1432     </li>
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442     <li class="md-nav__item">
1443       <a href="../menu/" class="md-nav__link">
1444         menu
1445       </a>
1446     </li>
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456     <li class="md-nav__item">
1457       <a href="../menu-item/" class="md-nav__link">
1458         menuItem
1459       </a>
1460     </li>
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470     <li class="md-nav__item">
1471       <a href="../object-type/" class="md-nav__link">
1472         objectType
1473       </a>
1474     </li>
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484     <li class="md-nav__item">
1485       <a href="../object-type-definition/" class="md-nav__link">
1486         objectTypeDefinition
1487       </a>
1488     </li>
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498     <li class="md-nav__item">
1499       <a href="../option/" class="md-nav__link">
1500         option
1501       </a>
1502     </li>
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512     <li class="md-nav__item">
1513       <a href="../page/" class="md-nav__link">
1514         page
1515       </a>
1516     </li>
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528     <li class="md-nav__item md-nav__item--active">
1529
1530       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1531
1532
1533
1534
1535
1536         <label class="md-nav__link md-nav__link--active" for="__toc">
1537           pip
1538           <span class="md-nav__icon md-icon"></span>
1539         </label>
1540
1541       <a href="./" class="md-nav__link md-nav__link--active">
1542         pip
1543       </a>
1544
1545
1546
1547 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1548
1549
1550
1551
1552
1553
1554     <label class="md-nav__title" for="__toc">
1555       <span class="md-nav__icon md-icon"></span>
1556       Table of contents
1557     </label>
1558     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1559
1560         <li class="md-nav__item">
1561   <a href="#components" class="md-nav__link">
1562     Components
1563   </a>
1564
1565 </li>
1566
1567         <li class="md-nav__item">
1568   <a href="#example" class="md-nav__link">
1569     Example
1570   </a>
1571
1572 </li>
1573
1574     </ul>
1575
1576 </nav>
1577
1578     </li>
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588     <li class="md-nav__item">
1589       <a href="../script/" class="md-nav__link">
1590         script
1591       </a>
1592     </li>
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602     <li class="md-nav__item">
1603       <a href="../smiley/" class="md-nav__link">
1604         smiley
1605       </a>
1606     </li>
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616     <li class="md-nav__item">
1617       <a href="../sql/" class="md-nav__link">
1618         sql
1619       </a>
1620     </li>
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630     <li class="md-nav__item">
1631       <a href="../style/" class="md-nav__link">
1632         style
1633       </a>
1634     </li>
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644     <li class="md-nav__item">
1645       <a href="../template/" class="md-nav__link">
1646         template
1647       </a>
1648     </li>
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658     <li class="md-nav__item">
1659       <a href="../template-delete/" class="md-nav__link">
1660         templateDelete
1661       </a>
1662     </li>
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672     <li class="md-nav__item">
1673       <a href="../template-listener/" class="md-nav__link">
1674         templateListener
1675       </a>
1676     </li>
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686     <li class="md-nav__item">
1687       <a href="../user-group-option/" class="md-nav__link">
1688         userGroupOption
1689       </a>
1690     </li>
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700     <li class="md-nav__item">
1701       <a href="../user-menu/" class="md-nav__link">
1702         userMenu
1703       </a>
1704     </li>
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714     <li class="md-nav__item">
1715       <a href="../user-notification-event/" class="md-nav__link">
1716         userNotificationEvent
1717       </a>
1718     </li>
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728     <li class="md-nav__item">
1729       <a href="../user-option/" class="md-nav__link">
1730         userOption
1731       </a>
1732     </li>
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742     <li class="md-nav__item">
1743       <a href="../user-profile-menu/" class="md-nav__link">
1744         userProfileMenu
1745       </a>
1746     </li>
1747
1748
1749
1750
1751         </ul>
1752       </nav>
1753     </li>
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763     <li class="md-nav__item">
1764       <a href="../../database-php-api/" class="md-nav__link">
1765         Database PHP API
1766       </a>
1767     </li>
1768
1769
1770
1771
1772         </ul>
1773       </nav>
1774     </li>
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786     <li class="md-nav__item md-nav__item--nested">
1787
1788
1789
1790
1791       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1792
1793
1794
1795         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1796           Migration
1797           <span class="md-nav__icon md-icon"></span>
1798         </label>
1799
1800       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1801         <label class="md-nav__title" for="__nav_6">
1802           <span class="md-nav__icon md-icon"></span>
1803           Migration
1804         </label>
1805         <ul class="md-nav__list" data-md-scrollfix>
1806
1807
1808
1809
1810
1811
1812
1813     <li class="md-nav__item md-nav__item--nested">
1814
1815
1816
1817
1818       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1819
1820
1821
1822         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1823           From WoltLab Suite 5.5
1824           <span class="md-nav__icon md-icon"></span>
1825         </label>
1826
1827       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1828         <label class="md-nav__title" for="__nav_6_1">
1829           <span class="md-nav__icon md-icon"></span>
1830           From WoltLab Suite 5.5
1831         </label>
1832         <ul class="md-nav__list" data-md-scrollfix>
1833
1834
1835
1836
1837
1838
1839     <li class="md-nav__item">
1840       <a href="../../../migration/wsc55/php/" class="md-nav__link">
1841         PHP API
1842       </a>
1843     </li>
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853     <li class="md-nav__item">
1854       <a href="../../../migration/wsc55/javascript/" class="md-nav__link">
1855         TypeScript and JavaScript
1856       </a>
1857     </li>
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867     <li class="md-nav__item">
1868       <a href="../../../migration/wsc55/templates/" class="md-nav__link">
1869         Templates
1870       </a>
1871     </li>
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881     <li class="md-nav__item">
1882       <a href="../../../migration/wsc55/icons/" class="md-nav__link">
1883         Icons
1884       </a>
1885     </li>
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895     <li class="md-nav__item">
1896       <a href="../../../migration/wsc55/dialogs/" class="md-nav__link">
1897         Dialogs
1898       </a>
1899     </li>
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909     <li class="md-nav__item">
1910       <a href="../../../migration/wsc55/libraries/" class="md-nav__link">
1911         Third Party Libraries
1912       </a>
1913     </li>
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923     <li class="md-nav__item">
1924       <a href="../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1925         Deprecations and Removals
1926       </a>
1927     </li>
1928
1929
1930
1931
1932         </ul>
1933       </nav>
1934     </li>
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945     <li class="md-nav__item md-nav__item--nested">
1946
1947
1948
1949
1950       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
1951
1952
1953
1954         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
1955           From WoltLab Suite 5.4
1956           <span class="md-nav__icon md-icon"></span>
1957         </label>
1958
1959       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
1960         <label class="md-nav__title" for="__nav_6_2">
1961           <span class="md-nav__icon md-icon"></span>
1962           From WoltLab Suite 5.4
1963         </label>
1964         <ul class="md-nav__list" data-md-scrollfix>
1965
1966
1967
1968
1969
1970
1971     <li class="md-nav__item">
1972       <a href="../../../migration/wsc54/php/" class="md-nav__link">
1973         PHP API
1974       </a>
1975     </li>
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985     <li class="md-nav__item">
1986       <a href="../../../migration/wsc54/javascript/" class="md-nav__link">
1987         TypeScript and JavaScript
1988       </a>
1989     </li>
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999     <li class="md-nav__item">
2000       <a href="../../../migration/wsc54/templates/" class="md-nav__link">
2001         Templates
2002       </a>
2003     </li>
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013     <li class="md-nav__item">
2014       <a href="../../../migration/wsc54/libraries/" class="md-nav__link">
2015         Third Party Libraries
2016       </a>
2017     </li>
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027     <li class="md-nav__item">
2028       <a href="../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2029         Deprecations and Removals
2030       </a>
2031     </li>
2032
2033
2034
2035
2036         </ul>
2037       </nav>
2038     </li>
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049     <li class="md-nav__item md-nav__item--nested">
2050
2051
2052
2053
2054       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2055
2056
2057
2058         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2059           From WoltLab Suite 5.3
2060           <span class="md-nav__icon md-icon"></span>
2061         </label>
2062
2063       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2064         <label class="md-nav__title" for="__nav_6_3">
2065           <span class="md-nav__icon md-icon"></span>
2066           From WoltLab Suite 5.3
2067         </label>
2068         <ul class="md-nav__list" data-md-scrollfix>
2069
2070
2071
2072
2073
2074
2075     <li class="md-nav__item">
2076       <a href="../../../migration/wsc53/php/" class="md-nav__link">
2077         PHP API
2078       </a>
2079     </li>
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089     <li class="md-nav__item">
2090       <a href="../../../migration/wsc53/session/" class="md-nav__link">
2091         Session Handling and Authentication
2092       </a>
2093     </li>
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103     <li class="md-nav__item">
2104       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
2105         TypeScript and JavaScript
2106       </a>
2107     </li>
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117     <li class="md-nav__item">
2118       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
2119         Templates
2120       </a>
2121     </li>
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131     <li class="md-nav__item">
2132       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
2133         Third Party Libraries
2134       </a>
2135     </li>
2136
2137
2138
2139
2140         </ul>
2141       </nav>
2142     </li>
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153     <li class="md-nav__item md-nav__item--nested">
2154
2155
2156
2157
2158       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2159
2160
2161
2162         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2163           From WoltLab Suite 5.2
2164           <span class="md-nav__icon md-icon"></span>
2165         </label>
2166
2167       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2168         <label class="md-nav__title" for="__nav_6_4">
2169           <span class="md-nav__icon md-icon"></span>
2170           From WoltLab Suite 5.2
2171         </label>
2172         <ul class="md-nav__list" data-md-scrollfix>
2173
2174
2175
2176
2177
2178
2179     <li class="md-nav__item">
2180       <a href="../../../migration/wsc52/php/" class="md-nav__link">
2181         PHP API
2182       </a>
2183     </li>
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193     <li class="md-nav__item">
2194       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
2195         Templates and Languages
2196       </a>
2197     </li>
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207     <li class="md-nav__item">
2208       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
2209         Third Party Libraries
2210       </a>
2211     </li>
2212
2213
2214
2215
2216         </ul>
2217       </nav>
2218     </li>
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229     <li class="md-nav__item md-nav__item--nested">
2230
2231
2232
2233
2234       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2235
2236
2237
2238         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2239           From WoltLab Suite 3.1
2240           <span class="md-nav__icon md-icon"></span>
2241         </label>
2242
2243       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2244         <label class="md-nav__title" for="__nav_6_5">
2245           <span class="md-nav__icon md-icon"></span>
2246           From WoltLab Suite 3.1
2247         </label>
2248         <ul class="md-nav__list" data-md-scrollfix>
2249
2250
2251
2252
2253
2254
2255     <li class="md-nav__item">
2256       <a href="../../../migration/wsc31/php/" class="md-nav__link">
2257         PHP API
2258       </a>
2259     </li>
2260
2261
2262
2263
2264         </ul>
2265       </nav>
2266     </li>
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277     <li class="md-nav__item md-nav__item--nested">
2278
2279
2280
2281
2282       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2283
2284
2285
2286         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2287           From WoltLab Suite 3.0
2288           <span class="md-nav__icon md-icon"></span>
2289         </label>
2290
2291       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2292         <label class="md-nav__title" for="__nav_6_6">
2293           <span class="md-nav__icon md-icon"></span>
2294           From WoltLab Suite 3.0
2295         </label>
2296         <ul class="md-nav__list" data-md-scrollfix>
2297
2298
2299
2300
2301
2302
2303     <li class="md-nav__item">
2304       <a href="../../../migration/wsc30/php/" class="md-nav__link">
2305         PHP API
2306       </a>
2307     </li>
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317     <li class="md-nav__item">
2318       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
2319         JavaScript API
2320       </a>
2321     </li>
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331     <li class="md-nav__item">
2332       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
2333         Templates
2334       </a>
2335     </li>
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345     <li class="md-nav__item">
2346       <a href="../../../migration/wsc30/css/" class="md-nav__link">
2347         CSS
2348       </a>
2349     </li>
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359     <li class="md-nav__item">
2360       <a href="../../../migration/wsc30/package/" class="md-nav__link">
2361         Package Components
2362       </a>
2363     </li>
2364
2365
2366
2367
2368         </ul>
2369       </nav>
2370     </li>
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381     <li class="md-nav__item md-nav__item--nested">
2382
2383
2384
2385
2386       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2387
2388
2389
2390         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2391           From WCF 2.1
2392           <span class="md-nav__icon md-icon"></span>
2393         </label>
2394
2395       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2396         <label class="md-nav__title" for="__nav_6_7">
2397           <span class="md-nav__icon md-icon"></span>
2398           From WCF 2.1
2399         </label>
2400         <ul class="md-nav__list" data-md-scrollfix>
2401
2402
2403
2404
2405
2406
2407     <li class="md-nav__item">
2408       <a href="../../../migration/wcf21/php/" class="md-nav__link">
2409         PHP API
2410       </a>
2411     </li>
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421     <li class="md-nav__item">
2422       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
2423         Templates
2424       </a>
2425     </li>
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435     <li class="md-nav__item">
2436       <a href="../../../migration/wcf21/css/" class="md-nav__link">
2437         CSS
2438       </a>
2439     </li>
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449     <li class="md-nav__item">
2450       <a href="../../../migration/wcf21/package/" class="md-nav__link">
2451         Package Components
2452       </a>
2453     </li>
2454
2455
2456
2457
2458         </ul>
2459       </nav>
2460     </li>
2461
2462
2463
2464
2465         </ul>
2466       </nav>
2467     </li>
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479     <li class="md-nav__item md-nav__item--nested">
2480
2481
2482
2483
2484       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2485
2486
2487
2488         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2489           Tutorials
2490           <span class="md-nav__icon md-icon"></span>
2491         </label>
2492
2493       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2494         <label class="md-nav__title" for="__nav_7">
2495           <span class="md-nav__icon md-icon"></span>
2496           Tutorials
2497         </label>
2498         <ul class="md-nav__list" data-md-scrollfix>
2499
2500
2501
2502
2503
2504
2505
2506     <li class="md-nav__item md-nav__item--nested">
2507
2508
2509
2510
2511       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2512
2513
2514
2515         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2516           Tutorial Series
2517           <span class="md-nav__icon md-icon"></span>
2518         </label>
2519
2520       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2521         <label class="md-nav__title" for="__nav_7_1">
2522           <span class="md-nav__icon md-icon"></span>
2523           Tutorial Series
2524         </label>
2525         <ul class="md-nav__list" data-md-scrollfix>
2526
2527
2528
2529
2530
2531
2532     <li class="md-nav__item">
2533       <a href="../../../tutorial/series/overview/" class="md-nav__link">
2534         Overview
2535       </a>
2536     </li>
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546     <li class="md-nav__item">
2547       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2548         Part 1
2549       </a>
2550     </li>
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560     <li class="md-nav__item">
2561       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2562         Part 2
2563       </a>
2564     </li>
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574     <li class="md-nav__item">
2575       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2576         Part 3
2577       </a>
2578     </li>
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588     <li class="md-nav__item">
2589       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2590         Part 4
2591       </a>
2592     </li>
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602     <li class="md-nav__item">
2603       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2604         Part 5
2605       </a>
2606     </li>
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616     <li class="md-nav__item">
2617       <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2618         Part 6
2619       </a>
2620     </li>
2621
2622
2623
2624
2625         </ul>
2626       </nav>
2627     </li>
2628
2629
2630
2631
2632         </ul>
2633       </nav>
2634     </li>
2635
2636
2637
2638   </ul>
2639 </nav>
2640                   </div>
2641                 </div>
2642               </div>
2643
2644
2645
2646               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2647                 <div class="md-sidebar__scrollwrap">
2648                   <div class="md-sidebar__inner">
2649
2650
2651 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2652
2653
2654
2655
2656
2657
2658     <label class="md-nav__title" for="__toc">
2659       <span class="md-nav__icon md-icon"></span>
2660       Table of contents
2661     </label>
2662     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2663
2664         <li class="md-nav__item">
2665   <a href="#components" class="md-nav__link">
2666     Components
2667   </a>
2668
2669 </li>
2670
2671         <li class="md-nav__item">
2672   <a href="#example" class="md-nav__link">
2673     Example
2674   </a>
2675
2676 </li>
2677
2678     </ul>
2679
2680 </nav>
2681                   </div>
2682                 </div>
2683               </div>
2684
2685
2686
2687             <div class="md-content" data-md-component="content">
2688               <article class="md-content__inner md-typeset">
2689
2690
2691
2692
2693
2694
2695
2696 <h1 id="package-installation-plugin-package-installation-plugin">Package Installation Plugin Package Installation Plugin<a class="headerlink" href="#package-installation-plugin-package-installation-plugin" title="Permanent link">#</a></h1>
2697 <p>Registers new package installation plugins.</p>
2698 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
2699 <p>Each package installation plugin is described as an <code>&lt;pip&gt;</code> element with a <code>name</code> attribute and a PHP classname as the text content.</p>
2700 <div class="admonition warning">
2701 <p class="admonition-title">The package installation plugin’s class file must be installed into the <code>wcf</code> application and must not include classes outside the <code>\wcf\*</code> hierarchy to allow for proper uninstallation!</p>
2702 </div>
2703 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
2704 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">packageInstallationPlugin.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/package/pip/packageInstallationPlugin.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>
2705 <span class="normal">2</span>
2706 <span class="normal">3</span>
2707 <span class="normal">4</span>
2708 <span class="normal">5</span>
2709 <span class="normal">6</span>
2710 <span class="normal">7</span>
2711 <span class="normal">8</span>
2712 <span class="normal">9</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>
2713 <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/packageInstallationPlugin.xsd&quot;</span><span class="nt">&gt;</span>
2714 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
2715 <span class="w">        </span><span class="nt">&lt;pip</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;custom&quot;</span><span class="nt">&gt;</span>wcf\system\package\plugin\CustomPackageInstallationPlugin<span class="nt">&lt;/pip&gt;</span>
2716 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
2717 <span class="w">    </span><span class="nt">&lt;delete&gt;</span>
2718 <span class="w">        </span><span class="nt">&lt;pip</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;outdated&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
2719 <span class="w">    </span><span class="nt">&lt;/delete&gt;</span>
2720 <span class="nt">&lt;/data&gt;</span>
2721 </code></pre></div></td></tr></table></div>
2722
2723   <hr>
2724 <div class="md-source-file">
2725   <small>
2726
2727       Last update:
2728       2021-04-23
2729
2730   </small>
2731 </div>
2732
2733
2734
2735
2736
2737
2738               </article>
2739             </div>
2740
2741
2742         </div>
2743
2744       </main>
2745
2746         <footer class="md-footer">
2747
2748   <div class="md-footer-meta md-typeset">
2749     <div class="md-footer-meta__inner md-grid">
2750       <div class="md-copyright">
2751
2752     <div class="md-copyright__highlight">
2753       Copyright © 2020 WoltLab GmbH
2754     </div>
2755
2756
2757     Made with
2758     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2759       Material for MkDocs
2760     </a>
2761
2762 </div>
2763
2764         <div class="md-copyright">
2765         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2766         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2767 </div>
2768
2769     </div>
2770   </div>
2771 </footer>
2772
2773     </div>
2774     <div class="md-dialog" data-md-component="dialog">
2775       <div class="md-dialog__inner md-typeset"></div>
2776     </div>
2777
2778     <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.74e28a9f.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>
2779
2780
2781       <script src="../../../assets/javascripts/bundle.220ee61c.min.js"></script>
2782
2783
2784   </body>
2785 </html>