latest/package/pip/file/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="shortcut icon" href="../../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.5">
  14
  15
  16
  17         <title>file - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../../assets/stylesheets/main.77f3fd56.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../../assets/stylesheets/palette.7fa14f5b.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
  56     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  57     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  58     <label class="md-overlay" for="__drawer"></label>
  59     <div data-md-component="skip">
  60
  61
  62         <a href="#file-package-installation-plugin" class="md-skip">
  63           Skip to content
  64         </a>
  65
  66     </div>
  67     <div data-md-component="announce">
  68
  69         <aside class="md-announce">
  70           <div class="md-announce__inner md-grid md-typeset">
  71
  72     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  73
  74           </div>
  75         </aside>
  76
  77     </div>
  78
  79
  80
  81 <header class="md-header" data-md-component="header">
  82   <nav class="md-header__inner md-grid" aria-label="Header">
  83     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation">
  84
  85   <img src="../../../assets/logo.png" alt="logo">
  86
  87     </a>
  88     <label class="md-header__button md-icon" for="__drawer">
  89       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  90     </label>
  91     <div class="md-header__title" data-md-component="header-title">
  92       <div class="md-header__ellipsis">
  93         <div class="md-header__topic">
  94           <span class="md-ellipsis">
  95             WoltLab Suite Documentation
  96           </span>
  97         </div>
  98         <div class="md-header__topic" data-md-component="header-topic">
  99           <span class="md-ellipsis">
 100
 101               file
 102
 103           </span>
 104         </div>
 105       </div>
 106     </div>
 107     <div class="md-header__options">
 108
 109     </div>
 110
 111       <label class="md-header__button md-icon" for="__search">
 112         <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>
 113       </label>
 114
 115 <div class="md-search" data-md-component="search" role="dialog">
 116   <label class="md-search__overlay" for="__search"></label>
 117   <div class="md-search__inner" role="search">
 118     <form class="md-search__form" name="search">
 119       <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>
 120       <label class="md-search__icon md-icon" for="__search">
 121         <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>
 122         <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>
 123       </label>
 124       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 125         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.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>
 126       </button>
 127     </form>
 128     <div class="md-search__output">
 129       <div class="md-search__scrollwrap" data-md-scrollfix>
 130         <div class="md-search-result" data-md-component="search-result">
 131           <div class="md-search-result__meta">
 132             Initializing search
 133           </div>
 134           <ol class="md-search-result__list"></ol>
 135         </div>
 136       </div>
 137     </div>
 138   </div>
 139 </div>
 140
 141
 142   </nav>
 143 </header>
 144
 145     <div class="md-container" data-md-component="container">
 146
 147
 148
 149
 150       <main class="md-main" data-md-component="main">
 151         <div class="md-main__inner md-grid">
 152
 153
 154
 155               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 156                 <div class="md-sidebar__scrollwrap">
 157                   <div class="md-sidebar__inner">
 158
 159
 160
 161
 162
 163 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 164   <label class="md-nav__title" for="__drawer">
 165     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
 166
 167   <img src="../../../assets/logo.png" alt="logo">
 168
 169     </a>
 170     WoltLab Suite Documentation
 171   </label>
 172
 173   <ul class="md-nav__list" data-md-scrollfix>
 174
 175
 176
 177
 178
 179
 180
 181
 182     <li class="md-nav__item">
 183       <a href="../../../getting-started/" class="md-nav__link">
 184         Getting Started
 185       </a>
 186     </li>
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198     <li class="md-nav__item md-nav__item--nested">
 199
 200
 201         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 202
 203       <label class="md-nav__link" for="__nav_2">
 204         PHP API
 205         <span class="md-nav__icon md-icon"></span>
 206       </label>
 207       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 208         <label class="md-nav__title" for="__nav_2">
 209           <span class="md-nav__icon md-icon"></span>
 210           PHP API
 211         </label>
 212         <ul class="md-nav__list" data-md-scrollfix>
 213
 214
 215
 216
 217
 218     <li class="md-nav__item">
 219       <a href="../../../php/pages/" class="md-nav__link">
 220         Pages
 221       </a>
 222     </li>
 223
 224
 225
 226
 227
 228
 229
 230     <li class="md-nav__item">
 231       <a href="../../../php/database-objects/" class="md-nav__link">
 232         Database Objects
 233       </a>
 234     </li>
 235
 236
 237
 238
 239
 240
 241
 242     <li class="md-nav__item">
 243       <a href="../../../php/database-access/" class="md-nav__link">
 244         Database Access
 245       </a>
 246     </li>
 247
 248
 249
 250
 251
 252
 253
 254     <li class="md-nav__item">
 255       <a href="../../../php/exceptions/" class="md-nav__link">
 256         Exceptions
 257       </a>
 258     </li>
 259
 260
 261
 262
 263
 264
 265
 266
 267     <li class="md-nav__item md-nav__item--nested">
 268
 269
 270         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 271
 272       <label class="md-nav__link" for="__nav_2_5">
 273         API
 274         <span class="md-nav__icon md-icon"></span>
 275       </label>
 276       <nav class="md-nav" aria-label="API" data-md-level="2">
 277         <label class="md-nav__title" for="__nav_2_5">
 278           <span class="md-nav__icon md-icon"></span>
 279           API
 280         </label>
 281         <ul class="md-nav__list" data-md-scrollfix>
 282
 283
 284
 285
 286
 287     <li class="md-nav__item">
 288       <a href="../../../php/api/caches/" class="md-nav__link">
 289         Caches
 290       </a>
 291     </li>
 292
 293
 294
 295
 296
 297
 298
 299     <li class="md-nav__item">
 300       <a href="../../../php/api/comments/" class="md-nav__link">
 301         Comments
 302       </a>
 303     </li>
 304
 305
 306
 307
 308
 309
 310
 311     <li class="md-nav__item">
 312       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 313         Cronjobs
 314       </a>
 315     </li>
 316
 317
 318
 319
 320
 321
 322
 323     <li class="md-nav__item">
 324       <a href="../../../php/api/events/" class="md-nav__link">
 325         Events
 326       </a>
 327     </li>
 328
 329
 330
 331
 332
 333
 334
 335
 336     <li class="md-nav__item md-nav__item--nested">
 337
 338
 339         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 340
 341       <label class="md-nav__link" for="__nav_2_5_5">
 342         Form Builder
 343         <span class="md-nav__icon md-icon"></span>
 344       </label>
 345       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 346         <label class="md-nav__title" for="__nav_2_5_5">
 347           <span class="md-nav__icon md-icon"></span>
 348           Form Builder
 349         </label>
 350         <ul class="md-nav__list" data-md-scrollfix>
 351
 352
 353
 354
 355
 356     <li class="md-nav__item">
 357       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 358         Overview
 359       </a>
 360     </li>
 361
 362
 363
 364
 365
 366
 367
 368     <li class="md-nav__item">
 369       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 370         Structure
 371       </a>
 372     </li>
 373
 374
 375
 376
 377
 378
 379
 380     <li class="md-nav__item">
 381       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 382         Fields
 383       </a>
 384     </li>
 385
 386
 387
 388
 389
 390
 391
 392     <li class="md-nav__item">
 393       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 394         Validation and Data
 395       </a>
 396     </li>
 397
 398
 399
 400
 401
 402
 403
 404     <li class="md-nav__item">
 405       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 406         Dependencies
 407       </a>
 408     </li>
 409
 410
 411
 412         </ul>
 413       </nav>
 414     </li>
 415
 416
 417
 418
 419
 420
 421
 422     <li class="md-nav__item">
 423       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 424         Package Installation Plugins
 425       </a>
 426     </li>
 427
 428
 429
 430
 431
 432
 433
 434     <li class="md-nav__item">
 435       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 436         User Activity Points
 437       </a>
 438     </li>
 439
 440
 441
 442
 443
 444
 445
 446     <li class="md-nav__item">
 447       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 448         User Notifications
 449       </a>
 450     </li>
 451
 452
 453
 454
 455
 456
 457
 458     <li class="md-nav__item">
 459       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 460         Sitemaps
 461       </a>
 462     </li>
 463
 464
 465
 466         </ul>
 467       </nav>
 468     </li>
 469
 470
 471
 472
 473
 474
 475
 476     <li class="md-nav__item">
 477       <a href="../../../php/code-style/" class="md-nav__link">
 478         Code Style
 479       </a>
 480     </li>
 481
 482
 483
 484
 485
 486
 487
 488     <li class="md-nav__item">
 489       <a href="../../../php/apps/" class="md-nav__link">
 490         Apps
 491       </a>
 492     </li>
 493
 494
 495
 496
 497
 498
 499
 500     <li class="md-nav__item">
 501       <a href="../../../php/gdpr/" class="md-nav__link">
 502         GDPR
 503       </a>
 504     </li>
 505
 506
 507
 508         </ul>
 509       </nav>
 510     </li>
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522     <li class="md-nav__item md-nav__item--nested">
 523
 524
 525         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 526
 527       <label class="md-nav__link" for="__nav_3">
 528         Languages, Templates & CSS
 529         <span class="md-nav__icon md-icon"></span>
 530       </label>
 531       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 532         <label class="md-nav__title" for="__nav_3">
 533           <span class="md-nav__icon md-icon"></span>
 534           Languages, Templates & CSS
 535         </label>
 536         <ul class="md-nav__list" data-md-scrollfix>
 537
 538
 539
 540
 541
 542     <li class="md-nav__item">
 543       <a href="../../../view/languages/" class="md-nav__link">
 544         Languages
 545       </a>
 546     </li>
 547
 548
 549
 550
 551
 552
 553
 554     <li class="md-nav__item">
 555       <a href="../../../view/templates/" class="md-nav__link">
 556         Templates
 557       </a>
 558     </li>
 559
 560
 561
 562
 563
 564
 565
 566     <li class="md-nav__item">
 567       <a href="../../../view/css/" class="md-nav__link">
 568         CSS
 569       </a>
 570     </li>
 571
 572
 573
 574         </ul>
 575       </nav>
 576     </li>
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588     <li class="md-nav__item md-nav__item--nested">
 589
 590
 591         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 592
 593       <label class="md-nav__link" for="__nav_4">
 594         JavaScript API
 595         <span class="md-nav__icon md-icon"></span>
 596       </label>
 597       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 598         <label class="md-nav__title" for="__nav_4">
 599           <span class="md-nav__icon md-icon"></span>
 600           JavaScript API
 601         </label>
 602         <ul class="md-nav__list" data-md-scrollfix>
 603
 604
 605
 606
 607
 608     <li class="md-nav__item">
 609       <a href="../../../javascript/general-usage/" class="md-nav__link">
 610         General Usage
 611       </a>
 612     </li>
 613
 614
 615
 616
 617
 618
 619
 620
 621     <li class="md-nav__item md-nav__item--nested">
 622
 623
 624         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 625
 626       <label class="md-nav__link" for="__nav_4_2">
 627         New API
 628         <span class="md-nav__icon md-icon"></span>
 629       </label>
 630       <nav class="md-nav" aria-label="New API" data-md-level="2">
 631         <label class="md-nav__title" for="__nav_4_2">
 632           <span class="md-nav__icon md-icon"></span>
 633           New API
 634         </label>
 635         <ul class="md-nav__list" data-md-scrollfix>
 636
 637
 638
 639
 640
 641     <li class="md-nav__item">
 642       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 643         Writing a module
 644       </a>
 645     </li>
 646
 647
 648
 649
 650
 651
 652
 653     <li class="md-nav__item">
 654       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 655         Data Structures
 656       </a>
 657     </li>
 658
 659
 660
 661
 662
 663
 664
 665     <li class="md-nav__item">
 666       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 667         Core Functions
 668       </a>
 669     </li>
 670
 671
 672
 673
 674
 675
 676
 677     <li class="md-nav__item">
 678       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 679         DOM
 680       </a>
 681     </li>
 682
 683
 684
 685
 686
 687
 688
 689     <li class="md-nav__item">
 690       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 691         Event Handling
 692       </a>
 693     </li>
 694
 695
 696
 697
 698
 699
 700
 701     <li class="md-nav__item">
 702       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 703         Ajax
 704       </a>
 705     </li>
 706
 707
 708
 709
 710
 711
 712
 713     <li class="md-nav__item">
 714       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 715         Dialogs
 716       </a>
 717     </li>
 718
 719
 720
 721
 722
 723
 724
 725     <li class="md-nav__item">
 726       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 727         Browser and Screen Sizes
 728       </a>
 729     </li>
 730
 731
 732
 733
 734
 735
 736
 737     <li class="md-nav__item">
 738       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 739         User Interface
 740       </a>
 741     </li>
 742
 743
 744
 745         </ul>
 746       </nav>
 747     </li>
 748
 749
 750
 751
 752
 753
 754
 755     <li class="md-nav__item">
 756       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 757         Legacy API
 758       </a>
 759     </li>
 760
 761
 762
 763
 764
 765
 766
 767     <li class="md-nav__item">
 768       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 769         Helper Functions
 770       </a>
 771     </li>
 772
 773
 774
 775
 776
 777
 778
 779     <li class="md-nav__item">
 780       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 781         Code Snippets
 782       </a>
 783     </li>
 784
 785
 786
 787         </ul>
 788       </nav>
 789     </li>
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 804
 805
 806         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
 807
 808       <label class="md-nav__link" for="__nav_5">
 809         Package Components
 810         <span class="md-nav__icon md-icon"></span>
 811       </label>
 812       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 813         <label class="md-nav__title" for="__nav_5">
 814           <span class="md-nav__icon md-icon"></span>
 815           Package Components
 816         </label>
 817         <ul class="md-nav__list" data-md-scrollfix>
 818
 819
 820
 821
 822
 823     <li class="md-nav__item">
 824       <a href="../../package-xml/" class="md-nav__link">
 825         package.xml
 826       </a>
 827     </li>
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 839
 840
 841         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
 842
 843       <label class="md-nav__link" for="__nav_5_2">
 844         PIPs
 845         <span class="md-nav__icon md-icon"></span>
 846       </label>
 847       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 848         <label class="md-nav__title" for="__nav_5_2">
 849           <span class="md-nav__icon md-icon"></span>
 850           PIPs
 851         </label>
 852         <ul class="md-nav__list" data-md-scrollfix>
 853
 854
 855
 856
 857
 858     <li class="md-nav__item">
 859       <a href="../" class="md-nav__link">
 860         Overview
 861       </a>
 862     </li>
 863
 864
 865
 866
 867
 868
 869
 870     <li class="md-nav__item">
 871       <a href="../acl-option/" class="md-nav__link">
 872         aclOption
 873       </a>
 874     </li>
 875
 876
 877
 878
 879
 880
 881
 882     <li class="md-nav__item">
 883       <a href="../acp-menu/" class="md-nav__link">
 884         acpMenu
 885       </a>
 886     </li>
 887
 888
 889
 890
 891
 892
 893
 894     <li class="md-nav__item">
 895       <a href="../acp-search-provider/" class="md-nav__link">
 896         acpSearchProvider
 897       </a>
 898     </li>
 899
 900
 901
 902
 903
 904
 905
 906     <li class="md-nav__item">
 907       <a href="../acp-template/" class="md-nav__link">
 908         acpTemplate
 909       </a>
 910     </li>
 911
 912
 913
 914
 915
 916
 917
 918     <li class="md-nav__item">
 919       <a href="../bbcode/" class="md-nav__link">
 920         bbcode
 921       </a>
 922     </li>
 923
 924
 925
 926
 927
 928
 929
 930     <li class="md-nav__item">
 931       <a href="../box/" class="md-nav__link">
 932         box
 933       </a>
 934     </li>
 935
 936
 937
 938
 939
 940
 941
 942     <li class="md-nav__item">
 943       <a href="../clipboard-action/" class="md-nav__link">
 944         clipboardAction
 945       </a>
 946     </li>
 947
 948
 949
 950
 951
 952
 953
 954     <li class="md-nav__item">
 955       <a href="../core-object/" class="md-nav__link">
 956         coreObject
 957       </a>
 958     </li>
 959
 960
 961
 962
 963
 964
 965
 966     <li class="md-nav__item">
 967       <a href="../cronjob/" class="md-nav__link">
 968         cronjob
 969       </a>
 970     </li>
 971
 972
 973
 974
 975
 976
 977
 978     <li class="md-nav__item">
 979       <a href="../event-listener/" class="md-nav__link">
 980         eventListener
 981       </a>
 982     </li>
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992     <li class="md-nav__item md-nav__item--active">
 993
 994       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 995
 996
 997
 998
 999         <label class="md-nav__link md-nav__link--active" for="__toc">
