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