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