1000           file
1001           <span class="md-nav__icon md-icon"></span>
1002         </label>
1003
1004       <a href="./" class="md-nav__link md-nav__link--active">
1005         file
1006       </a>
1007
1008
1009 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1010
1011
1012
1013
1014
1015     <label class="md-nav__title" for="__toc">
1016       <span class="md-nav__icon md-icon"></span>
1017       Table of contents
1018     </label>
1019     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1020
1021         <li class="md-nav__item">
1022   <a href="#archive" class="md-nav__link">
1023     Archive
1024   </a>
1025
1026 </li>
1027
1028         <li class="md-nav__item">
1029   <a href="#example-in-packagexml" class="md-nav__link">
1030     Example in package.xml
1031   </a>
1032
1033 </li>
1034
1035     </ul>
1036
1037 </nav>
1038
1039     </li>
1040
1041
1042
1043
1044
1045
1046
1047     <li class="md-nav__item">
1048       <a href="../language/" class="md-nav__link">
1049         language
1050       </a>
1051     </li>
1052
1053
1054
1055
1056
1057
1058
1059     <li class="md-nav__item">
1060       <a href="../media-provider/" class="md-nav__link">
1061         mediaProvider
1062       </a>
1063     </li>
1064
1065
1066
1067
1068
1069
1070
1071     <li class="md-nav__item">
1072       <a href="../menu/" class="md-nav__link">
1073         menu
1074       </a>
1075     </li>
1076
1077
1078
1079
1080
1081
1082
1083     <li class="md-nav__item">
1084       <a href="../menu-item/" class="md-nav__link">
1085         menuItem
1086       </a>
1087     </li>
1088
1089
1090
1091
1092
1093
1094
1095     <li class="md-nav__item">
1096       <a href="../object-type/" class="md-nav__link">
1097         objectType
1098       </a>
1099     </li>
1100
1101
1102
1103
1104
1105
1106
1107     <li class="md-nav__item">
1108       <a href="../object-type-definition/" class="md-nav__link">
1109         objectTypeDefinition
1110       </a>
1111     </li>
1112
1113
1114
1115
1116
1117
1118
1119     <li class="md-nav__item">
1120       <a href="../option/" class="md-nav__link">
1121         option
1122       </a>
1123     </li>
1124
1125
1126
1127
1128
1129
1130
1131     <li class="md-nav__item">
1132       <a href="../page/" class="md-nav__link">
1133         page
1134       </a>
1135     </li>
1136
1137
1138
1139
1140
1141
1142
1143     <li class="md-nav__item">
1144       <a href="../pip/" class="md-nav__link">
1145         pip
1146       </a>
1147     </li>
1148
1149
1150
1151
1152
1153
1154
1155     <li class="md-nav__item">
1156       <a href="../script/" class="md-nav__link">
1157         script
1158       </a>
1159     </li>
1160
1161
1162
1163
1164
1165
1166
1167     <li class="md-nav__item">
1168       <a href="../smiley/" class="md-nav__link">
1169         smiley
1170       </a>
1171     </li>
1172
1173
1174
1175
1176
1177
1178
1179     <li class="md-nav__item">
1180       <a href="../sql/" class="md-nav__link">
1181         sql
1182       </a>
1183     </li>
1184
1185
1186
1187
1188
1189
1190
1191     <li class="md-nav__item">
1192       <a href="../style/" class="md-nav__link">
1193         style
1194       </a>
1195     </li>
1196
1197
1198
1199
1200
1201
1202
1203     <li class="md-nav__item">
1204       <a href="../template/" class="md-nav__link">
1205         template
1206       </a>
1207     </li>
1208
1209
1210
1211
1212
1213
1214
1215     <li class="md-nav__item">
1216       <a href="../template-listener/" class="md-nav__link">
1217         templateListener
1218       </a>
1219     </li>
1220
1221
1222
1223
1224
1225
1226
1227     <li class="md-nav__item">
1228       <a href="../user-group-option/" class="md-nav__link">
1229         userGroupOption
1230       </a>
1231     </li>
1232
1233
1234
1235
1236
1237
1238
1239     <li class="md-nav__item">
1240       <a href="../user-menu/" class="md-nav__link">
1241         userMenu
1242       </a>
1243     </li>
1244
1245
1246
1247
1248
1249
1250
1251     <li class="md-nav__item">
1252       <a href="../user-notification-event/" class="md-nav__link">
1253         userNotificationEvent
1254       </a>
1255     </li>
1256
1257
1258
1259
1260
1261
1262
1263     <li class="md-nav__item">
1264       <a href="../user-option/" class="md-nav__link">
1265         userOption
1266       </a>
1267     </li>
1268
1269
1270
1271
1272
1273
1274
1275     <li class="md-nav__item">
1276       <a href="../user-profile-menu/" class="md-nav__link">
1277         userProfileMenu
1278       </a>
1279     </li>
1280
1281
1282
1283         </ul>
1284       </nav>
1285     </li>
1286
1287
1288
1289
1290
1291
1292
1293     <li class="md-nav__item">
1294       <a href="../../database-php-api/" class="md-nav__link">
1295         Database PHP API
1296       </a>
1297     </li>
1298
1299
1300
1301         </ul>
1302       </nav>
1303     </li>
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315     <li class="md-nav__item md-nav__item--nested">
1316
1317
1318         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1319
1320       <label class="md-nav__link" for="__nav_6">
1321         Migration
1322         <span class="md-nav__icon md-icon"></span>
1323       </label>
1324       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1325         <label class="md-nav__title" for="__nav_6">
1326           <span class="md-nav__icon md-icon"></span>
1327           Migration
1328         </label>
1329         <ul class="md-nav__list" data-md-scrollfix>
1330
1331
1332
1333
1334
1335
1336     <li class="md-nav__item md-nav__item--nested">
1337
1338
1339         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1340
1341       <label class="md-nav__link" for="__nav_6_1">
1342         Migrating from WSC 5.3
1343         <span class="md-nav__icon md-icon"></span>
1344       </label>
1345       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1346         <label class="md-nav__title" for="__nav_6_1">
1347           <span class="md-nav__icon md-icon"></span>
1348           Migrating from WSC 5.3
1349         </label>
1350         <ul class="md-nav__list" data-md-scrollfix>
1351
1352
1353
1354
1355
1356     <li class="md-nav__item">
1357       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1358         PHP API
1359       </a>
1360     </li>
1361
1362
1363
1364
1365
1366
1367
1368     <li class="md-nav__item">
1369       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1370         Session Handling and Authentication
1371       </a>
1372     </li>
1373
1374
1375
1376
1377
1378
1379
1380     <li class="md-nav__item">
1381       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1382         JavaScript
1383       </a>
1384     </li>
1385
1386
1387
1388
1389
1390
1391
1392     <li class="md-nav__item">
1393       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1394         Templates
1395       </a>
1396     </li>
1397
1398
1399
1400
1401
1402
1403
1404     <li class="md-nav__item">
1405       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1406         Third Party Libraries
1407       </a>
1408     </li>
1409
1410
1411
1412         </ul>
1413       </nav>
1414     </li>
1415
1416
1417
1418
1419
1420
1421
1422
1423     <li class="md-nav__item md-nav__item--nested">
1424
1425
1426         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1427
1428       <label class="md-nav__link" for="__nav_6_2">
1429         Migrating from WSC 5.2
1430         <span class="md-nav__icon md-icon"></span>
1431       </label>
1432       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1433         <label class="md-nav__title" for="__nav_6_2">
1434           <span class="md-nav__icon md-icon"></span>
1435           Migrating from WSC 5.2
1436         </label>
1437         <ul class="md-nav__list" data-md-scrollfix>
1438
1439
1440
1441
1442
1443     <li class="md-nav__item">
1444       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1445         PHP API
1446       </a>
1447     </li>
1448
1449
1450
1451
1452
1453
1454
1455     <li class="md-nav__item">
1456       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1457         Templates and Languages
1458       </a>
1459     </li>
1460
1461
1462
1463
1464
1465
1466
1467     <li class="md-nav__item">
1468       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1469         Third Party Libraries
1470       </a>
1471     </li>
1472
1473
1474
1475         </ul>
1476       </nav>
1477     </li>
1478
1479
1480
1481
1482
1483
1484
1485
1486     <li class="md-nav__item md-nav__item--nested">
1487
1488
1489         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1490
1491       <label class="md-nav__link" for="__nav_6_3">
1492         Migrating from WSC 3.1
1493         <span class="md-nav__icon md-icon"></span>
1494       </label>
1495       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1496         <label class="md-nav__title" for="__nav_6_3">
1497           <span class="md-nav__icon md-icon"></span>
1498           Migrating from WSC 3.1
1499         </label>
1500         <ul class="md-nav__list" data-md-scrollfix>
1501
1502
1503
1504
1505
1506     <li class="md-nav__item">
1507       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1508         PHP API
1509       </a>
1510     </li>
1511
1512
1513
1514         </ul>
1515       </nav>
1516     </li>
1517
1518
1519
1520
1521
1522
1523
1524
1525     <li class="md-nav__item md-nav__item--nested">
1526
1527
1528         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1529
1530       <label class="md-nav__link" for="__nav_6_4">
1531         Migrating from WSC 3.0
1532         <span class="md-nav__icon md-icon"></span>
1533       </label>
1534       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1535         <label class="md-nav__title" for="__nav_6_4">
1536           <span class="md-nav__icon md-icon"></span>
1537           Migrating from WSC 3.0
1538         </label>
1539         <ul class="md-nav__list" data-md-scrollfix>
1540
1541
1542
1543
1544
1545     <li class="md-nav__item">
1546       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1547         PHP API
1548       </a>
1549     </li>
1550
1551
1552
1553
1554
1555
1556
1557     <li class="md-nav__item">
1558       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1559         JavaScript API
1560       </a>
1561     </li>
1562
1563
1564
1565
1566
1567
1568
1569     <li class="md-nav__item">
1570       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1571         Templates
1572       </a>
1573     </li>
1574
1575
1576
1577
1578
1579
1580
1581     <li class="md-nav__item">
1582       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1583         CSS
1584       </a>
1585     </li>
1586
1587
1588
1589
1590
1591
1592
1593     <li class="md-nav__item">
1594       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1595         Package Components
1596       </a>
1597     </li>
1598
1599
1600
1601         </ul>
1602       </nav>
1603     </li>
1604
1605
1606
1607
1608
1609
1610
1611
1612     <li class="md-nav__item md-nav__item--nested">
1613
1614
1615         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1616
1617       <label class="md-nav__link" for="__nav_6_5">
1618         Migrating from WCF 2.1
1619         <span class="md-nav__icon md-icon"></span>
1620       </label>
1621       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1622         <label class="md-nav__title" for="__nav_6_5">
1623           <span class="md-nav__icon md-icon"></span>
1624           Migrating from WCF 2.1
1625         </label>
1626         <ul class="md-nav__list" data-md-scrollfix>
1627
1628
1629
1630
1631
1632     <li class="md-nav__item">
1633       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1634         PHP API
1635       </a>
1636     </li>
1637
1638
1639
1640
1641
1642
1643
1644     <li class="md-nav__item">
1645       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1646         Templates
1647       </a>
1648     </li>
1649
1650
1651
1652
1653
1654
1655
1656     <li class="md-nav__item">
1657       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1658         CSS
1659       </a>
1660     </li>
1661
1662
1663
1664
1665
1666
1667
1668     <li class="md-nav__item">
1669       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1670         Package Components
1671       </a>
1672     </li>
1673
1674
1675
1676         </ul>
1677       </nav>
1678     </li>
1679
1680
1681
1682         </ul>
1683       </nav>
1684     </li>
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696     <li class="md-nav__item md-nav__item--nested">
1697
1698
1699         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1700
1701       <label class="md-nav__link" for="__nav_7">
1702         Tutorials
1703         <span class="md-nav__icon md-icon"></span>
1704       </label>
1705       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1706         <label class="md-nav__title" for="__nav_7">
1707           <span class="md-nav__icon md-icon"></span>
1708           Tutorials
1709         </label>
1710         <ul class="md-nav__list" data-md-scrollfix>
1711
1712
1713
1714
1715
1716
1717     <li class="md-nav__item md-nav__item--nested">
1718
1719
1720         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1721
1722       <label class="md-nav__link" for="__nav_7_1">
1723         Tutorial Series
1724         <span class="md-nav__icon md-icon"></span>
1725       </label>
1726       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1727         <label class="md-nav__title" for="__nav_7_1">
1728           <span class="md-nav__icon md-icon"></span>
1729           Tutorial Series
1730         </label>
1731         <ul class="md-nav__list" data-md-scrollfix>
1732
1733
1734
1735
1736
1737     <li class="md-nav__item">
1738       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1739         Overview
1740       </a>
1741     </li>
1742
1743
1744
1745
1746
1747
1748
1749     <li class="md-nav__item">
1750       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1751         Part 1
1752       </a>
1753     </li>
1754
1755
1756
1757
1758
1759
1760
1761     <li class="md-nav__item">
1762       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1763         Part 2
1764       </a>
1765     </li>
1766
1767
1768
1769
1770
1771
1772
1773     <li class="md-nav__item">
1774       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1775         Part 3
1776       </a>
1777     </li>
1778
1779
1780
1781         </ul>
1782       </nav>
1783     </li>
1784
1785
1786
1787         </ul>
1788       </nav>
1789     </li>
1790
1791
1792
1793   </ul>
1794 </nav>
1795                   </div>
1796                 </div>
1797               </div>
1798
1799
1800
1801               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1802                 <div class="md-sidebar__scrollwrap">
1803                   <div class="md-sidebar__inner">
1804
1805 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1806
1807
1808
1809
1810
1811     <label class="md-nav__title" for="__toc">
1812       <span class="md-nav__icon md-icon"></span>
1813       Table of contents
1814     </label>
1815     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1816
1817         <li class="md-nav__item">
1818   <a href="#archive" class="md-nav__link">
1819     Archive
1820   </a>
1821
1822 </li>
1823
1824         <li class="md-nav__item">
1825   <a href="#example-in-packagexml" class="md-nav__link">
1826     Example in package.xml
1827   </a>
1828
1829 </li>
1830
1831     </ul>
1832
1833 </nav>
1834                   </div>
1835                 </div>
1836               </div>
1837
1838
1839           <div class="md-content" data-md-component="content">
1840             <article class="md-content__inner md-typeset">
1841
1842
1843
1844                 <h1 id="file-package-installation-plugin">File Package Installation Plugin<a class="headerlink" href="#file-package-installation-plugin" title="Permanent link">#</a></h1>
1845 <p>Adds any type of files with the exception of templates.</p>
1846 <div class="admonition warning">
1847 <p class="admonition-title">You cannot overwrite files provided by other packages.</p>
1848 </div>
1849 <p>The <code>application</code> attribute behaves like it does for <a href="../acp-template/#application">acp templates</a>.</p>
1850 <h2 id="archive">Archive<a class="headerlink" href="#archive" title="Permanent link">#</a></h2>
1851 <p>The <code>acpTemplate</code> package installation plugins expects a <code>.tar</code> (recommended) or <code>.tar.gz</code> archive.
1852 The file path given in the <code>instruction</code> element as its value must be relative to the <code>package.xml</code> file.</p>
1853 <h2 id="example-in-packagexml">Example in <code>package.xml</code><a class="headerlink" href="#example-in-packagexml" title="Permanent link">#</a></h2>
1854 <div class="highlight"><pre><span></span><code><span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;file&quot;</span> <span class="nt">/&gt;</span>
1855 <span class="c">&lt;!-- is the same as --&gt;</span>
1856 <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;file&quot;</span><span class="nt">&gt;</span>files.tar<span class="nt">&lt;/instruction&gt;</span>
1857
1858 <span class="c">&lt;!-- if an application &quot;com.woltlab.example&quot; is being installed, the following lines are equivalent --&gt;</span>
1859 <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;file&quot;</span> <span class="nt">/&gt;</span>
1860 <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;file&quot;</span> <span class="na">application=</span><span class="s">&quot;example&quot;</span> <span class="nt">/&gt;</span>
1861
1862 <span class="c">&lt;!-- if the same application wants to install additional files, in WoltLab Suite Core&#39;s directory: --&gt;</span>
1863 <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;file&quot;</span> <span class="na">application=</span><span class="s">&quot;wcf&quot;</span><span class="nt">&gt;</span>files_wcf.tar<span class="nt">&lt;/instruction&gt;</span>
1864 </code></pre></div>
1865
1866
1867
1868
1869
1870
1871
1872             </article>
1873           </div>
1874         </div>
1875       </main>
1876
1877
1878 <footer class="md-footer">
1879
1880     <nav class="md-footer__inner md-grid" aria-label="Footer">
1881
1882         <a href="../event-listener/" class="md-footer__link md-footer__link--prev" rel="prev">
1883           <div class="md-footer__button md-icon">
1884             <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>
1885           </div>
1886           <div class="md-footer__title">
1887             <div class="md-ellipsis">
1888               <span class="md-footer__direction">
1889                 Previous
1890               </span>
1891               eventListener
1892             </div>
1893           </div>
1894         </a>
1895
1896
1897         <a href="../language/" class="md-footer__link md-footer__link--next" rel="next">
1898           <div class="md-footer__title">
1899             <div class="md-ellipsis">
1900               <span class="md-footer__direction">
1901                 Next
1902               </span>
1903               language
1904             </div>
1905           </div>
1906           <div class="md-footer__button md-icon">
1907             <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>
1908           </div>
1909         </a>
1910
1911     </nav>
1912
1913   <div class="md-footer-meta md-typeset">
1914     <div class="md-footer-meta__inner md-grid">
1915       <div class="md-footer-copyright">
1916
1917           <div class="md-footer-copyright__highlight">
1918             Copyright © 2020 WoltLab GmbH
1919           </div>
1920
1921         Made with
1922         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1923           Material for MkDocs
1924         </a>
1925
1926       </div>
1927       <div class="md-footer-copyright">
1928         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
1929         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
1930 </div>
1931     </div>
1932   </div>
1933 </footer>
1934
1935     </div>
1936     <div class="md-dialog" data-md-component="dialog">
1937       <div class="md-dialog__inner md-typeset"></div>
1938     </div>
1939     <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.fb4a9340.min.js", "version": {"provider": "mike"}}</script>
1940
1941
1942       <script src="../../../assets/javascripts/bundle.5cf3e710.min.js"></script>
1943
1944
1945   </body>
1946 </html>