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     <li class="md-nav__item">
 310       <a href="../../php/api/caches/" class="md-nav__link">
 311         Caches
 312       </a>
 313     </li>
 314
 315
 316
 317
 318
 319
 320
 321     <li class="md-nav__item">
 322       <a href="../../php/api/comments/" class="md-nav__link">
 323         Comments
 324       </a>
 325     </li>
 326
 327
 328
 329
 330
 331
 332
 333     <li class="md-nav__item">
 334       <a href="../../php/api/cronjobs/" class="md-nav__link">
 335         Cronjobs
 336       </a>
 337     </li>
 338
 339
 340
 341
 342
 343
 344
 345     <li class="md-nav__item">
 346       <a href="../../php/api/events/" class="md-nav__link">
 347         Events
 348       </a>
 349     </li>
 350
 351
 352
 353
 354
 355
 356
 357
 358     <li class="md-nav__item md-nav__item--nested">
 359
 360
 361         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 362
 363       <label class="md-nav__link" for="__nav_2_5_5">
 364         Form Builder
 365         <span class="md-nav__icon md-icon"></span>
 366       </label>
 367       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 368         <label class="md-nav__title" for="__nav_2_5_5">
 369           <span class="md-nav__icon md-icon"></span>
 370           Form Builder
 371         </label>
 372         <ul class="md-nav__list" data-md-scrollfix>
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../php/api/form_builder/overview/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390     <li class="md-nav__item">
 391       <a href="../../php/api/form_builder/structure/" class="md-nav__link">
 392         Structure
 393       </a>
 394     </li>
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
 404         Fields
 405       </a>
 406     </li>
 407
 408
 409
 410
 411
 412
 413
 414     <li class="md-nav__item">
 415       <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
 416         Validation and Data
 417       </a>
 418     </li>
 419
 420
 421
 422
 423
 424
 425
 426     <li class="md-nav__item">
 427       <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
 428         Dependencies
 429       </a>
 430     </li>
 431
 432
 433
 434         </ul>
 435       </nav>
 436     </li>
 437
 438
 439
 440
 441
 442
 443
 444     <li class="md-nav__item">
 445       <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
 446         Package Installation Plugins
 447       </a>
 448     </li>
 449
 450
 451
 452
 453
 454
 455
 456     <li class="md-nav__item">
 457       <a href="../../php/api/user_activity_points/" class="md-nav__link">
 458         User Activity Points
 459       </a>
 460     </li>
 461
 462
 463
 464
 465
 466
 467
 468     <li class="md-nav__item">
 469       <a href="../../php/api/user_notifications/" class="md-nav__link">
 470         User Notifications
 471       </a>
 472     </li>
 473
 474
 475
 476
 477
 478
 479
 480     <li class="md-nav__item">
 481       <a href="../../php/api/sitemaps/" class="md-nav__link">
 482         Sitemaps
 483       </a>
 484     </li>
 485
 486
 487
 488         </ul>
 489       </nav>
 490     </li>
 491
 492
 493
 494
 495
 496
 497
 498     <li class="md-nav__item">
 499       <a href="../../php/code-style/" class="md-nav__link">
 500         Code Style
 501       </a>
 502     </li>
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../php/apps/" class="md-nav__link">
 512         Apps
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522     <li class="md-nav__item">
 523       <a href="../../php/gdpr/" class="md-nav__link">
 524         GDPR
 525       </a>
 526     </li>
 527
 528
 529
 530         </ul>
 531       </nav>
 532     </li>
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544     <li class="md-nav__item md-nav__item--nested">
 545
 546
 547         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 548
 549       <label class="md-nav__link" for="__nav_3">
 550         Languages, Templates & CSS
 551         <span class="md-nav__icon md-icon"></span>
 552       </label>
 553       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 554         <label class="md-nav__title" for="__nav_3">
 555           <span class="md-nav__icon md-icon"></span>
 556           Languages, Templates & CSS
 557         </label>
 558         <ul class="md-nav__list" data-md-scrollfix>
 559
 560
 561
 562
 563
 564     <li class="md-nav__item">
 565       <a href="../../view/languages/" class="md-nav__link">
 566         Languages
 567       </a>
 568     </li>
 569
 570
 571
 572
 573
 574
 575
 576     <li class="md-nav__item">
 577       <a href="../../view/templates/" class="md-nav__link">
 578         Templates
 579       </a>
 580     </li>
 581
 582
 583
 584
 585
 586
 587
 588     <li class="md-nav__item">
 589       <a href="../../view/css/" class="md-nav__link">
 590         CSS
 591       </a>
 592     </li>
 593
 594
 595
 596         </ul>
 597       </nav>
 598     </li>
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610     <li class="md-nav__item md-nav__item--nested">
 611
 612
 613         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 614
 615       <label class="md-nav__link" for="__nav_4">
 616         JavaScript API
 617         <span class="md-nav__icon md-icon"></span>
 618       </label>
 619       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 620         <label class="md-nav__title" for="__nav_4">
 621           <span class="md-nav__icon md-icon"></span>
 622           JavaScript API
 623         </label>
 624         <ul class="md-nav__list" data-md-scrollfix>
 625
 626
 627
 628
 629
 630     <li class="md-nav__item">
 631       <a href="../../javascript/general-usage/" class="md-nav__link">
 632         General Usage
 633       </a>
 634     </li>
 635
 636
 637
 638
 639
 640
 641
 642
 643     <li class="md-nav__item md-nav__item--nested">
 644
 645
 646         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 647
 648       <label class="md-nav__link" for="__nav_4_2">
 649         New API
 650         <span class="md-nav__icon md-icon"></span>
 651       </label>
 652       <nav class="md-nav" aria-label="New API" data-md-level="2">
 653         <label class="md-nav__title" for="__nav_4_2">
 654           <span class="md-nav__icon md-icon"></span>
 655           New API
 656         </label>
 657         <ul class="md-nav__list" data-md-scrollfix>
 658
 659
 660
 661
 662
 663     <li class="md-nav__item">
 664       <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
 665         Writing a module
 666       </a>
 667     </li>
 668
 669
 670
 671
 672
 673
 674
 675     <li class="md-nav__item">
 676       <a href="../../javascript/new-api_data-structures/" class="md-nav__link">
 677         Data Structures
 678       </a>
 679     </li>
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item">
 688       <a href="../../javascript/new-api_core/" class="md-nav__link">
 689         Core Functions
 690       </a>
 691     </li>
 692
 693
 694
 695
 696
 697
 698
 699     <li class="md-nav__item">
 700       <a href="../../javascript/new-api_dom/" class="md-nav__link">
 701         DOM
 702       </a>
 703     </li>
 704
 705
 706
 707
 708
 709
 710
 711     <li class="md-nav__item">
 712       <a href="../../javascript/new-api_events/" class="md-nav__link">
 713         Event Handling
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../../javascript/new-api_ajax/" class="md-nav__link">
 725         Ajax
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735     <li class="md-nav__item">
 736       <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
 737         Dialogs
 738       </a>
 739     </li>
 740
 741
 742
 743
 744
 745
 746
 747     <li class="md-nav__item">
 748       <a href="../../javascript/new-api_browser/" class="md-nav__link">
 749         Browser and Screen Sizes
 750       </a>
 751     </li>
 752
 753
 754
 755
 756
 757
 758
 759     <li class="md-nav__item">
 760       <a href="../../javascript/new-api_ui/" class="md-nav__link">
 761         User Interface
 762       </a>
 763     </li>
 764
 765
 766
 767         </ul>
 768       </nav>
 769     </li>
 770
 771
 772
 773
 774
 775
 776
 777     <li class="md-nav__item">
 778       <a href="../../javascript/legacy-api/" class="md-nav__link">
 779         Legacy API
 780       </a>
 781     </li>
 782
 783
 784
 785
 786
 787
 788
 789     <li class="md-nav__item">
 790       <a href="../../javascript/helper-functions/" class="md-nav__link">
 791         Helper Functions
 792       </a>
 793     </li>
 794
 795
 796
 797
 798
 799
 800
 801     <li class="md-nav__item">
 802       <a href="../../javascript/code-snippets/" class="md-nav__link">
 803         Code Snippets
 804       </a>
 805     </li>
 806
 807
 808
 809         </ul>
 810       </nav>
 811     </li>
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 826
 827
 828         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 829
 830       <label class="md-nav__link" for="__nav_5">
 831         Package Components
 832         <span class="md-nav__icon md-icon"></span>
 833       </label>
 834       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 835         <label class="md-nav__title" for="__nav_5">
 836           <span class="md-nav__icon md-icon"></span>
 837           Package Components
 838         </label>
 839         <ul class="md-nav__list" data-md-scrollfix>
 840
 841
 842
 843
 844
 845     <li class="md-nav__item">
 846       <a href="../package-xml/" class="md-nav__link">
 847         package.xml
 848       </a>
 849     </li>
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 861
 862
 863         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
 864
 865       <label class="md-nav__link" for="__nav_5_2">
 866         PIPs
 867         <span class="md-nav__icon md-icon"></span>
 868       </label>
 869       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 870         <label class="md-nav__title" for="__nav_5_2">
 871           <span class="md-nav__icon md-icon"></span>
 872           PIPs
 873         </label>
 874         <ul class="md-nav__list" data-md-scrollfix>
 875
 876
 877
 878
 879
 880
 881
 882     <li class="md-nav__item md-nav__item--active">
 883
 884       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 885
 886
 887
 888
 889         <label class="md-nav__link md-nav__link--active" for="__toc">
 890           Overview
 891           <span class="md-nav__icon md-icon"></span>
 892         </label>
 893
 894       <a href="./" class="md-nav__link md-nav__link--active">
 895         Overview
 896       </a>
 897
 898
 899 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 900
 901
 902
 903
 904
 905     <label class="md-nav__title" for="__toc">
 906       <span class="md-nav__icon md-icon"></span>
 907       Table of contents
 908     </label>
 909     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 910
 911         <li class="md-nav__item">
 912   <a href="#built-in-pips" class="md-nav__link">
 913     Built-In PIPs
 914   </a>
 915
 916 </li>
 917
 918     </ul>
 919
 920 </nav>
 921
 922     </li>
 923
 924
 925
 926
 927
 928
 929
 930     <li class="md-nav__item">
 931       <a href="acl-option/" class="md-nav__link">
 932         aclOption
 933       </a>
 934     </li>
 935
 936
 937
 938
 939
 940
 941
 942     <li class="md-nav__item">
 943       <a href="acp-menu/" class="md-nav__link">
 944         acpMenu
 945       </a>
 946     </li>
 947
 948
 949
 950
 951
 952
 953
 954     <li class="md-nav__item">
 955       <a href="acp-search-provider/" class="md-nav__link">
 956         acpSearchProvider
 957       </a>
 958     </li>
 959
 960
 961
 962
 963
 964
 965
 966     <li class="md-nav__item">
 967       <a href="acp-template/" class="md-nav__link">
 968         acpTemplate
 969       </a>
 970     </li>
 971
 972
 973
 974
 975
 976
 977
 978     <li class="md-nav__item">
 979       <a href="bbcode/" class="md-nav__link">
 980         bbcode
 981       </a>
 982     </li>
 983
 984
 985
 986
 987
 988
 989
 990     <li class="md-nav__item">
 991       <a href="box/" class="md-nav__link">
 992         box
 993       </a>
 994     </li>
 995
 996
 997
 998
 999
