5.4/package/pip/script/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.2">
  14
  15
  16
  17         <title>script - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../../assets/stylesheets/main.6f955dcd.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="#script-package-installation-plugin" 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               script
 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     <li class="md-nav__item">
 956       <a href="../" class="md-nav__link">
 957         Overview
 958       </a>
 959     </li>
 960
 961
 962
 963
 964
 965
 966
 967     <li class="md-nav__item">
 968       <a href="../acl-option/" class="md-nav__link">
 969         aclOption
 970       </a>
 971     </li>
 972
 973
 974
 975
 976
 977
 978
 979     <li class="md-nav__item">
 980       <a href="../acp-menu/" class="md-nav__link">
 981         acpMenu
 982       </a>
 983     </li>
 984
 985
 986
 987
 988
 989
 990
 991     <li class="md-nav__item">
 992       <a href="../acp-search-provider/" class="md-nav__link">
 993         acpSearchProvider
 994       </a>
 995     </li>
 996
 997
 998
 999
1000
1001
1002
1003     <li class="md-nav__item">
1004       <a href="../acp-template/" class="md-nav__link">
1005         acpTemplate
1006       </a>
1007     </li>
1008
1009
1010
1011
1012
1013
1014
1015     <li class="md-nav__item">
1016       <a href="../bbcode/" class="md-nav__link">
1017         bbcode
1018       </a>
1019     </li>
1020
1021
1022
1023
1024
1025
1026
1027     <li class="md-nav__item">
1028       <a href="../box/" class="md-nav__link">
1029         box
1030       </a>
1031     </li>
1032
1033
1034
1035
1036
1037
1038
1039     <li class="md-nav__item">
1040       <a href="../clipboard-action/" class="md-nav__link">
1041         clipboardAction
1042       </a>
1043     </li>
1044
1045
1046
1047
1048
1049
1050
1051     <li class="md-nav__item">
1052       <a href="../core-object/" class="md-nav__link">
1053         coreObject
1054       </a>
1055     </li>
1056
1057
1058
1059
1060
1061
1062
1063     <li class="md-nav__item">
1064       <a href="../cronjob/" class="md-nav__link">
1065         cronjob
1066       </a>
1067     </li>
1068
1069
1070
1071
1072
1073
1074
1075     <li class="md-nav__item">
1076       <a href="../database/" class="md-nav__link">
1077         database
1078       </a>
1079     </li>
1080
1081
1082
1083
1084
1085
1086
1087     <li class="md-nav__item">
1088       <a href="../event-listener/" class="md-nav__link">
1089         eventListener
1090       </a>
1091     </li>
1092
1093
1094
1095
1096
1097
1098
1099     <li class="md-nav__item">
1100       <a href="../file/" class="md-nav__link">
1101         file
1102       </a>
1103     </li>
1104
1105
1106
1107
1108
1109
1110
1111     <li class="md-nav__item">
1112       <a href="../language/" class="md-nav__link">
1113         language
1114       </a>
1115     </li>
1116
1117
1118
1119
1120
1121
1122
1123     <li class="md-nav__item">
1124       <a href="../media-provider/" class="md-nav__link">
1125         mediaProvider
1126       </a>
1127     </li>
1128
1129
1130
1131
1132
1133
1134
1135     <li class="md-nav__item">
1136       <a href="../menu/" class="md-nav__link">
1137         menu
1138       </a>
1139     </li>
1140
1141
1142
1143
1144
1145
1146
1147     <li class="md-nav__item">
1148       <a href="../menu-item/" class="md-nav__link">
1149         menuItem
1150       </a>
1151     </li>
1152
1153
1154
1155
1156
1157
1158
1159     <li class="md-nav__item">
1160       <a href="../object-type/" class="md-nav__link">
1161         objectType
1162       </a>
1163     </li>
1164
1165
1166
1167
1168
1169
1170
1171     <li class="md-nav__item">
1172       <a href="../object-type-definition/" class="md-nav__link">
1173         objectTypeDefinition
1174       </a>
1175     </li>
1176
1177
1178
1179
1180
1181
1182
1183     <li class="md-nav__item">
1184       <a href="../option/" class="md-nav__link">
1185         option
1186       </a>
1187     </li>
1188
1189
1190
1191
1192
1193
1194
1195     <li class="md-nav__item">
1196       <a href="../page/" class="md-nav__link">
1197         page
1198       </a>
1199     </li>
1200
1201
1202
1203
1204
1205
1206
1207     <li class="md-nav__item">
1208       <a href="../pip/" class="md-nav__link">
1209         pip
1210       </a>
1211     </li>
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221     <li class="md-nav__item md-nav__item--active">
1222
1223       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1224
1225
1226
1227
1228
1229         <label class="md-nav__link md-nav__link--active" for="__toc">
1230           script
1231           <span class="md-nav__icon md-icon"></span>
1232         </label>
1233
1234       <a href="./" class="md-nav__link md-nav__link--active">
1235         script
1236       </a>
1237
1238
1239 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1240
1241
1242
1243
1244
1245
1246     <label class="md-nav__title" for="__toc">
1247       <span class="md-nav__icon md-icon"></span>
1248       Table of contents
1249     </label>
1250     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1251
1252         <li class="md-nav__item">
1253   <a href="#attributes" class="md-nav__link">
1254     Attributes
1255   </a>
1256
1257     <nav class="md-nav" aria-label="Attributes">
1258       <ul class="md-nav__list">
1259
1260           <li class="md-nav__item">
1261   <a href="#application" class="md-nav__link">
1262     application
1263   </a>
1264
1265 </li>
1266
1267       </ul>
1268     </nav>
1269
1270 </li>
1271
1272         <li class="md-nav__item">
1273   <a href="#expected-value" class="md-nav__link">
1274     Expected value
1275   </a>
1276
1277     <nav class="md-nav" aria-label="Expected value">
1278       <ul class="md-nav__list">
1279
1280           <li class="md-nav__item">
1281   <a href="#naming-convention" class="md-nav__link">
1282     Naming convention
1283   </a>
1284
1285 </li>
1286
1287       </ul>
1288     </nav>
1289
1290 </li>
1291
1292         <li class="md-nav__item">
1293   <a href="#execution-environment" class="md-nav__link">
1294     Execution environment
1295   </a>
1296
1297 </li>
1298
1299     </ul>
1300
1301 </nav>
1302
1303     </li>
1304
1305
1306
1307
1308
1309
1310
1311     <li class="md-nav__item">
1312       <a href="../smiley/" class="md-nav__link">
1313         smiley
1314       </a>
1315     </li>
1316
1317
1318
1319
1320
1321
1322
1323     <li class="md-nav__item">
1324       <a href="../sql/" class="md-nav__link">
1325         sql
1326       </a>
1327     </li>
1328
1329
1330
1331
1332
1333
1334
1335     <li class="md-nav__item">
1336       <a href="../style/" class="md-nav__link">
1337         style
1338       </a>
1339     </li>
1340
1341
1342
1343
1344
1345
1346
1347     <li class="md-nav__item">
1348       <a href="../template/" class="md-nav__link">
1349         template
1350       </a>
1351     </li>
1352
1353
1354
1355
1356
1357
1358
1359     <li class="md-nav__item">
1360       <a href="../template-listener/" class="md-nav__link">
1361         templateListener
1362       </a>
1363     </li>
1364
1365
1366
1367
1368
1369
1370
1371     <li class="md-nav__item">
1372       <a href="../user-group-option/" class="md-nav__link">
1373         userGroupOption
1374       </a>
1375     </li>
1376
1377
1378
1379
1380
1381
1382
1383     <li class="md-nav__item">
1384       <a href="../user-menu/" class="md-nav__link">
1385         userMenu
1386       </a>
1387     </li>
1388
1389
1390
1391
1392
1393
1394
1395     <li class="md-nav__item">
1396       <a href="../user-notification-event/" class="md-nav__link">
1397         userNotificationEvent
1398       </a>
1399     </li>
1400
1401
1402
1403
1404
1405
1406
1407     <li class="md-nav__item">
1408       <a href="../user-option/" class="md-nav__link">
1409         userOption
1410       </a>
1411     </li>
1412
1413
1414
1415
1416
1417
1418
1419     <li class="md-nav__item">
1420       <a href="../user-profile-menu/" class="md-nav__link">
1421         userProfileMenu
1422       </a>
1423     </li>
1424
1425
1426
1427         </ul>
1428       </nav>
1429     </li>
1430
1431
1432
1433
1434
1435
1436
1437     <li class="md-nav__item">
1438       <a href="../../database-php-api/" class="md-nav__link">
1439         Database PHP API
1440       </a>
1441     </li>
1442
1443
1444
1445         </ul>
1446       </nav>
1447     </li>
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459     <li class="md-nav__item md-nav__item--nested">
1460
1461
1462         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1463
1464       <label class="md-nav__link" for="__nav_6">
1465         Migration
1466         <span class="md-nav__icon md-icon"></span>
1467       </label>
1468       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1469         <label class="md-nav__title" for="__nav_6">
1470           <span class="md-nav__icon md-icon"></span>
1471           Migration
1472         </label>
1473         <ul class="md-nav__list" data-md-scrollfix>
1474
1475
1476
1477
1478
1479
1480     <li class="md-nav__item md-nav__item--nested">
1481
1482
1483         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1484
1485       <label class="md-nav__link" for="__nav_6_1">
1486         Migrating from WSC 5.3
1487         <span class="md-nav__icon md-icon"></span>
1488       </label>
1489       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1490         <label class="md-nav__title" for="__nav_6_1">
1491           <span class="md-nav__icon md-icon"></span>
1492           Migrating from WSC 5.3
1493         </label>
1494         <ul class="md-nav__list" data-md-scrollfix>
1495
1496
1497
1498
1499
1500     <li class="md-nav__item">
1501       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1502         PHP API
1503       </a>
1504     </li>
1505
1506
1507
1508
1509
1510
1511
1512     <li class="md-nav__item">
1513       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1514         Session Handling and Authentication
1515       </a>
1516     </li>
1517
1518
1519
1520
1521
1522
1523
1524     <li class="md-nav__item">
1525       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1526         TypeScript and JavaScript
1527       </a>
1528     </li>
1529
1530
1531
1532
1533
1534
1535
1536     <li class="md-nav__item">
1537       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1538         Templates
1539       </a>
1540     </li>
1541
1542
1543
1544
1545
1546
1547
1548     <li class="md-nav__item">
1549       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1550         Third Party Libraries
1551       </a>
1552     </li>
1553
1554
1555
1556         </ul>
1557       </nav>
1558     </li>
1559
1560
1561
1562
1563
1564
1565
1566
1567     <li class="md-nav__item md-nav__item--nested">
1568
1569
1570         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1571
1572       <label class="md-nav__link" for="__nav_6_2">
1573         Migrating from WSC 5.2
1574         <span class="md-nav__icon md-icon"></span>
1575       </label>
1576       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1577         <label class="md-nav__title" for="__nav_6_2">
1578           <span class="md-nav__icon md-icon"></span>
1579           Migrating from WSC 5.2
1580         </label>
1581         <ul class="md-nav__list" data-md-scrollfix>
1582
1583
1584
1585
1586
1587     <li class="md-nav__item">
1588       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1589         PHP API
1590       </a>
1591     </li>
1592
1593
1594
1595
1596
1597
1598
1599     <li class="md-nav__item">
1600       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1601         Templates and Languages
1602       </a>
1603     </li>
1604
1605
1606
1607
1608
1609
1610
1611     <li class="md-nav__item">
1612       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1613         Third Party Libraries
1614       </a>
1615     </li>
1616
1617
1618
1619         </ul>
1620       </nav>
1621     </li>
1622
1623
1624
1625
1626
1627
1628
1629
1630     <li class="md-nav__item md-nav__item--nested">
1631
1632
1633         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1634
1635       <label class="md-nav__link" for="__nav_6_3">
1636         Migrating from WSC 3.1
1637         <span class="md-nav__icon md-icon"></span>
1638       </label>
1639       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1640         <label class="md-nav__title" for="__nav_6_3">
1641           <span class="md-nav__icon md-icon"></span>
1642           Migrating from WSC 3.1
1643         </label>
1644         <ul class="md-nav__list" data-md-scrollfix>
1645
1646
1647
1648
1649
1650     <li class="md-nav__item">
1651       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1652         PHP API
1653       </a>
1654     </li>
1655
1656
1657
1658         </ul>
1659       </nav>
1660     </li>
1661
1662
1663
1664
1665
1666
1667
1668
1669     <li class="md-nav__item md-nav__item--nested">
1670
1671
1672         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1673
1674       <label class="md-nav__link" for="__nav_6_4">
1675         Migrating from WSC 3.0
1676         <span class="md-nav__icon md-icon"></span>
1677       </label>
1678       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1679         <label class="md-nav__title" for="__nav_6_4">
1680           <span class="md-nav__icon md-icon"></span>
1681           Migrating from WSC 3.0
1682         </label>
1683         <ul class="md-nav__list" data-md-scrollfix>
1684
1685
1686
1687
1688
1689     <li class="md-nav__item">
1690       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1691         PHP API
1692       </a>
1693     </li>
1694
1695
1696
1697
1698
1699
1700
1701     <li class="md-nav__item">
1702       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1703         JavaScript API
1704       </a>
1705     </li>
1706
1707
1708
1709
1710
1711
1712
1713     <li class="md-nav__item">
1714       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1715         Templates
1716       </a>
1717     </li>
1718
1719
1720
1721
1722
1723
1724
1725     <li class="md-nav__item">
1726       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1727         CSS
1728       </a>
1729     </li>
1730
1731
1732
1733
1734
1735
1736
1737     <li class="md-nav__item">
1738       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1739         Package Components
1740       </a>
1741     </li>
1742
1743
1744
1745         </ul>
1746       </nav>
1747     </li>
1748
1749
1750
1751
1752
1753
1754
1755
1756     <li class="md-nav__item md-nav__item--nested">
1757
1758
1759         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1760
1761       <label class="md-nav__link" for="__nav_6_5">
1762         Migrating from WCF 2.1
1763         <span class="md-nav__icon md-icon"></span>
1764       </label>
1765       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1766         <label class="md-nav__title" for="__nav_6_5">
1767           <span class="md-nav__icon md-icon"></span>
1768           Migrating from WCF 2.1
1769         </label>
1770         <ul class="md-nav__list" data-md-scrollfix>
1771
1772
1773
1774
1775
1776     <li class="md-nav__item">
1777       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1778         PHP API
1779       </a>
1780     </li>
1781
1782
1783
1784
1785
1786
1787
1788     <li class="md-nav__item">
1789       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1790         Templates
1791       </a>
1792     </li>
1793
1794
1795
1796
1797
1798
1799
1800     <li class="md-nav__item">
1801       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1802         CSS
1803       </a>
1804     </li>
1805
1806
1807
1808
1809
1810
1811
1812     <li class="md-nav__item">
1813       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1814         Package Components
1815       </a>
1816     </li>
1817
1818
1819
1820         </ul>
1821       </nav>
1822     </li>
1823
1824
1825
1826         </ul>
1827       </nav>
1828     </li>
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840     <li class="md-nav__item md-nav__item--nested">
1841
1842
1843         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1844
1845       <label class="md-nav__link" for="__nav_7">
1846         Tutorials
1847         <span class="md-nav__icon md-icon"></span>
1848       </label>
1849       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1850         <label class="md-nav__title" for="__nav_7">
1851           <span class="md-nav__icon md-icon"></span>
1852           Tutorials
1853         </label>
1854         <ul class="md-nav__list" data-md-scrollfix>
1855
1856
1857
1858
1859
1860
1861     <li class="md-nav__item md-nav__item--nested">
1862
1863
1864         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1865
1866       <label class="md-nav__link" for="__nav_7_1">
1867         Tutorial Series
1868         <span class="md-nav__icon md-icon"></span>
1869       </label>
1870       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1871         <label class="md-nav__title" for="__nav_7_1">
1872           <span class="md-nav__icon md-icon"></span>
1873           Tutorial Series
1874         </label>
1875         <ul class="md-nav__list" data-md-scrollfix>
1876
1877
1878
1879
1880
1881     <li class="md-nav__item">
1882       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1883         Overview
1884       </a>
1885     </li>
1886
1887
1888
1889
1890
1891
1892
1893     <li class="md-nav__item">
1894       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1895         Part 1
1896       </a>
1897     </li>
1898
1899
1900
1901
1902
1903
1904
1905     <li class="md-nav__item">
1906       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1907         Part 2
1908       </a>
1909     </li>
1910
1911
1912
1913
1914
1915
1916
1917     <li class="md-nav__item">
1918       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1919         Part 3
1920       </a>
1921     </li>
1922
1923
1924
1925
1926
1927
1928
1929     <li class="md-nav__item">
1930       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
1931         Part 4
1932       </a>
1933     </li>
1934
1935
1936
1937
1938
1939
1940
1941     <li class="md-nav__item">
1942       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
1943         Part 5
1944       </a>
1945     </li>
1946
1947
1948
1949         </ul>
1950       </nav>
1951     </li>
1952
1953
1954
1955         </ul>
1956       </nav>
1957     </li>
1958
1959
1960
1961   </ul>
1962 </nav>
1963                   </div>
1964                 </div>
1965               </div>
1966
1967
1968
1969               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1970                 <div class="md-sidebar__scrollwrap">
1971                   <div class="md-sidebar__inner">
1972
1973 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1974
1975
1976
1977
1978
1979
1980     <label class="md-nav__title" for="__toc">
1981       <span class="md-nav__icon md-icon"></span>
1982       Table of contents
1983     </label>
1984     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1985
1986         <li class="md-nav__item">
1987   <a href="#attributes" class="md-nav__link">
1988     Attributes
1989   </a>
1990
1991     <nav class="md-nav" aria-label="Attributes">
1992       <ul class="md-nav__list">
1993
1994           <li class="md-nav__item">
1995   <a href="#application" class="md-nav__link">
1996     application
1997   </a>
1998
1999 </li>
2000
2001       </ul>
2002     </nav>
2003
2004 </li>
2005
2006         <li class="md-nav__item">
2007   <a href="#expected-value" class="md-nav__link">
2008     Expected value
2009   </a>
2010
2011     <nav class="md-nav" aria-label="Expected value">
2012       <ul class="md-nav__list">
2013
2014           <li class="md-nav__item">
2015   <a href="#naming-convention" class="md-nav__link">
2016     Naming convention
2017   </a>
2018
2019 </li>
2020
2021       </ul>
2022     </nav>
2023
2024 </li>
2025
2026         <li class="md-nav__item">
2027   <a href="#execution-environment" class="md-nav__link">
2028     Execution environment
2029   </a>
2030
2031 </li>
2032
2033     </ul>
2034
2035 </nav>
2036                   </div>
2037                 </div>
2038               </div>
2039
2040
2041           <div class="md-content" data-md-component="content">
2042             <article class="md-content__inner md-typeset">
2043
2044
2045                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/script.md" title="Edit this page" class="md-content__button md-icon">
2046                     <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>
2047                   </a>
2048
2049
2050                 <h1 id="script-package-installation-plugin">Script Package Installation Plugin<a class="headerlink" href="#script-package-installation-plugin" title="Permanent link">#</a></h1>
2051 <p>Execute arbitrary PHP code during installation, update and uninstallation of the package.</p>
2052 <div class="admonition warning">
2053 <p class="admonition-title">You must install the PHP script through the <a href="../file/">file package installation plugin</a>.</p>
2054 </div>
2055 <div class="admonition warning">
2056 <p class="admonition-title">The installation will attempt to delete the script after successful execution.</p>
2057 </div>
2058 <h2 id="attributes">Attributes<a class="headerlink" href="#attributes" title="Permanent link">#</a></h2>
2059 <h3 id="application"><code>application</code><a class="headerlink" href="#application" title="Permanent link">#</a></h3>
2060 <p>The <code>application</code> attribute must have the same value as the <code>application</code> attribute of the <code>file</code> package installation plugin instruction so that the correct file in the intended application directory is executed.
2061 For further information about the <code>application</code> attribute, refer to its documentation on the <a href="../acp-template/#application">acpTemplate package installation plugin page</a>.</p>
2062 <h2 id="expected-value">Expected value<a class="headerlink" href="#expected-value" title="Permanent link">#</a></h2>
2063 <p>The <code>script</code>-PIP expects a relative path to a <code>.php</code> file.</p>
2064 <h3 id="naming-convention">Naming convention<a class="headerlink" href="#naming-convention" title="Permanent link">#</a></h3>
2065 <p>The PHP script is deployed by using the <a href="../file/">file package installation plugin</a>.
2066 To prevent it from colliding with other install script (remember: You cannot overwrite files created by another plugin), we highly recommend to make use of these naming conventions:</p>
2067 <ul>
2068 <li>Installation: <code>install_&lt;package&gt;_&lt;version&gt;.php</code> (example: <code>install_com.woltlab.wbb_5.0.0.php</code>)</li>
2069 <li>Update: <code>update_&lt;package&gt;_&lt;targetVersion&gt;.php</code> (example: <code>update_com.woltlab.wbb_5.0.0_pl_1.php</code>)</li>
2070 </ul>
2071 <p><code>&lt;targetVersion&gt;</code> equals the version number of the current package being installed.
2072 If you're updating from <code>1.0.0</code> to <code>1.0.1</code>, <code>&lt;targetVersion&gt;</code> should read <code>1.0.1</code>.</p>
2073 <h2 id="execution-environment">Execution environment<a class="headerlink" href="#execution-environment" title="Permanent link">#</a></h2>
2074 <p>The script is included using <code>include()</code> within <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/package/plugin/ScriptPackageInstallationPlugin.class.php#L69">ScriptPackageInstallationPlugin::run()</a>.
2075 This grants you access to the class members, including <code>$this-&gt;installation</code>.</p>
2076 <p>You can retrieve the package id of the current package through <code>$this-&gt;installation-&gt;getPackageID()</code>.</p>
2077
2078
2079
2080
2081 <hr>
2082 <div class="md-source-date">
2083   <small>
2084
2085       Last update: 2021-01-08
2086
2087   </small>
2088 </div>
2089
2090
2091
2092
2093
2094
2095
2096
2097             </article>
2098           </div>
2099         </div>
2100
2101       </main>
2102
2103
2104 <footer class="md-footer">
2105
2106     <nav class="md-footer__inner md-grid" aria-label="Footer">
2107
2108         <a href="../pip/" class="md-footer__link md-footer__link--prev" rel="prev">
2109           <div class="md-footer__button md-icon">
2110             <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>
2111           </div>
2112           <div class="md-footer__title">
2113             <div class="md-ellipsis">
2114               <span class="md-footer__direction">
2115                 Previous
2116               </span>
2117               pip
2118             </div>
2119           </div>
2120         </a>
2121
2122
2123         <a href="../smiley/" class="md-footer__link md-footer__link--next" rel="next">
2124           <div class="md-footer__title">
2125             <div class="md-ellipsis">
2126               <span class="md-footer__direction">
2127                 Next
2128               </span>
2129               smiley
2130             </div>
2131           </div>
2132           <div class="md-footer__button md-icon">
2133             <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>
2134           </div>
2135         </a>
2136
2137     </nav>
2138
2139   <div class="md-footer-meta md-typeset">
2140     <div class="md-footer-meta__inner md-grid">
2141       <div class="md-footer-copyright">
2142
2143           <div class="md-footer-copyright__highlight">
2144             Copyright © 2020 WoltLab GmbH
2145           </div>
2146
2147         Made with
2148         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2149           Material for MkDocs
2150         </a>
2151
2152       </div>
2153       <div class="md-footer-copyright">
2154         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2155         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2156 </div>
2157     </div>
2158   </div>
2159 </footer>
2160
2161     </div>
2162     <div class="md-dialog" data-md-component="dialog">
2163       <div class="md-dialog__inner md-typeset"></div>
2164     </div>
2165     <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>
2166
2167
2168       <script src="../../../assets/javascripts/bundle.4ea5477f.min.js"></script>
2169
2170
2171   </body>
2172 </html>