6.0/package/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/">
  12
  13
  14         <link rel="prev" href="../package-xml/">
  15
  16
  17         <link rel="next" href="acl-option/">
  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>Overview - 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="#package-installation-plugins" 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               Overview
 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
1191
1192     <li class="md-nav__item md-nav__item--active">
1193
1194       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1195
1196
1197
1198
1199
1200         <label class="md-nav__link md-nav__link--active" for="__toc">
1201           Overview
1202           <span class="md-nav__icon md-icon"></span>
1203         </label>
1204
1205       <a href="./" class="md-nav__link md-nav__link--active">
1206         Overview
1207       </a>
1208
1209
1210
1211 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1212
1213
1214
1215
1216
1217
1218     <label class="md-nav__title" for="__toc">
1219       <span class="md-nav__icon md-icon"></span>
1220       Table of contents
1221     </label>
1222     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1223
1224         <li class="md-nav__item">
1225   <a href="#built-in-pips" class="md-nav__link">
1226     Built-In PIPs
1227   </a>
1228
1229 </li>
1230
1231     </ul>
1232
1233 </nav>
1234
1235     </li>
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245     <li class="md-nav__item">
1246       <a href="acl-option/" class="md-nav__link">
1247         aclOption
1248       </a>
1249     </li>
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259     <li class="md-nav__item">
1260       <a href="acp-menu/" class="md-nav__link">
1261         acpMenu
1262       </a>
1263     </li>
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273     <li class="md-nav__item">
1274       <a href="acp-search-provider/" class="md-nav__link">
1275         acpSearchProvider
1276       </a>
1277     </li>
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287     <li class="md-nav__item">
1288       <a href="acp-template/" class="md-nav__link">
1289         acpTemplate
1290       </a>
1291     </li>
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301     <li class="md-nav__item">
1302       <a href="acp-template-delete/" class="md-nav__link">
1303         acpTemplateDelete
1304       </a>
1305     </li>
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315     <li class="md-nav__item">
1316       <a href="bbcode/" class="md-nav__link">
1317         bbcode
1318       </a>
1319     </li>
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329     <li class="md-nav__item">
1330       <a href="box/" class="md-nav__link">
1331         box
1332       </a>
1333     </li>
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343     <li class="md-nav__item">
1344       <a href="clipboard-action/" class="md-nav__link">
1345         clipboardAction
1346       </a>
1347     </li>
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357     <li class="md-nav__item">
1358       <a href="core-object/" class="md-nav__link">
1359         coreObject
1360       </a>
1361     </li>
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371     <li class="md-nav__item">
1372       <a href="cronjob/" class="md-nav__link">
1373         cronjob
1374       </a>
1375     </li>
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385     <li class="md-nav__item">
1386       <a href="database/" class="md-nav__link">
1387         database
1388       </a>
1389     </li>
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399     <li class="md-nav__item">
1400       <a href="event-listener/" class="md-nav__link">
1401         eventListener
1402       </a>
1403     </li>
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413     <li class="md-nav__item">
1414       <a href="file/" class="md-nav__link">
1415         file
1416       </a>
1417     </li>
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427     <li class="md-nav__item">
1428       <a href="file-delete/" class="md-nav__link">
1429         fileDelete
1430       </a>
1431     </li>
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441     <li class="md-nav__item">
1442       <a href="language/" class="md-nav__link">
1443         language
1444       </a>
1445     </li>
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455     <li class="md-nav__item">
1456       <a href="media-provider/" class="md-nav__link">
1457         mediaProvider
1458       </a>
1459     </li>
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469     <li class="md-nav__item">
1470       <a href="menu/" class="md-nav__link">
1471         menu
1472       </a>
1473     </li>
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483     <li class="md-nav__item">
1484       <a href="menu-item/" class="md-nav__link">
1485         menuItem
1486       </a>
1487     </li>
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497     <li class="md-nav__item">
1498       <a href="object-type/" class="md-nav__link">
1499         objectType
1500       </a>
1501     </li>
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511     <li class="md-nav__item">
1512       <a href="object-type-definition/" class="md-nav__link">
1513         objectTypeDefinition
1514       </a>
1515     </li>
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525     <li class="md-nav__item">
1526       <a href="option/" class="md-nav__link">
1527         option
1528       </a>
1529     </li>
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539     <li class="md-nav__item">
1540       <a href="page/" class="md-nav__link">
1541         page
1542       </a>
1543     </li>
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553     <li class="md-nav__item">
1554       <a href="pip/" class="md-nav__link">
1555         pip
1556       </a>
1557     </li>
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567     <li class="md-nav__item">
1568       <a href="script/" class="md-nav__link">
1569         script
1570       </a>
1571     </li>
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581     <li class="md-nav__item">
1582       <a href="smiley/" class="md-nav__link">
1583         smiley
1584       </a>
1585     </li>
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595     <li class="md-nav__item">
1596       <a href="sql/" class="md-nav__link">
1597         sql
1598       </a>
1599     </li>
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609     <li class="md-nav__item">
1610       <a href="style/" class="md-nav__link">
1611         style
1612       </a>
1613     </li>
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623     <li class="md-nav__item">
1624       <a href="template/" class="md-nav__link">
1625         template
1626       </a>
1627     </li>
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637     <li class="md-nav__item">
1638       <a href="template-delete/" class="md-nav__link">
1639         templateDelete
1640       </a>
1641     </li>
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651     <li class="md-nav__item">
1652       <a href="template-listener/" class="md-nav__link">
1653         templateListener
1654       </a>
1655     </li>
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665     <li class="md-nav__item">
1666       <a href="user-group-option/" class="md-nav__link">
1667         userGroupOption
1668       </a>
1669     </li>
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679     <li class="md-nav__item">
1680       <a href="user-menu/" class="md-nav__link">
1681         userMenu
1682       </a>
1683     </li>
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693     <li class="md-nav__item">
1694       <a href="user-notification-event/" class="md-nav__link">
1695         userNotificationEvent
1696       </a>
1697     </li>
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707     <li class="md-nav__item">
1708       <a href="user-option/" class="md-nav__link">
1709         userOption
1710       </a>
1711     </li>
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721     <li class="md-nav__item">
1722       <a href="user-profile-menu/" class="md-nav__link">
1723         userProfileMenu
1724       </a>
1725     </li>
1726
1727
1728
1729
1730         </ul>
1731       </nav>
1732     </li>
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742     <li class="md-nav__item">
1743       <a href="../database-php-api/" class="md-nav__link">
1744         Database PHP API
1745       </a>
1746     </li>
1747
1748
1749
1750
1751         </ul>
1752       </nav>
1753     </li>
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765     <li class="md-nav__item md-nav__item--nested">
1766
1767
1768
1769
1770       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1771
1772
1773
1774         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1775           Migration
1776           <span class="md-nav__icon md-icon"></span>
1777         </label>
1778
1779       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1780         <label class="md-nav__title" for="__nav_6">
1781           <span class="md-nav__icon md-icon"></span>
1782           Migration
1783         </label>
1784         <ul class="md-nav__list" data-md-scrollfix>
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_1" >
1798
1799
1800
1801         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1802           From WoltLab Suite 5.5
1803           <span class="md-nav__icon md-icon"></span>
1804         </label>
1805
1806       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1807         <label class="md-nav__title" for="__nav_6_1">
1808           <span class="md-nav__icon md-icon"></span>
1809           From WoltLab Suite 5.5
1810         </label>
1811         <ul class="md-nav__list" data-md-scrollfix>
1812
1813
1814
1815
1816
1817
1818     <li class="md-nav__item">
1819       <a href="../../migration/wsc55/php/" class="md-nav__link">
1820         PHP API
1821       </a>
1822     </li>
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832     <li class="md-nav__item">
1833       <a href="../../migration/wsc55/javascript/" class="md-nav__link">
1834         TypeScript and JavaScript
1835       </a>
1836     </li>
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846     <li class="md-nav__item">
1847       <a href="../../migration/wsc55/templates/" class="md-nav__link">
1848         Templates
1849       </a>
1850     </li>
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860     <li class="md-nav__item">
1861       <a href="../../migration/wsc55/icons/" class="md-nav__link">
1862         Icons
1863       </a>
1864     </li>
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874     <li class="md-nav__item">
1875       <a href="../../migration/wsc55/dialogs/" class="md-nav__link">
1876         Dialogs
1877       </a>
1878     </li>
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888     <li class="md-nav__item">
1889       <a href="../../migration/wsc55/libraries/" class="md-nav__link">
1890         Third Party Libraries
1891       </a>
1892     </li>
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902     <li class="md-nav__item">
1903       <a href="../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1904         Deprecations and Removals
1905       </a>
1906     </li>
1907
1908
1909
1910
1911         </ul>
1912       </nav>
1913     </li>
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924     <li class="md-nav__item md-nav__item--nested">
1925
1926
1927
1928
1929       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
1930
1931
1932
1933         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
1934           From WoltLab Suite 5.4
1935           <span class="md-nav__icon md-icon"></span>
1936         </label>
1937
1938       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
1939         <label class="md-nav__title" for="__nav_6_2">
1940           <span class="md-nav__icon md-icon"></span>
1941           From WoltLab Suite 5.4
1942         </label>
1943         <ul class="md-nav__list" data-md-scrollfix>
1944
1945
1946
1947
1948
1949
1950     <li class="md-nav__item">
1951       <a href="../../migration/wsc54/php/" class="md-nav__link">
1952         PHP API
1953       </a>
1954     </li>
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964     <li class="md-nav__item">
1965       <a href="../../migration/wsc54/javascript/" class="md-nav__link">
1966         TypeScript and JavaScript
1967       </a>
1968     </li>
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978     <li class="md-nav__item">
1979       <a href="../../migration/wsc54/templates/" class="md-nav__link">
1980         Templates
1981       </a>
1982     </li>
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992     <li class="md-nav__item">
1993       <a href="../../migration/wsc54/libraries/" class="md-nav__link">
1994         Third Party Libraries
1995       </a>
1996     </li>
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006     <li class="md-nav__item">
2007       <a href="../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2008         Deprecations and Removals
2009       </a>
2010     </li>
2011
2012
2013
2014
2015         </ul>
2016       </nav>
2017     </li>
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028     <li class="md-nav__item md-nav__item--nested">
2029
2030
2031
2032
2033       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2034
2035
2036
2037         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2038           From WoltLab Suite 5.3
2039           <span class="md-nav__icon md-icon"></span>
2040         </label>
2041
2042       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2043         <label class="md-nav__title" for="__nav_6_3">
2044           <span class="md-nav__icon md-icon"></span>
2045           From WoltLab Suite 5.3
2046         </label>
2047         <ul class="md-nav__list" data-md-scrollfix>
2048
2049
2050
2051
2052
2053
2054     <li class="md-nav__item">
2055       <a href="../../migration/wsc53/php/" class="md-nav__link">
2056         PHP API
2057       </a>
2058     </li>
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068     <li class="md-nav__item">
2069       <a href="../../migration/wsc53/session/" class="md-nav__link">
2070         Session Handling and Authentication
2071       </a>
2072     </li>
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082     <li class="md-nav__item">
2083       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
2084         TypeScript and JavaScript
2085       </a>
2086     </li>
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096     <li class="md-nav__item">
2097       <a href="../../migration/wsc53/templates/" class="md-nav__link">
2098         Templates
2099       </a>
2100     </li>
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110     <li class="md-nav__item">
2111       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
2112         Third Party Libraries
2113       </a>
2114     </li>
2115
2116
2117
2118
2119         </ul>
2120       </nav>
2121     </li>
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132     <li class="md-nav__item md-nav__item--nested">
2133
2134
2135
2136
2137       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2138
2139
2140
2141         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2142           From WoltLab Suite 5.2
2143           <span class="md-nav__icon md-icon"></span>
2144         </label>
2145
2146       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2147         <label class="md-nav__title" for="__nav_6_4">
2148           <span class="md-nav__icon md-icon"></span>
2149           From WoltLab Suite 5.2
2150         </label>
2151         <ul class="md-nav__list" data-md-scrollfix>
2152
2153
2154
2155
2156
2157
2158     <li class="md-nav__item">
2159       <a href="../../migration/wsc52/php/" class="md-nav__link">
2160         PHP API
2161       </a>
2162     </li>
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172     <li class="md-nav__item">
2173       <a href="../../migration/wsc52/templates/" class="md-nav__link">
2174         Templates and Languages
2175       </a>
2176     </li>
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186     <li class="md-nav__item">
2187       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
2188         Third Party Libraries
2189       </a>
2190     </li>
2191
2192
2193
2194
2195         </ul>
2196       </nav>
2197     </li>
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208     <li class="md-nav__item md-nav__item--nested">
2209
2210
2211
2212
2213       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2214
2215
2216
2217         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2218           From WoltLab Suite 3.1
2219           <span class="md-nav__icon md-icon"></span>
2220         </label>
2221
2222       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2223         <label class="md-nav__title" for="__nav_6_5">
2224           <span class="md-nav__icon md-icon"></span>
2225           From WoltLab Suite 3.1
2226         </label>
2227         <ul class="md-nav__list" data-md-scrollfix>
2228
2229
2230
2231
2232
2233
2234     <li class="md-nav__item">
2235       <a href="../../migration/wsc31/php/" class="md-nav__link">
2236         PHP API
2237       </a>
2238     </li>
2239
2240
2241
2242
2243         </ul>
2244       </nav>
2245     </li>
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256     <li class="md-nav__item md-nav__item--nested">
2257
2258
2259
2260
2261       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2262
2263
2264
2265         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2266           From WoltLab Suite 3.0
2267           <span class="md-nav__icon md-icon"></span>
2268         </label>
2269
2270       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2271         <label class="md-nav__title" for="__nav_6_6">
2272           <span class="md-nav__icon md-icon"></span>
2273           From WoltLab Suite 3.0
2274         </label>
2275         <ul class="md-nav__list" data-md-scrollfix>
2276
2277
2278
2279
2280
2281
2282     <li class="md-nav__item">
2283       <a href="../../migration/wsc30/php/" class="md-nav__link">
2284         PHP API
2285       </a>
2286     </li>
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296     <li class="md-nav__item">
2297       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
2298         JavaScript API
2299       </a>
2300     </li>
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310     <li class="md-nav__item">
2311       <a href="../../migration/wsc30/templates/" class="md-nav__link">
2312         Templates
2313       </a>
2314     </li>
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324     <li class="md-nav__item">
2325       <a href="../../migration/wsc30/css/" class="md-nav__link">
2326         CSS
2327       </a>
2328     </li>
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338     <li class="md-nav__item">
2339       <a href="../../migration/wsc30/package/" class="md-nav__link">
2340         Package Components
2341       </a>
2342     </li>
2343
2344
2345
2346
2347         </ul>
2348       </nav>
2349     </li>
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360     <li class="md-nav__item md-nav__item--nested">
2361
2362
2363
2364
2365       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2366
2367
2368
2369         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2370           From WCF 2.1
2371           <span class="md-nav__icon md-icon"></span>
2372         </label>
2373
2374       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2375         <label class="md-nav__title" for="__nav_6_7">
2376           <span class="md-nav__icon md-icon"></span>
2377           From WCF 2.1
2378         </label>
2379         <ul class="md-nav__list" data-md-scrollfix>
2380
2381
2382
2383
2384
2385
2386     <li class="md-nav__item">
2387       <a href="../../migration/wcf21/php/" class="md-nav__link">
2388         PHP API
2389       </a>
2390     </li>
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400     <li class="md-nav__item">
2401       <a href="../../migration/wcf21/templates/" class="md-nav__link">
2402         Templates
2403       </a>
2404     </li>
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414     <li class="md-nav__item">
2415       <a href="../../migration/wcf21/css/" class="md-nav__link">
2416         CSS
2417       </a>
2418     </li>
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428     <li class="md-nav__item">
2429       <a href="../../migration/wcf21/package/" class="md-nav__link">
2430         Package Components
2431       </a>
2432     </li>
2433
2434
2435
2436
2437         </ul>
2438       </nav>
2439     </li>
2440
2441
2442
2443
2444         </ul>
2445       </nav>
2446     </li>
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458     <li class="md-nav__item md-nav__item--nested">
2459
2460
2461
2462
2463       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2464
2465
2466
2467         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2468           Tutorials
2469           <span class="md-nav__icon md-icon"></span>
2470         </label>
2471
2472       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2473         <label class="md-nav__title" for="__nav_7">
2474           <span class="md-nav__icon md-icon"></span>
2475           Tutorials
2476         </label>
2477         <ul class="md-nav__list" data-md-scrollfix>
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_1" >
2491
2492
2493
2494         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2495           Tutorial Series
2496           <span class="md-nav__icon md-icon"></span>
2497         </label>
2498
2499       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2500         <label class="md-nav__title" for="__nav_7_1">
2501           <span class="md-nav__icon md-icon"></span>
2502           Tutorial Series
2503         </label>
2504         <ul class="md-nav__list" data-md-scrollfix>
2505
2506
2507
2508
2509
2510
2511     <li class="md-nav__item">
2512       <a href="../../tutorial/series/overview/" class="md-nav__link">
2513         Overview
2514       </a>
2515     </li>
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525     <li class="md-nav__item">
2526       <a href="../../tutorial/series/part_1/" class="md-nav__link">
2527         Part 1
2528       </a>
2529     </li>
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539     <li class="md-nav__item">
2540       <a href="../../tutorial/series/part_2/" class="md-nav__link">
2541         Part 2
2542       </a>
2543     </li>
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553     <li class="md-nav__item">
2554       <a href="../../tutorial/series/part_3/" class="md-nav__link">
2555         Part 3
2556       </a>
2557     </li>
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567     <li class="md-nav__item">
2568       <a href="../../tutorial/series/part_4/" class="md-nav__link">
2569         Part 4
2570       </a>
2571     </li>
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581     <li class="md-nav__item">
2582       <a href="../../tutorial/series/part_5/" class="md-nav__link">
2583         Part 5
2584       </a>
2585     </li>
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595     <li class="md-nav__item">
2596       <a href="../../tutorial/series/part_6/" class="md-nav__link">
2597         Part 6
2598       </a>
2599     </li>
2600
2601
2602
2603
2604         </ul>
2605       </nav>
2606     </li>
2607
2608
2609
2610
2611         </ul>
2612       </nav>
2613     </li>
2614
2615
2616
2617   </ul>
2618 </nav>
2619                   </div>
2620                 </div>
2621               </div>
2622
2623
2624
2625               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2626                 <div class="md-sidebar__scrollwrap">
2627                   <div class="md-sidebar__inner">
2628
2629
2630 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2631
2632
2633
2634
2635
2636
2637     <label class="md-nav__title" for="__toc">
2638       <span class="md-nav__icon md-icon"></span>
2639       Table of contents
2640     </label>
2641     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2642
2643         <li class="md-nav__item">
2644   <a href="#built-in-pips" class="md-nav__link">
2645     Built-In PIPs
2646   </a>
2647
2648 </li>
2649
2650     </ul>
2651
2652 </nav>
2653                   </div>
2654                 </div>
2655               </div>
2656
2657
2658
2659             <div class="md-content" data-md-component="content">
2660               <article class="md-content__inner md-typeset">
2661
2662
2663
2664
2665
2666
2667
2668 <h1 id="package-installation-plugins">Package Installation Plugins<a class="headerlink" href="#package-installation-plugins" title="Permanent link">#</a></h1>
2669 <p>Package Installation Plugins (PIPs) are interfaces to deploy and edit content as well as components.</p>
2670 <div class="admonition info">
2671 <p class="admonition-title">For XML-based PIPs: <code>&lt;![CDATA[]]&gt;</code> must be used for language items and page contents. In all other cases it may only be used when necessary.</p>
2672 </div>
2673 <h2 id="built-in-pips">Built-In PIPs<a class="headerlink" href="#built-in-pips" title="Permanent link">#</a></h2>
2674 <table>
2675 <thead>
2676 <tr>
2677 <th>Name</th>
2678 <th>Description</th>
2679 </tr>
2680 </thead>
2681 <tbody>
2682 <tr>
2683 <td><a href="acl-option/">aclOption</a></td>
2684 <td>Customizable permissions for individual objects</td>
2685 </tr>
2686 <tr>
2687 <td><a href="acp-menu/">acpMenu</a></td>
2688 <td>Admin panel menu categories and items</td>
2689 </tr>
2690 <tr>
2691 <td><a href="acp-search-provider/">acpSearchProvider</a></td>
2692 <td>Data provider for the admin panel search</td>
2693 </tr>
2694 <tr>
2695 <td><a href="acp-template/">acpTemplate</a></td>
2696 <td>Admin panel templates</td>
2697 </tr>
2698 <tr>
2699 <td><a href="acp-template-delete/">acpTemplateDelete</a></td>
2700 <td>Deletes admin panel templates installed with <a href="acp-template/">acpTemplate</a></td>
2701 </tr>
2702 <tr>
2703 <td><a href="bbcode/">bbcode</a></td>
2704 <td>BBCodes for rich message formatting</td>
2705 </tr>
2706 <tr>
2707 <td><a href="box/">box</a></td>
2708 <td>Boxes that can be placed anywhere on a page</td>
2709 </tr>
2710 <tr>
2711 <td><a href="clipboard-action/">clipboardAction</a></td>
2712 <td>Perform bulk operations on marked objects</td>
2713 </tr>
2714 <tr>
2715 <td><a href="core-object/">coreObject</a></td>
2716 <td>Access Singletons from within the template</td>
2717 </tr>
2718 <tr>
2719 <td><a href="cronjob/">cronjob</a></td>
2720 <td>Periodically execute code with customizable intervals</td>
2721 </tr>
2722 <tr>
2723 <td><a href="database/">database</a></td>
2724 <td>Updates the database layout using <a href="../database-php-api/">the PHP API</a></td>
2725 </tr>
2726 <tr>
2727 <td><a href="event-listener/">eventListener</a></td>
2728 <td>Register listeners for the event system</td>
2729 </tr>
2730 <tr>
2731 <td><a href="file/">file</a></td>
2732 <td>Deploy any type of files with the exception of templates</td>
2733 </tr>
2734 <tr>
2735 <td><a href="file-delete/">fileDelete</a></td>
2736 <td>Deletes files installed with <a href="file/">file</a></td>
2737 </tr>
2738 <tr>
2739 <td><a href="language/">language</a></td>
2740 <td>Language items</td>
2741 </tr>
2742 <tr>
2743 <td><a href="media-provider/">mediaProvider</a></td>
2744 <td>Detect and convert links to media providers</td>
2745 </tr>
2746 <tr>
2747 <td><a href="menu/">menu</a></td>
2748 <td>Side-wide and custom per-page menus</td>
2749 </tr>
2750 <tr>
2751 <td><a href="menu-item/">menuItem</a></td>
2752 <td>Menu items for menus created through the menu PIP</td>
2753 </tr>
2754 <tr>
2755 <td><a href="object-type/">objectType</a></td>
2756 <td>Flexible type registry based on definitions</td>
2757 </tr>
2758 <tr>
2759 <td><a href="object-type-definition/">objectTypeDefinition</a></td>
2760 <td>Groups objects and classes by functionality</td>
2761 </tr>
2762 <tr>
2763 <td><a href="option/">option</a></td>
2764 <td>Side-wide configuration options</td>
2765 </tr>
2766 <tr>
2767 <td><a href="page/">page</a></td>
2768 <td>Register page controllers and text-based pages</td>
2769 </tr>
2770 <tr>
2771 <td><a href="pip/">pip</a></td>
2772 <td>Package Installation Plugins</td>
2773 </tr>
2774 <tr>
2775 <td><a href="script/">script</a></td>
2776 <td>Execute arbitrary PHP code during installation, update and uninstallation</td>
2777 </tr>
2778 <tr>
2779 <td><a href="smiley/">smiley</a></td>
2780 <td>Smileys</td>
2781 </tr>
2782 <tr>
2783 <td><a href="sql/">sql</a></td>
2784 <td>Execute SQL instructions using a MySQL-flavored syntax (also see <a href="../database-php-api/">database PHP API</a>)</td>
2785 </tr>
2786 <tr>
2787 <td><a href="style/">style</a></td>
2788 <td>Style</td>
2789 </tr>
2790 <tr>
2791 <td><a href="template/">template</a></td>
2792 <td>Frontend templates</td>
2793 </tr>
2794 <tr>
2795 <td><a href="template-delete/">templateDelete</a></td>
2796 <td>Deletes frontend templates installed with <a href="template/">template</a></td>
2797 </tr>
2798 <tr>
2799 <td><a href="template-listener/">templateListener</a></td>
2800 <td>Embed template code into templates without altering the original</td>
2801 </tr>
2802 <tr>
2803 <td><a href="user-group-option/">userGroupOption</a></td>
2804 <td>Permissions for user groups</td>
2805 </tr>
2806 <tr>
2807 <td><a href="user-menu/">userMenu</a></td>
2808 <td>User menu categories and items</td>
2809 </tr>
2810 <tr>
2811 <td><a href="user-notification-event/">userNotificationEvent</a></td>
2812 <td>Events of the user notification system</td>
2813 </tr>
2814 <tr>
2815 <td><a href="user-option/">userOption</a></td>
2816 <td>User settings</td>
2817 </tr>
2818 <tr>
2819 <td><a href="user-profile-menu/">userProfileMenu</a></td>
2820 <td>User profile tabs</td>
2821 </tr>
2822 </tbody>
2823 </table>
2824
2825   <hr>
2826 <div class="md-source-file">
2827   <small>
2828
2829       Last update:
2830       2021-06-08
2831
2832   </small>
2833 </div>
2834
2835
2836
2837
2838
2839
2840               </article>
2841             </div>
2842
2843
2844         </div>
2845
2846       </main>
2847
2848         <footer class="md-footer">
2849
2850   <div class="md-footer-meta md-typeset">
2851     <div class="md-footer-meta__inner md-grid">
2852       <div class="md-copyright">
2853
2854     <div class="md-copyright__highlight">
2855       Copyright © 2020 WoltLab GmbH
2856     </div>
2857
2858
2859     Made with
2860     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2861       Material for MkDocs
2862     </a>
2863
2864 </div>
2865
2866         <div class="md-copyright">
2867         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2868         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2869 </div>
2870
2871     </div>
2872   </div>
2873 </footer>
2874
2875     </div>
2876     <div class="md-dialog" data-md-component="dialog">
2877       <div class="md-dialog__inner md-typeset"></div>
2878     </div>
2879
2880     <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>
2881
2882
2883       <script src="../../assets/javascripts/bundle.b4d07000.min.js"></script>
2884
2885
2886   </body>
2887 </html>