1000
1001
1002     <li class="md-nav__item">
1003       <a href="clipboard-action/" class="md-nav__link">
1004         clipboardAction
1005       </a>
1006     </li>
1007
1008
1009
1010
1011
1012
1013
1014     <li class="md-nav__item">
1015       <a href="core-object/" class="md-nav__link">
1016         coreObject
1017       </a>
1018     </li>
1019
1020
1021
1022
1023
1024
1025
1026     <li class="md-nav__item">
1027       <a href="cronjob/" class="md-nav__link">
1028         cronjob
1029       </a>
1030     </li>
1031
1032
1033
1034
1035
1036
1037
1038     <li class="md-nav__item">
1039       <a href="event-listener/" class="md-nav__link">
1040         eventListener
1041       </a>
1042     </li>
1043
1044
1045
1046
1047
1048
1049
1050     <li class="md-nav__item">
1051       <a href="file/" class="md-nav__link">
1052         file
1053       </a>
1054     </li>
1055
1056
1057
1058
1059
1060
1061
1062     <li class="md-nav__item">
1063       <a href="language/" class="md-nav__link">
1064         language
1065       </a>
1066     </li>
1067
1068
1069
1070
1071
1072
1073
1074     <li class="md-nav__item">
1075       <a href="media-provider/" class="md-nav__link">
1076         mediaProvider
1077       </a>
1078     </li>
1079
1080
1081
1082
1083
1084
1085
1086     <li class="md-nav__item">
1087       <a href="menu/" class="md-nav__link">
1088         menu
1089       </a>
1090     </li>
1091
1092
1093
1094
1095
1096
1097
1098     <li class="md-nav__item">
1099       <a href="menu-item/" class="md-nav__link">
1100         menuItem
1101       </a>
1102     </li>
1103
1104
1105
1106
1107
1108
1109
1110     <li class="md-nav__item">
1111       <a href="object-type/" class="md-nav__link">
1112         objectType
1113       </a>
1114     </li>
1115
1116
1117
1118
1119
1120
1121
1122     <li class="md-nav__item">
1123       <a href="object-type-definition/" class="md-nav__link">
1124         objectTypeDefinition
1125       </a>
1126     </li>
1127
1128
1129
1130
1131
1132
1133
1134     <li class="md-nav__item">
1135       <a href="option/" class="md-nav__link">
1136         option
1137       </a>
1138     </li>
1139
1140
1141
1142
1143
1144
1145
1146     <li class="md-nav__item">
1147       <a href="page/" class="md-nav__link">
1148         page
1149       </a>
1150     </li>
1151
1152
1153
1154
1155
1156
1157
1158     <li class="md-nav__item">
1159       <a href="pip/" class="md-nav__link">
1160         pip
1161       </a>
1162     </li>
1163
1164
1165
1166
1167
1168
1169
1170     <li class="md-nav__item">
1171       <a href="script/" class="md-nav__link">
1172         script
1173       </a>
1174     </li>
1175
1176
1177
1178
1179
1180
1181
1182     <li class="md-nav__item">
1183       <a href="smiley/" class="md-nav__link">
1184         smiley
1185       </a>
1186     </li>
1187
1188
1189
1190
1191
1192
1193
1194     <li class="md-nav__item">
1195       <a href="sql/" class="md-nav__link">
1196         sql
1197       </a>
1198     </li>
1199
1200
1201
1202
1203
1204
1205
1206     <li class="md-nav__item">
1207       <a href="style/" class="md-nav__link">
1208         style
1209       </a>
1210     </li>
1211
1212
1213
1214
1215
1216
1217
1218     <li class="md-nav__item">
1219       <a href="template/" class="md-nav__link">
1220         template
1221       </a>
1222     </li>
1223
1224
1225
1226
1227
1228
1229
1230     <li class="md-nav__item">
1231       <a href="template-listener/" class="md-nav__link">
1232         templateListener
1233       </a>
1234     </li>
1235
1236
1237
1238
1239
1240
1241
1242     <li class="md-nav__item">
1243       <a href="user-group-option/" class="md-nav__link">
1244         userGroupOption
1245       </a>
1246     </li>
1247
1248
1249
1250
1251
1252
1253
1254     <li class="md-nav__item">
1255       <a href="user-menu/" class="md-nav__link">
1256         userMenu
1257       </a>
1258     </li>
1259
1260
1261
1262
1263
1264
1265
1266     <li class="md-nav__item">
1267       <a href="user-notification-event/" class="md-nav__link">
1268         userNotificationEvent
1269       </a>
1270     </li>
1271
1272
1273
1274
1275
1276
1277
1278     <li class="md-nav__item">
1279       <a href="user-option/" class="md-nav__link">
1280         userOption
1281       </a>
1282     </li>
1283
1284
1285
1286
1287
1288
1289
1290     <li class="md-nav__item">
1291       <a href="user-profile-menu/" class="md-nav__link">
1292         userProfileMenu
1293       </a>
1294     </li>
1295
1296
1297
1298         </ul>
1299       </nav>
1300     </li>
1301
1302
1303
1304
1305
1306
1307
1308     <li class="md-nav__item">
1309       <a href="../database-php-api/" class="md-nav__link">
1310         Database PHP API
1311       </a>
1312     </li>
1313
1314
1315
1316         </ul>
1317       </nav>
1318     </li>
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330     <li class="md-nav__item md-nav__item--nested">
1331
1332
1333         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1334
1335       <label class="md-nav__link" for="__nav_6">
1336         Migration
1337         <span class="md-nav__icon md-icon"></span>
1338       </label>
1339       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1340         <label class="md-nav__title" for="__nav_6">
1341           <span class="md-nav__icon md-icon"></span>
1342           Migration
1343         </label>
1344         <ul class="md-nav__list" data-md-scrollfix>
1345
1346
1347
1348
1349
1350
1351     <li class="md-nav__item md-nav__item--nested">
1352
1353
1354         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1355
1356       <label class="md-nav__link" for="__nav_6_1">
1357         Migrating from WSC 5.3
1358         <span class="md-nav__icon md-icon"></span>
1359       </label>
1360       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1361         <label class="md-nav__title" for="__nav_6_1">
1362           <span class="md-nav__icon md-icon"></span>
1363           Migrating from WSC 5.3
1364         </label>
1365         <ul class="md-nav__list" data-md-scrollfix>
1366
1367
1368
1369
1370
1371     <li class="md-nav__item">
1372       <a href="../../migration/wsc53/php/" class="md-nav__link">
1373         PHP API
1374       </a>
1375     </li>
1376
1377
1378
1379
1380
1381
1382
1383     <li class="md-nav__item">
1384       <a href="../../migration/wsc53/session/" class="md-nav__link">
1385         Session Handling and Authentication
1386       </a>
1387     </li>
1388
1389
1390
1391
1392
1393
1394
1395     <li class="md-nav__item">
1396       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1397         JavaScript
1398       </a>
1399     </li>
1400
1401
1402
1403
1404
1405
1406
1407     <li class="md-nav__item">
1408       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1409         Templates
1410       </a>
1411     </li>
1412
1413
1414
1415
1416
1417
1418
1419     <li class="md-nav__item">
1420       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1421         Third Party Libraries
1422       </a>
1423     </li>
1424
1425
1426
1427         </ul>
1428       </nav>
1429     </li>
1430
1431
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_2" type="checkbox" id="__nav_6_2" >
1442
1443       <label class="md-nav__link" for="__nav_6_2">
1444         Migrating from WSC 5.2
1445         <span class="md-nav__icon md-icon"></span>
1446       </label>
1447       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1448         <label class="md-nav__title" for="__nav_6_2">
1449           <span class="md-nav__icon md-icon"></span>
1450           Migrating from WSC 5.2
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/wsc52/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/wsc52/templates/" class="md-nav__link">
1472         Templates and Languages
1473       </a>
1474     </li>
1475
1476
1477
1478
1479
1480
1481
1482     <li class="md-nav__item">
1483       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1484         Third Party Libraries
1485       </a>
1486     </li>
1487
1488
1489
1490         </ul>
1491       </nav>
1492     </li>
1493
1494
1495
1496
1497
1498
1499
1500
1501     <li class="md-nav__item md-nav__item--nested">
1502
1503
1504         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1505
1506       <label class="md-nav__link" for="__nav_6_3">
1507         Migrating from WSC 3.1
1508         <span class="md-nav__icon md-icon"></span>
1509       </label>
1510       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1511         <label class="md-nav__title" for="__nav_6_3">
1512           <span class="md-nav__icon md-icon"></span>
1513           Migrating from WSC 3.1
1514         </label>
1515         <ul class="md-nav__list" data-md-scrollfix>
1516
1517
1518
1519
1520
1521     <li class="md-nav__item">
1522       <a href="../../migration/wsc31/php/" class="md-nav__link">
1523         PHP API
1524       </a>
1525     </li>
1526
1527
1528
1529         </ul>
1530       </nav>
1531     </li>
1532
1533
1534
1535
1536
1537
1538
1539
1540     <li class="md-nav__item md-nav__item--nested">
1541
1542
1543         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1544
1545       <label class="md-nav__link" for="__nav_6_4">
1546         Migrating from WSC 3.0
1547         <span class="md-nav__icon md-icon"></span>
1548       </label>
1549       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1550         <label class="md-nav__title" for="__nav_6_4">
1551           <span class="md-nav__icon md-icon"></span>
1552           Migrating from WSC 3.0
1553         </label>
1554         <ul class="md-nav__list" data-md-scrollfix>
1555
1556
1557
1558
1559
1560     <li class="md-nav__item">
1561       <a href="../../migration/wsc30/php/" class="md-nav__link">
1562         PHP API
1563       </a>
1564     </li>
1565
1566
1567
1568
1569
1570
1571
1572     <li class="md-nav__item">
1573       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1574         JavaScript API
1575       </a>
1576     </li>
1577
1578
1579
1580
1581
1582
1583
1584     <li class="md-nav__item">
1585       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1586         Templates
1587       </a>
1588     </li>
1589
1590
1591
1592
1593
1594
1595
1596     <li class="md-nav__item">
1597       <a href="../../migration/wsc30/css/" class="md-nav__link">
1598         CSS
1599       </a>
1600     </li>
1601
1602
1603
1604
1605
1606
1607
1608     <li class="md-nav__item">
1609       <a href="../../migration/wsc30/package/" class="md-nav__link">
1610         Package Components
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_5" type="checkbox" id="__nav_6_5" >
1631
1632       <label class="md-nav__link" for="__nav_6_5">
1633         Migrating from WCF 2.1
1634         <span class="md-nav__icon md-icon"></span>
1635       </label>
1636       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1637         <label class="md-nav__title" for="__nav_6_5">
1638           <span class="md-nav__icon md-icon"></span>
1639           Migrating from WCF 2.1
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/wcf21/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/wcf21/templates/" class="md-nav__link">
1661         Templates
1662       </a>
1663     </li>
1664
1665
1666
1667
1668
1669
1670
1671     <li class="md-nav__item">
1672       <a href="../../migration/wcf21/css/" class="md-nav__link">
1673         CSS
1674       </a>
1675     </li>
1676
1677
1678
1679
1680
1681
1682
1683     <li class="md-nav__item">
1684       <a href="../../migration/wcf21/package/" class="md-nav__link">
1685         Package Components
1686       </a>
1687     </li>
1688
1689
1690
1691         </ul>
1692       </nav>
1693     </li>
1694
1695
1696
1697         </ul>
1698       </nav>
1699     </li>
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711     <li class="md-nav__item md-nav__item--nested">
1712
1713
1714         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1715
1716       <label class="md-nav__link" for="__nav_7">
1717         Tutorials
1718         <span class="md-nav__icon md-icon"></span>
1719       </label>
1720       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1721         <label class="md-nav__title" for="__nav_7">
1722           <span class="md-nav__icon md-icon"></span>
1723           Tutorials
1724         </label>
1725         <ul class="md-nav__list" data-md-scrollfix>
1726
1727
1728
1729
1730
1731
1732     <li class="md-nav__item md-nav__item--nested">
1733
1734
1735         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1736
1737       <label class="md-nav__link" for="__nav_7_1">
1738         Tutorial Series
1739         <span class="md-nav__icon md-icon"></span>
1740       </label>
1741       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1742         <label class="md-nav__title" for="__nav_7_1">
1743           <span class="md-nav__icon md-icon"></span>
1744           Tutorial Series
1745         </label>
1746         <ul class="md-nav__list" data-md-scrollfix>
1747
1748
1749
1750
1751
1752     <li class="md-nav__item">
1753       <a href="../../tutorial/series/overview/" class="md-nav__link">
1754         Overview
1755       </a>
1756     </li>
1757
1758
1759
1760
1761
1762
1763
1764     <li class="md-nav__item">
1765       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1766         Part 1
1767       </a>
1768     </li>
1769
1770
1771
1772
1773
1774
1775
1776     <li class="md-nav__item">
1777       <a href="../../tutorial/series/part_2/" class="md-nav__link">
1778         Part 2
1779       </a>
1780     </li>
1781
1782
1783
1784
1785
1786
1787
1788     <li class="md-nav__item">
1789       <a href="../../tutorial/series/part_3/" class="md-nav__link">
1790         Part 3
1791       </a>
1792     </li>
1793
1794
1795
1796         </ul>
1797       </nav>
1798     </li>
1799
1800
1801
1802         </ul>
1803       </nav>
1804     </li>
1805
1806
1807
1808   </ul>
1809 </nav>
1810                   </div>
1811                 </div>
1812               </div>
1813
1814
1815
1816               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1817                 <div class="md-sidebar__scrollwrap">
1818                   <div class="md-sidebar__inner">
1819
1820 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1821
1822
1823
1824
1825
1826     <label class="md-nav__title" for="__toc">
1827       <span class="md-nav__icon md-icon"></span>
1828       Table of contents
1829     </label>
1830     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1831
1832         <li class="md-nav__item">
1833   <a href="#built-in-pips" class="md-nav__link">
1834     Built-In PIPs
1835   </a>
1836
1837 </li>
1838
1839     </ul>
1840
1841 </nav>
1842                   </div>
1843                 </div>
1844               </div>
1845
1846
1847           <div class="md-content" data-md-component="content">
1848             <article class="md-content__inner md-typeset">
1849
1850
1851                   <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">
1852                     <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>
1853                   </a>
1854
1855
1856                 <h1 id="package-installation-plugins">Package Installation Plugins<a class="headerlink" href="#package-installation-plugins" title="Permanent link">#</a></h1>
1857 <p>Package Installation Plugins (PIPs) are interfaces to deploy and edit content as well as components.</p>
1858 <div class="admonition info">
1859 <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>
1860 </div>
1861 <h2 id="built-in-pips">Built-In PIPs<a class="headerlink" href="#built-in-pips" title="Permanent link">#</a></h2>
1862 <table>
1863 <thead>
1864 <tr>
1865 <th>Name</th>
1866 <th>Description</th>
1867 </tr>
1868 </thead>
1869 <tbody>
1870 <tr>
1871 <td><a href="acl-option/">aclOption</a></td>
1872 <td>Customizable permissions for individual objects</td>
1873 </tr>
1874 <tr>
1875 <td><a href="acp-menu/">acpMenu</a></td>
1876 <td>Admin panel menu categories and items</td>
1877 </tr>
1878 <tr>
1879 <td><a href="acp-search-provider/">acpSearchProvider</a></td>
1880 <td>Data provider for the admin panel search</td>
1881 </tr>
1882 <tr>
1883 <td><a href="acp-template/">acpTemplate</a></td>
1884 <td>Admin panel templates</td>
1885 </tr>
1886 <tr>
1887 <td><a href="bbcode/">bbcode</a></td>
1888 <td>BBCodes for rich message formatting</td>
1889 </tr>
1890 <tr>
1891 <td><a href="box/">box</a></td>
1892 <td>Boxes that can be placed anywhere on a page</td>
1893 </tr>
1894 <tr>
1895 <td><a href="clipboard-action/">clipboardAction</a></td>
1896 <td>Perform bulk operations on marked objects</td>
1897 </tr>
1898 <tr>
1899 <td><a href="core-object/">coreObject</a></td>
1900 <td>Access Singletons from within the template</td>
1901 </tr>
1902 <tr>
1903 <td><a href="cronjob/">cronjob</a></td>
1904 <td>Periodically execute code with customizable intervals</td>
1905 </tr>
1906 <tr>
1907 <td><a href="database/">database</a></td>
1908 <td>Updates the database layout using <a href="../database-php-api/">the PHP API</a></td>
1909 </tr>
1910 <tr>
1911 <td><a href="event-listener/">eventListener</a></td>
1912 <td>Register listeners for the event system</td>
1913 </tr>
1914 <tr>
1915 <td><a href="file/">file</a></td>
1916 <td>Deploy any type of files with the exception of templates</td>
1917 </tr>
1918 <tr>
1919 <td><a href="language/">language</a></td>
1920 <td>Language items</td>
1921 </tr>
1922 <tr>
1923 <td><a href="media-provider/">mediaProvider</a></td>
1924 <td>Detect and convert links to media providers</td>
1925 </tr>
1926 <tr>
1927 <td><a href="menu/">menu</a></td>
1928 <td>Side-wide and custom per-page menus</td>
1929 </tr>
1930 <tr>
1931 <td><a href="menu-item/">menuItem</a></td>
1932 <td>Menu items for menus created through the menu PIP</td>
1933 </tr>
1934 <tr>
1935 <td><a href="object-type/">objectType</a></td>
1936 <td>Flexible type registry based on definitions</td>
1937 </tr>
1938 <tr>
1939 <td><a href="object-type-definition/">objectTypeDefinition</a></td>
1940 <td>Groups objects and classes by functionality</td>
1941 </tr>
1942 <tr>
1943 <td><a href="option/">option</a></td>
1944 <td>Side-wide configuration options</td>
1945 </tr>
1946 <tr>
1947 <td><a href="page/">page</a></td>
1948 <td>Register page controllers and text-based pages</td>
1949 </tr>
1950 <tr>
1951 <td><a href="pip/">pip</a></td>
1952 <td>Package Installation Plugins</td>
1953 </tr>
1954 <tr>
1955 <td><a href="script/">script</a></td>
1956 <td>Execute arbitrary PHP code during installation, update and uninstallation</td>
1957 </tr>
1958 <tr>
1959 <td><a href="smiley/">smiley</a></td>
1960 <td>Smileys</td>
1961 </tr>
1962 <tr>
1963 <td><a href="sql/">sql</a></td>
1964 <td>Execute SQL instructions using a MySQL-flavored syntax (also see <a href="../database-php-api/">database PHP API</a>)</td>
1965 </tr>
1966 <tr>
1967 <td><a href="style/">style</a></td>
1968 <td>Style</td>
1969 </tr>
1970 <tr>
1971 <td><a href="template/">template</a></td>
1972 <td>Frontend templates</td>
1973 </tr>
1974 <tr>
1975 <td><a href="template-listener/">templateListener</a></td>
1976 <td>Embed template code into templates without altering the original</td>
1977 </tr>
1978 <tr>
1979 <td><a href="user-group-option/">userGroupOption</a></td>
1980 <td>Permissions for user groups</td>
1981 </tr>
1982 <tr>
1983 <td><a href="user-menu/">userMenu</a></td>
1984 <td>User menu categories and items</td>
1985 </tr>
1986 <tr>
1987 <td><a href="user-notification-event/">userNotificationEvent</a></td>
1988 <td>Events of the user notification system</td>
1989 </tr>
1990 <tr>
1991 <td><a href="user-option/">userOption</a></td>
1992 <td>User settings</td>
1993 </tr>
1994 <tr>
1995 <td><a href="user-profile-menu/">userProfileMenu</a></td>
1996 <td>User profile tabs</td>
1997 </tr>
1998 </tbody>
1999 </table>
2000
2001
2002
2003
2004 <hr>
2005 <div class="md-source-date">
2006   <small>
2007
2008       Last update: 2021-03-15
2009
2010   </small>
2011 </div>
2012
2013
2014
2015
2016
2017
2018
2019
2020             </article>
2021           </div>
2022         </div>
2023
2024       </main>
2025
2026
2027 <footer class="md-footer">
2028
2029     <nav class="md-footer__inner md-grid" aria-label="Footer">
2030
2031         <a href="../package-xml/" class="md-footer__link md-footer__link--prev" rel="prev">
2032           <div class="md-footer__button md-icon">
2033             <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>
2034           </div>
2035           <div class="md-footer__title">
2036             <div class="md-ellipsis">
2037               <span class="md-footer__direction">
2038                 Previous
2039               </span>
2040               package.xml
2041             </div>
2042           </div>
2043         </a>
2044
2045
2046         <a href="acl-option/" class="md-footer__link md-footer__link--next" rel="next">
2047           <div class="md-footer__title">
2048             <div class="md-ellipsis">
2049               <span class="md-footer__direction">
2050                 Next
2051               </span>
2052               aclOption
2053             </div>
2054           </div>
2055           <div class="md-footer__button md-icon">
2056             <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>
2057           </div>
2058         </a>
2059
2060     </nav>
2061
2062   <div class="md-footer-meta md-typeset">
2063     <div class="md-footer-meta__inner md-grid">
2064       <div class="md-footer-copyright">
2065
2066           <div class="md-footer-copyright__highlight">
2067             Copyright © 2020 WoltLab GmbH
2068           </div>
2069
2070         Made with
2071         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2072           Material for MkDocs
2073         </a>
2074
2075       </div>
2076       <div class="md-footer-copyright">
2077         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2078         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2079 </div>
2080     </div>
2081   </div>
2082 </footer>
2083
2084     </div>
2085     <div class="md-dialog" data-md-component="dialog">
2086       <div class="md-dialog__inner md-typeset"></div>
2087     </div>
2088     <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>
2089
2090
2091       <script src="../../assets/javascripts/bundle.d892486b.min.js"></script>
2092
2093
2094   </body>
2095 </html>