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