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.0">
  14
  15
  16
  17         <title>script - 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="#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         <label class="md-nav__link md-nav__link--active" for="__toc">
1229           script
1230           <span class="md-nav__icon md-icon"></span>
1231         </label>
1232
1233       <a href="./" class="md-nav__link md-nav__link--active">
1234         script
1235       </a>
1236
1237
1238 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1239
1240
1241
1242
1243
1244     <label class="md-nav__title" for="__toc">
1245       <span class="md-nav__icon md-icon"></span>
1246       Table of contents
1247     </label>
1248     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1249
1250         <li class="md-nav__item">
1251   <a href="#attributes" class="md-nav__link">
1252     Attributes
1253   </a>
1254
1255     <nav class="md-nav" aria-label="Attributes">
1256       <ul class="md-nav__list">
1257
1258           <li class="md-nav__item">
1259   <a href="#application" class="md-nav__link">
1260     application
1261   </a>
1262
1263 </li>
1264
1265       </ul>
1266     </nav>
1267
1268 </li>
1269
1270         <li class="md-nav__item">
1271   <a href="#expected-value" class="md-nav__link">
1272     Expected value
1273   </a>
1274
1275     <nav class="md-nav" aria-label="Expected value">
1276       <ul class="md-nav__list">
1277
1278           <li class="md-nav__item">
1279   <a href="#naming-convention" class="md-nav__link">
1280     Naming convention
1281   </a>
1282
1283 </li>
1284
1285       </ul>
1286     </nav>
1287
1288 </li>
1289
1290         <li class="md-nav__item">
1291   <a href="#execution-environment" class="md-nav__link">
1292     Execution environment
1293   </a>
1294
1295 </li>
1296
1297     </ul>
1298
1299 </nav>
1300
1301     </li>
1302
1303
1304
1305
1306
1307
1308
1309     <li class="md-nav__item">
1310       <a href="../smiley/" class="md-nav__link">
1311         smiley
1312       </a>
1313     </li>
1314
1315
1316
1317
1318
1319
1320
1321     <li class="md-nav__item">
1322       <a href="../sql/" class="md-nav__link">
1323         sql
1324       </a>
1325     </li>
1326
1327
1328
1329
1330
1331
1332
1333     <li class="md-nav__item">
1334       <a href="../style/" class="md-nav__link">
1335         style
1336       </a>
1337     </li>
1338
1339
1340
1341
1342
1343
1344
1345     <li class="md-nav__item">
1346       <a href="../template/" class="md-nav__link">
1347         template
1348       </a>
1349     </li>
1350
1351
1352
1353
1354
1355
1356
1357     <li class="md-nav__item">
1358       <a href="../template-listener/" class="md-nav__link">
1359         templateListener
1360       </a>
1361     </li>
1362
1363
1364
1365
1366
1367
1368
1369     <li class="md-nav__item">
1370       <a href="../user-group-option/" class="md-nav__link">
1371         userGroupOption
1372       </a>
1373     </li>
1374
1375
1376
1377
1378
1379
1380
1381     <li class="md-nav__item">
1382       <a href="../user-menu/" class="md-nav__link">
1383         userMenu
1384       </a>
1385     </li>
1386
1387
1388
1389
1390
1391
1392
1393     <li class="md-nav__item">
1394       <a href="../user-notification-event/" class="md-nav__link">
1395         userNotificationEvent
1396       </a>
1397     </li>
1398
1399
1400
1401
1402
1403
1404
1405     <li class="md-nav__item">
1406       <a href="../user-option/" class="md-nav__link">
1407         userOption
1408       </a>
1409     </li>
1410
1411
1412
1413
1414
1415
1416
1417     <li class="md-nav__item">
1418       <a href="../user-profile-menu/" class="md-nav__link">
1419         userProfileMenu
1420       </a>
1421     </li>
1422
1423
1424
1425         </ul>
1426       </nav>
1427     </li>
1428
1429
1430
1431
1432
1433
1434
1435     <li class="md-nav__item">
1436       <a href="../../database-php-api/" class="md-nav__link">
1437         Database PHP API
1438       </a>
1439     </li>
1440
1441
1442
1443         </ul>
1444       </nav>
1445     </li>
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457     <li class="md-nav__item md-nav__item--nested">
1458
1459
1460         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1461
1462       <label class="md-nav__link" for="__nav_6">
1463         Migration
1464         <span class="md-nav__icon md-icon"></span>
1465       </label>
1466       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1467         <label class="md-nav__title" for="__nav_6">
1468           <span class="md-nav__icon md-icon"></span>
1469           Migration
1470         </label>
1471         <ul class="md-nav__list" data-md-scrollfix>
1472
1473
1474
1475
1476
1477
1478     <li class="md-nav__item md-nav__item--nested">
1479
1480
1481         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1482
1483       <label class="md-nav__link" for="__nav_6_1">
1484         Migrating from WSC 5.3
1485         <span class="md-nav__icon md-icon"></span>
1486       </label>
1487       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1488         <label class="md-nav__title" for="__nav_6_1">
1489           <span class="md-nav__icon md-icon"></span>
1490           Migrating from WSC 5.3
1491         </label>
1492         <ul class="md-nav__list" data-md-scrollfix>
1493
1494
1495
1496
1497
1498     <li class="md-nav__item">
1499       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1500         PHP API
1501       </a>
1502     </li>
1503
1504
1505
1506
1507
1508
1509
1510     <li class="md-nav__item">
1511       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1512         Session Handling and Authentication
1513       </a>
1514     </li>
1515
1516
1517
1518
1519
1520
1521
1522     <li class="md-nav__item">
1523       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1524         TypeScript and JavaScript
1525       </a>
1526     </li>
1527
1528
1529
1530
1531
1532
1533
1534     <li class="md-nav__item">
1535       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1536         Templates
1537       </a>
1538     </li>
1539
1540
1541
1542
1543
1544
1545
1546     <li class="md-nav__item">
1547       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1548         Third Party Libraries
1549       </a>
1550     </li>
1551
1552
1553
1554         </ul>
1555       </nav>
1556     </li>
1557
1558
1559
1560
1561
1562
1563
1564
1565     <li class="md-nav__item md-nav__item--nested">
1566
1567
1568         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1569
1570       <label class="md-nav__link" for="__nav_6_2">
1571         Migrating from WSC 5.2
1572         <span class="md-nav__icon md-icon"></span>
1573       </label>
1574       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1575         <label class="md-nav__title" for="__nav_6_2">
1576           <span class="md-nav__icon md-icon"></span>
1577           Migrating from WSC 5.2
1578         </label>
1579         <ul class="md-nav__list" data-md-scrollfix>
1580
1581
1582
1583
1584
1585     <li class="md-nav__item">
1586       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1587         PHP API
1588       </a>
1589     </li>
1590
1591
1592
1593
1594
1595
1596
1597     <li class="md-nav__item">
1598       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1599         Templates and Languages
1600       </a>
1601     </li>
1602
1603
1604
1605
1606
1607
1608
1609     <li class="md-nav__item">
1610       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1611         Third Party Libraries
1612       </a>
1613     </li>
1614
1615
1616
1617         </ul>
1618       </nav>
1619     </li>
1620
1621
1622
1623
1624
1625
1626
1627
1628     <li class="md-nav__item md-nav__item--nested">
1629
1630
1631         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1632
1633       <label class="md-nav__link" for="__nav_6_3">
1634         Migrating from WSC 3.1
1635         <span class="md-nav__icon md-icon"></span>
1636       </label>
1637       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1638         <label class="md-nav__title" for="__nav_6_3">
1639           <span class="md-nav__icon md-icon"></span>
1640           Migrating from WSC 3.1
1641         </label>
1642         <ul class="md-nav__list" data-md-scrollfix>
1643
1644
1645
1646
1647
1648     <li class="md-nav__item">
1649       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1650         PHP API
1651       </a>
1652     </li>
1653
1654
1655
1656         </ul>
1657       </nav>
1658     </li>
1659
1660
1661
1662
1663
1664
1665
1666
1667     <li class="md-nav__item md-nav__item--nested">
1668
1669
1670         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1671
1672       <label class="md-nav__link" for="__nav_6_4">
1673         Migrating from WSC 3.0
1674         <span class="md-nav__icon md-icon"></span>
1675       </label>
1676       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1677         <label class="md-nav__title" for="__nav_6_4">
1678           <span class="md-nav__icon md-icon"></span>
1679           Migrating from WSC 3.0
1680         </label>
1681         <ul class="md-nav__list" data-md-scrollfix>
1682
1683
1684
1685
1686
1687     <li class="md-nav__item">
1688       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1689         PHP API
1690       </a>
1691     </li>
1692
1693
1694
1695
1696
1697
1698
1699     <li class="md-nav__item">
1700       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1701         JavaScript API
1702       </a>
1703     </li>
1704
1705
1706
1707
1708
1709
1710
1711     <li class="md-nav__item">
1712       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1713         Templates
1714       </a>
1715     </li>
1716
1717
1718
1719
1720
1721
1722
1723     <li class="md-nav__item">
1724       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1725         CSS
1726       </a>
1727     </li>
1728
1729
1730
1731
1732
1733
1734
1735     <li class="md-nav__item">
1736       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1737         Package Components
1738       </a>
1739     </li>
1740
1741
1742
1743         </ul>
1744       </nav>
1745     </li>
1746
1747
1748
1749
1750
1751
1752
1753
1754     <li class="md-nav__item md-nav__item--nested">
1755
1756
1757         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1758
1759       <label class="md-nav__link" for="__nav_6_5">
1760         Migrating from WCF 2.1
1761         <span class="md-nav__icon md-icon"></span>
1762       </label>
1763       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1764         <label class="md-nav__title" for="__nav_6_5">
1765           <span class="md-nav__icon md-icon"></span>
1766           Migrating from WCF 2.1
1767         </label>
1768         <ul class="md-nav__list" data-md-scrollfix>
1769
1770
1771
1772
1773
1774     <li class="md-nav__item">
1775       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1776         PHP API
1777       </a>
1778     </li>
1779
1780
1781
1782
1783
1784
1785
1786     <li class="md-nav__item">
1787       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1788         Templates
1789       </a>
1790     </li>
1791
1792
1793
1794
1795
1796
1797
1798     <li class="md-nav__item">
1799       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1800         CSS
1801       </a>
1802     </li>
1803
1804
1805
1806
1807
1808
1809
1810     <li class="md-nav__item">
1811       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1812         Package Components
1813       </a>
1814     </li>
1815
1816
1817
1818         </ul>
1819       </nav>
1820     </li>
1821
1822
1823
1824         </ul>
1825       </nav>
1826     </li>
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838     <li class="md-nav__item md-nav__item--nested">
1839
1840
1841         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1842
1843       <label class="md-nav__link" for="__nav_7">
1844         Tutorials
1845         <span class="md-nav__icon md-icon"></span>
1846       </label>
1847       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1848         <label class="md-nav__title" for="__nav_7">
1849           <span class="md-nav__icon md-icon"></span>
1850           Tutorials
1851         </label>
1852         <ul class="md-nav__list" data-md-scrollfix>
1853
1854
1855
1856
1857
1858
1859     <li class="md-nav__item md-nav__item--nested">
1860
1861
1862         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1863
1864       <label class="md-nav__link" for="__nav_7_1">
1865         Tutorial Series
1866         <span class="md-nav__icon md-icon"></span>
1867       </label>
1868       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1869         <label class="md-nav__title" for="__nav_7_1">
1870           <span class="md-nav__icon md-icon"></span>
1871           Tutorial Series
1872         </label>
1873         <ul class="md-nav__list" data-md-scrollfix>
1874
1875
1876
1877
1878
1879     <li class="md-nav__item">
1880       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1881         Overview
1882       </a>
1883     </li>
1884
1885
1886
1887
1888
1889
1890
1891     <li class="md-nav__item">
1892       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1893         Part 1
1894       </a>
1895     </li>
1896
1897
1898
1899
1900
1901
1902
1903     <li class="md-nav__item">
1904       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1905         Part 2
1906       </a>
1907     </li>
1908
1909
1910
1911
1912
1913
1914
1915     <li class="md-nav__item">
1916       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1917         Part 3
1918       </a>
1919     </li>
1920
1921
1922
1923         </ul>
1924       </nav>
1925     </li>
1926
1927
1928
1929         </ul>
1930       </nav>
1931     </li>
1932
1933
1934
1935   </ul>
1936 </nav>
1937                   </div>
1938                 </div>
1939               </div>
1940
1941
1942
1943               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1944                 <div class="md-sidebar__scrollwrap">
1945                   <div class="md-sidebar__inner">
1946
1947 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1948
1949
1950
1951
1952
1953     <label class="md-nav__title" for="__toc">
1954       <span class="md-nav__icon md-icon"></span>
1955       Table of contents
1956     </label>
1957     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1958
1959         <li class="md-nav__item">
1960   <a href="#attributes" class="md-nav__link">
1961     Attributes
1962   </a>
1963
1964     <nav class="md-nav" aria-label="Attributes">
1965       <ul class="md-nav__list">
1966
1967           <li class="md-nav__item">
1968   <a href="#application" class="md-nav__link">
1969     application
1970   </a>
1971
1972 </li>
1973
1974       </ul>
1975     </nav>
1976
1977 </li>
1978
1979         <li class="md-nav__item">
1980   <a href="#expected-value" class="md-nav__link">
1981     Expected value
1982   </a>
1983
1984     <nav class="md-nav" aria-label="Expected value">
1985       <ul class="md-nav__list">
1986
1987           <li class="md-nav__item">
1988   <a href="#naming-convention" class="md-nav__link">
1989     Naming convention
1990   </a>
1991
1992 </li>
1993
1994       </ul>
1995     </nav>
1996
1997 </li>
1998
1999         <li class="md-nav__item">
2000   <a href="#execution-environment" class="md-nav__link">
2001     Execution environment
2002   </a>
2003
2004 </li>
2005
2006     </ul>
2007
2008 </nav>
2009                   </div>
2010                 </div>
2011               </div>
2012
2013
2014           <div class="md-content" data-md-component="content">
2015             <article class="md-content__inner md-typeset">
2016
2017
2018                   <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">
2019                     <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>
2020                   </a>
2021
2022
2023                 <h1 id="script-package-installation-plugin">Script Package Installation Plugin<a class="headerlink" href="#script-package-installation-plugin" title="Permanent link">#</a></h1>
2024 <p>Execute arbitrary PHP code during installation, update and uninstallation of the package.</p>
2025 <div class="admonition warning">
2026 <p class="admonition-title">You must install the PHP script through the <a href="../file/">file package installation plugin</a>.</p>
2027 </div>
2028 <div class="admonition warning">
2029 <p class="admonition-title">The installation will attempt to delete the script after successful execution.</p>
2030 </div>
2031 <h2 id="attributes">Attributes<a class="headerlink" href="#attributes" title="Permanent link">#</a></h2>
2032 <h3 id="application"><code>application</code><a class="headerlink" href="#application" title="Permanent link">#</a></h3>
2033 <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.
2034 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>
2035 <h2 id="expected-value">Expected value<a class="headerlink" href="#expected-value" title="Permanent link">#</a></h2>
2036 <p>The <code>script</code>-PIP expects a relative path to a <code>.php</code> file.</p>
2037 <h3 id="naming-convention">Naming convention<a class="headerlink" href="#naming-convention" title="Permanent link">#</a></h3>
2038 <p>The PHP script is deployed by using the <a href="../file/">file package installation plugin</a>.
2039 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>
2040 <ul>
2041 <li>Installation: <code>install_&lt;package&gt;_&lt;version&gt;.php</code> (example: <code>install_com.woltlab.wbb_5.0.0.php</code>)</li>
2042 <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>
2043 </ul>
2044 <p><code>&lt;targetVersion&gt;</code> equals the version number of the current package being installed.
2045 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>
2046 <h2 id="execution-environment">Execution environment<a class="headerlink" href="#execution-environment" title="Permanent link">#</a></h2>
2047 <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>.
2048 This grants you access to the class members, including <code>$this-&gt;installation</code>.</p>
2049 <p>You can retrieve the package id of the current package through <code>$this-&gt;installation-&gt;getPackageID()</code>.</p>
2050
2051
2052
2053
2054 <hr>
2055 <div class="md-source-date">
2056   <small>
2057
2058       Last update: 2021-01-08
2059
2060   </small>
2061 </div>
2062
2063
2064
2065
2066
2067
2068
2069
2070             </article>
2071           </div>
2072         </div>
2073
2074       </main>
2075
2076
2077 <footer class="md-footer">
2078
2079     <nav class="md-footer__inner md-grid" aria-label="Footer">
2080
2081         <a href="../pip/" class="md-footer__link md-footer__link--prev" rel="prev">
2082           <div class="md-footer__button md-icon">
2083             <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>
2084           </div>
2085           <div class="md-footer__title">
2086             <div class="md-ellipsis">
2087               <span class="md-footer__direction">
2088                 Previous
2089               </span>
2090               pip
2091             </div>
2092           </div>
2093         </a>
2094
2095
2096         <a href="../smiley/" class="md-footer__link md-footer__link--next" rel="next">
2097           <div class="md-footer__title">
2098             <div class="md-ellipsis">
2099               <span class="md-footer__direction">
2100                 Next
2101               </span>
2102               smiley
2103             </div>
2104           </div>
2105           <div class="md-footer__button md-icon">
2106             <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>
2107           </div>
2108         </a>
2109
2110     </nav>
2111
2112   <div class="md-footer-meta md-typeset">
2113     <div class="md-footer-meta__inner md-grid">
2114       <div class="md-footer-copyright">
2115
2116           <div class="md-footer-copyright__highlight">
2117             Copyright © 2020 WoltLab GmbH
2118           </div>
2119
2120         Made with
2121         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2122           Material for MkDocs
2123         </a>
2124
2125       </div>
2126       <div class="md-footer-copyright">
2127         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2128         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2129 </div>
2130     </div>
2131   </div>
2132 </footer>
2133
2134     </div>
2135     <div class="md-dialog" data-md-component="dialog">
2136       <div class="md-dialog__inner md-typeset"></div>
2137     </div>
2138     <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>
2139
2140
2141       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2142
2143
2144   </body>
2145 </html>