Deployed 2f13e501 to 6.0 with MkDocs 1.4.3 and mike 1.1.2
[GitHub/WoltLab/woltlab.github.io.git] / 6.0 / migration / wsc30 / package / 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 <link rel="canonical" href="https://docs.woltlab.com/6.0/migration/wsc30/package/">
12
13
14 <link rel="prev" href="../css/">
15
16
17 <link rel="next" href="../../wcf21/php/">
18
19 <link rel="icon" href="../../../assets/default.favicon.ico">
20 <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.15">
21
22
23
24 <title>Package Components - WoltLab Suite Documentation</title>
25
26
27
28 <link rel="stylesheet" href="../../../assets/stylesheets/main.26e3688c.min.css">
29
30
31 <link rel="stylesheet" href="../../../assets/stylesheets/palette.ecc896b0.min.css">
32
33
34
35
36
37
38
39
40
41 <link rel="stylesheet" href="../../../stylesheets/extra.css">
42
43 <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
44
45
46
47
48
49
50 </head>
51
52
53
54
55
56
57
58 <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
59
60
61
62 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
63 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
64 <label class="md-overlay" for="__drawer"></label>
65 <div data-md-component="skip">
66
67
68 <a href="#migrating-from-wsc-30-package-components" class="md-skip">
69 Skip to content
70 </a>
71
72 </div>
73 <div data-md-component="announce">
74
75 <aside class="md-banner">
76 <div class="md-banner__inner md-grid md-typeset">
77
78
79 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
80
81 </div>
82
83 </aside>
84
85 </div>
86
87 <div data-md-color-scheme="default" data-md-component="outdated" hidden>
88
89 </div>
90
91
92
93
94
95
96 <header class="md-header md-header--shadow" data-md-component="header">
97 <nav class="md-header__inner md-grid" aria-label="Header">
98 <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
99
100 <img src="../../../assets/logo.png" alt="logo">
101
102 </a>
103 <label class="md-header__button md-icon" for="__drawer">
104 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
105 </label>
106 <div class="md-header__title" data-md-component="header-title">
107 <div class="md-header__ellipsis">
108 <div class="md-header__topic">
109 <span class="md-ellipsis">
110 WoltLab Suite Documentation
111 </span>
112 </div>
113 <div class="md-header__topic" data-md-component="header-topic">
114 <span class="md-ellipsis">
115
116 Package Components
117
118 </span>
119 </div>
120 </div>
121 </div>
122
123
124
125
126
127 <label class="md-header__button md-icon" for="__search">
128 <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>
129 </label>
130 <div class="md-search" data-md-component="search" role="dialog">
131 <label class="md-search__overlay" for="__search"></label>
132 <div class="md-search__inner" role="search">
133 <form class="md-search__form" name="search">
134 <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" required>
135 <label class="md-search__icon md-icon" for="__search">
136 <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>
137 <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>
138 </label>
139 <nav class="md-search__options" aria-label="Search">
140
141 <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
142 <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>
143 </button>
144 </nav>
145
146 </form>
147 <div class="md-search__output">
148 <div class="md-search__scrollwrap" data-md-scrollfix>
149 <div class="md-search-result" data-md-component="search-result">
150 <div class="md-search-result__meta">
151 Initializing search
152 </div>
153 <ol class="md-search-result__list" role="presentation"></ol>
154 </div>
155 </div>
156 </div>
157 </div>
158 </div>
159
160
161 <div class="md-header__source">
162 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
163 <div class="md-source__icon md-icon">
164
165 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
166 </div>
167 <div class="md-source__repository">
168 GitHub
169 </div>
170 </a>
171 </div>
172
173 </nav>
174
175 </header>
176
177 <div class="md-container" data-md-component="container">
178
179
180
181
182
183
184 <main class="md-main" data-md-component="main">
185 <div class="md-main__inner md-grid">
186
187
188
189 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
190 <div class="md-sidebar__scrollwrap">
191 <div class="md-sidebar__inner">
192
193
194
195 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
196 <label class="md-nav__title" for="__drawer">
197 <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
198
199 <img src="../../../assets/logo.png" alt="logo">
200
201 </a>
202 WoltLab Suite Documentation
203 </label>
204
205 <div class="md-nav__source">
206 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
207 <div class="md-source__icon md-icon">
208
209 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
210 </div>
211 <div class="md-source__repository">
212 GitHub
213 </div>
214 </a>
215 </div>
216
217 <ul class="md-nav__list" data-md-scrollfix>
218
219
220
221
222
223
224
225
226 <li class="md-nav__item">
227 <a href="../../../getting-started/" class="md-nav__link">
228 Getting Started
229 </a>
230 </li>
231
232
233
234
235
236
237
238
239
240
241
242 <li class="md-nav__item md-nav__item--nested">
243
244
245
246
247 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
248
249
250
251 <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
252 PHP API
253 <span class="md-nav__icon md-icon"></span>
254 </label>
255
256 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
257 <label class="md-nav__title" for="__nav_2">
258 <span class="md-nav__icon md-icon"></span>
259 PHP API
260 </label>
261 <ul class="md-nav__list" data-md-scrollfix>
262
263
264
265
266
267
268 <li class="md-nav__item">
269 <a href="../../../php/pages/" class="md-nav__link">
270 Pages
271 </a>
272 </li>
273
274
275
276
277
278
279
280
281
282 <li class="md-nav__item">
283 <a href="../../../php/database-objects/" class="md-nav__link">
284 Database Objects
285 </a>
286 </li>
287
288
289
290
291
292
293
294
295
296 <li class="md-nav__item">
297 <a href="../../../php/database-access/" class="md-nav__link">
298 Database Access
299 </a>
300 </li>
301
302
303
304
305
306
307
308
309
310 <li class="md-nav__item">
311 <a href="../../../php/exceptions/" class="md-nav__link">
312 Exceptions
313 </a>
314 </li>
315
316
317
318
319
320
321
322
323
324
325 <li class="md-nav__item md-nav__item--nested">
326
327
328
329
330 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
331
332
333
334 <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
335 API
336 <span class="md-nav__icon md-icon"></span>
337 </label>
338
339 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
340 <label class="md-nav__title" for="__nav_2_5">
341 <span class="md-nav__icon md-icon"></span>
342 API
343 </label>
344 <ul class="md-nav__list" data-md-scrollfix>
345
346
347
348
349
350
351
352 <li class="md-nav__item md-nav__item--nested">
353
354
355
356
357 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
358
359
360
361 <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
362 Caches
363 <span class="md-nav__icon md-icon"></span>
364 </label>
365
366 <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
367 <label class="md-nav__title" for="__nav_2_5_1">
368 <span class="md-nav__icon md-icon"></span>
369 Caches
370 </label>
371 <ul class="md-nav__list" data-md-scrollfix>
372
373
374
375
376
377
378 <li class="md-nav__item">
379 <a href="../../../php/api/caches/" class="md-nav__link">
380 Overview
381 </a>
382 </li>
383
384
385
386
387
388
389
390
391
392 <li class="md-nav__item">
393 <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
394 Persistent Caches
395 </a>
396 </li>
397
398
399
400
401
402
403
404
405
406 <li class="md-nav__item">
407 <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
408 Runtime Caches
409 </a>
410 </li>
411
412
413
414
415 </ul>
416 </nav>
417 </li>
418
419
420
421
422
423
424
425
426
427 <li class="md-nav__item">
428 <a href="../../../php/api/comments/" class="md-nav__link">
429 Comments
430 </a>
431 </li>
432
433
434
435
436
437
438
439
440
441 <li class="md-nav__item">
442 <a href="../../../php/api/cronjobs/" class="md-nav__link">
443 Cronjobs
444 </a>
445 </li>
446
447
448
449
450
451
452
453
454
455 <li class="md-nav__item">
456 <a href="../../../php/api/events/" class="md-nav__link">
457 Events
458 </a>
459 </li>
460
461
462
463
464
465
466
467
468
469
470 <li class="md-nav__item md-nav__item--nested">
471
472
473
474
475 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
476
477
478
479 <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
480 Form Builder
481 <span class="md-nav__icon md-icon"></span>
482 </label>
483
484 <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
485 <label class="md-nav__title" for="__nav_2_5_5">
486 <span class="md-nav__icon md-icon"></span>
487 Form Builder
488 </label>
489 <ul class="md-nav__list" data-md-scrollfix>
490
491
492
493
494
495
496 <li class="md-nav__item">
497 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
498 Overview
499 </a>
500 </li>
501
502
503
504
505
506
507
508
509
510 <li class="md-nav__item">
511 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
512 Structure
513 </a>
514 </li>
515
516
517
518
519
520
521
522
523
524 <li class="md-nav__item">
525 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
526 Fields
527 </a>
528 </li>
529
530
531
532
533
534
535
536
537
538 <li class="md-nav__item">
539 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
540 Validation and Data
541 </a>
542 </li>
543
544
545
546
547
548
549
550
551
552 <li class="md-nav__item">
553 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
554 Dependencies
555 </a>
556 </li>
557
558
559
560
561 </ul>
562 </nav>
563 </li>
564
565
566
567
568
569
570
571
572
573 <li class="md-nav__item">
574 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
575 Package Installation Plugins
576 </a>
577 </li>
578
579
580
581
582
583
584
585
586
587 <li class="md-nav__item">
588 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
589 User Activity Points
590 </a>
591 </li>
592
593
594
595
596
597
598
599
600
601 <li class="md-nav__item">
602 <a href="../../../php/api/user_notifications/" class="md-nav__link">
603 User Notifications
604 </a>
605 </li>
606
607
608
609
610
611
612
613
614
615 <li class="md-nav__item">
616 <a href="../../../php/api/sitemaps/" class="md-nav__link">
617 Sitemaps
618 </a>
619 </li>
620
621
622
623
624 </ul>
625 </nav>
626 </li>
627
628
629
630
631
632
633
634
635
636 <li class="md-nav__item">
637 <a href="../../../php/code-style/" class="md-nav__link">
638 Code Style
639 </a>
640 </li>
641
642
643
644
645
646
647
648
649
650 <li class="md-nav__item">
651 <a href="../../../php/apps/" class="md-nav__link">
652 Apps
653 </a>
654 </li>
655
656
657
658
659
660
661
662
663
664 <li class="md-nav__item">
665 <a href="../../../php/gdpr/" class="md-nav__link">
666 GDPR
667 </a>
668 </li>
669
670
671
672
673 </ul>
674 </nav>
675 </li>
676
677
678
679
680
681
682
683
684
685
686
687 <li class="md-nav__item md-nav__item--nested">
688
689
690
691
692 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
693
694
695
696 <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
697 Languages, Templates & CSS
698 <span class="md-nav__icon md-icon"></span>
699 </label>
700
701 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
702 <label class="md-nav__title" for="__nav_3">
703 <span class="md-nav__icon md-icon"></span>
704 Languages, Templates & CSS
705 </label>
706 <ul class="md-nav__list" data-md-scrollfix>
707
708
709
710
711
712
713 <li class="md-nav__item">
714 <a href="../../../view/languages/" class="md-nav__link">
715 Languages
716 </a>
717 </li>
718
719
720
721
722
723
724
725
726
727 <li class="md-nav__item">
728 <a href="../../../view/templates/" class="md-nav__link">
729 Templates
730 </a>
731 </li>
732
733
734
735
736
737
738
739
740
741 <li class="md-nav__item">
742 <a href="../../../view/template-modifiers/" class="md-nav__link">
743 Template Modifiers
744 </a>
745 </li>
746
747
748
749
750
751
752
753
754
755 <li class="md-nav__item">
756 <a href="../../../view/template-plugins/" class="md-nav__link">
757 Template Plugins
758 </a>
759 </li>
760
761
762
763
764
765
766
767
768
769 <li class="md-nav__item">
770 <a href="../../../view/css/" class="md-nav__link">
771 CSS
772 </a>
773 </li>
774
775
776
777
778 </ul>
779 </nav>
780 </li>
781
782
783
784
785
786
787
788
789
790
791
792 <li class="md-nav__item md-nav__item--nested">
793
794
795
796
797 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
798
799
800
801 <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
802 TypeScript and JavaScript API
803 <span class="md-nav__icon md-icon"></span>
804 </label>
805
806 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
807 <label class="md-nav__title" for="__nav_4">
808 <span class="md-nav__icon md-icon"></span>
809 TypeScript and JavaScript API
810 </label>
811 <ul class="md-nav__list" data-md-scrollfix>
812
813
814
815
816
817
818 <li class="md-nav__item">
819 <a href="../../../javascript/general-usage/" class="md-nav__link">
820 General Usage
821 </a>
822 </li>
823
824
825
826
827
828
829
830
831
832 <li class="md-nav__item">
833 <a href="../../../javascript/typescript/" class="md-nav__link">
834 TypeScript
835 </a>
836 </li>
837
838
839
840
841
842
843
844
845
846
847 <li class="md-nav__item md-nav__item--nested">
848
849
850
851
852 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
853
854
855
856 <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
857 Components
858 <span class="md-nav__icon md-icon"></span>
859 </label>
860
861 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
862 <label class="md-nav__title" for="__nav_4_3">
863 <span class="md-nav__icon md-icon"></span>
864 Components
865 </label>
866 <ul class="md-nav__list" data-md-scrollfix>
867
868
869
870
871
872
873 <li class="md-nav__item">
874 <a href="../../../javascript/components_confirmation/" class="md-nav__link">
875 Confirmation
876 </a>
877 </li>
878
879
880
881
882
883
884
885
886
887 <li class="md-nav__item">
888 <a href="../../../javascript/components_dialog/" class="md-nav__link">
889 Dialog
890 </a>
891 </li>
892
893
894
895
896
897
898
899
900
901 <li class="md-nav__item">
902 <a href="../../../javascript/components_google_maps/" class="md-nav__link">
903 Google Maps
904 </a>
905 </li>
906
907
908
909
910
911
912
913
914
915 <li class="md-nav__item">
916 <a href="../../../javascript/components_pagination/" class="md-nav__link">
917 Pagination
918 </a>
919 </li>
920
921
922
923
924 </ul>
925 </nav>
926 </li>
927
928
929
930
931
932
933
934
935
936
937 <li class="md-nav__item md-nav__item--nested">
938
939
940
941
942 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
943
944
945
946 <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
947 New API
948 <span class="md-nav__icon md-icon"></span>
949 </label>
950
951 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
952 <label class="md-nav__title" for="__nav_4_4">
953 <span class="md-nav__icon md-icon"></span>
954 New API
955 </label>
956 <ul class="md-nav__list" data-md-scrollfix>
957
958
959
960
961
962
963 <li class="md-nav__item">
964 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
965 Writing a module
966 </a>
967 </li>
968
969
970
971
972
973
974
975
976
977 <li class="md-nav__item">
978 <a href="../../../javascript/new-api_core/" class="md-nav__link">
979 Core Functions
980 </a>
981 </li>
982
983
984
985
986
987
988
989
990
991 <li class="md-nav__item">
992 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
993 DOM
994 </a>
995 </li>
996
997
998
999
1000
1001
1002
1003
1004
1005 <li class="md-nav__item">
1006 <a href="../../../javascript/new-api_events/" class="md-nav__link">
1007 Event Handling
1008 </a>
1009 </li>
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019 <li class="md-nav__item">
1020 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1021 Ajax
1022 </a>
1023 </li>
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033 <li class="md-nav__item">
1034 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1035 Dialogs
1036 </a>
1037 </li>
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047 <li class="md-nav__item">
1048 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1049 Browser and Screen Sizes
1050 </a>
1051 </li>
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061 <li class="md-nav__item">
1062 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1063 User Interface
1064 </a>
1065 </li>
1066
1067
1068
1069
1070 </ul>
1071 </nav>
1072 </li>
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082 <li class="md-nav__item">
1083 <a href="../../../javascript/legacy-api/" class="md-nav__link">
1084 Legacy API
1085 </a>
1086 </li>
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096 <li class="md-nav__item">
1097 <a href="../../../javascript/code-snippets/" class="md-nav__link">
1098 Code Snippets
1099 </a>
1100 </li>
1101
1102
1103
1104
1105 </ul>
1106 </nav>
1107 </li>
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119 <li class="md-nav__item md-nav__item--nested">
1120
1121
1122
1123
1124 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1125
1126
1127
1128 <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1129 Package Components
1130 <span class="md-nav__icon md-icon"></span>
1131 </label>
1132
1133 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1134 <label class="md-nav__title" for="__nav_5">
1135 <span class="md-nav__icon md-icon"></span>
1136 Package Components
1137 </label>
1138 <ul class="md-nav__list" data-md-scrollfix>
1139
1140
1141
1142
1143
1144
1145 <li class="md-nav__item">
1146 <a href="../../../package/package-xml/" class="md-nav__link">
1147 package.xml
1148 </a>
1149 </li>
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160 <li class="md-nav__item md-nav__item--nested">
1161
1162
1163
1164
1165 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1166
1167
1168
1169 <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1170 PIPs
1171 <span class="md-nav__icon md-icon"></span>
1172 </label>
1173
1174 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1175 <label class="md-nav__title" for="__nav_5_2">
1176 <span class="md-nav__icon md-icon"></span>
1177 PIPs
1178 </label>
1179 <ul class="md-nav__list" data-md-scrollfix>
1180
1181
1182
1183
1184
1185
1186 <li class="md-nav__item">
1187 <a href="../../../package/pip/" class="md-nav__link">
1188 Overview
1189 </a>
1190 </li>
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200 <li class="md-nav__item">
1201 <a href="../../../package/pip/acl-option/" class="md-nav__link">
1202 aclOption
1203 </a>
1204 </li>
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214 <li class="md-nav__item">
1215 <a href="../../../package/pip/acp-menu/" class="md-nav__link">
1216 acpMenu
1217 </a>
1218 </li>
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228 <li class="md-nav__item">
1229 <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
1230 acpSearchProvider
1231 </a>
1232 </li>
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242 <li class="md-nav__item">
1243 <a href="../../../package/pip/acp-template/" class="md-nav__link">
1244 acpTemplate
1245 </a>
1246 </li>
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256 <li class="md-nav__item">
1257 <a href="../../../package/pip/acp-template-delete/" class="md-nav__link">
1258 acpTemplateDelete
1259 </a>
1260 </li>
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270 <li class="md-nav__item">
1271 <a href="../../../package/pip/bbcode/" class="md-nav__link">
1272 bbcode
1273 </a>
1274 </li>
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284 <li class="md-nav__item">
1285 <a href="../../../package/pip/box/" class="md-nav__link">
1286 box
1287 </a>
1288 </li>
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298 <li class="md-nav__item">
1299 <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1300 clipboardAction
1301 </a>
1302 </li>
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312 <li class="md-nav__item">
1313 <a href="../../../package/pip/core-object/" class="md-nav__link">
1314 coreObject
1315 </a>
1316 </li>
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326 <li class="md-nav__item">
1327 <a href="../../../package/pip/cronjob/" class="md-nav__link">
1328 cronjob
1329 </a>
1330 </li>
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340 <li class="md-nav__item">
1341 <a href="../../../package/pip/database/" class="md-nav__link">
1342 database
1343 </a>
1344 </li>
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354 <li class="md-nav__item">
1355 <a href="../../../package/pip/event-listener/" class="md-nav__link">
1356 eventListener
1357 </a>
1358 </li>
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368 <li class="md-nav__item">
1369 <a href="../../../package/pip/file/" class="md-nav__link">
1370 file
1371 </a>
1372 </li>
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382 <li class="md-nav__item">
1383 <a href="../../../package/pip/file-delete/" class="md-nav__link">
1384 fileDelete
1385 </a>
1386 </li>
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396 <li class="md-nav__item">
1397 <a href="../../../package/pip/language/" class="md-nav__link">
1398 language
1399 </a>
1400 </li>
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410 <li class="md-nav__item">
1411 <a href="../../../package/pip/media-provider/" class="md-nav__link">
1412 mediaProvider
1413 </a>
1414 </li>
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424 <li class="md-nav__item">
1425 <a href="../../../package/pip/menu/" class="md-nav__link">
1426 menu
1427 </a>
1428 </li>
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438 <li class="md-nav__item">
1439 <a href="../../../package/pip/menu-item/" class="md-nav__link">
1440 menuItem
1441 </a>
1442 </li>
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452 <li class="md-nav__item">
1453 <a href="../../../package/pip/object-type/" class="md-nav__link">
1454 objectType
1455 </a>
1456 </li>
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466 <li class="md-nav__item">
1467 <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1468 objectTypeDefinition
1469 </a>
1470 </li>
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480 <li class="md-nav__item">
1481 <a href="../../../package/pip/option/" class="md-nav__link">
1482 option
1483 </a>
1484 </li>
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494 <li class="md-nav__item">
1495 <a href="../../../package/pip/page/" class="md-nav__link">
1496 page
1497 </a>
1498 </li>
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508 <li class="md-nav__item">
1509 <a href="../../../package/pip/pip/" class="md-nav__link">
1510 pip
1511 </a>
1512 </li>
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522 <li class="md-nav__item">
1523 <a href="../../../package/pip/script/" class="md-nav__link">
1524 script
1525 </a>
1526 </li>
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536 <li class="md-nav__item">
1537 <a href="../../../package/pip/smiley/" class="md-nav__link">
1538 smiley
1539 </a>
1540 </li>
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550 <li class="md-nav__item">
1551 <a href="../../../package/pip/sql/" class="md-nav__link">
1552 sql
1553 </a>
1554 </li>
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564 <li class="md-nav__item">
1565 <a href="../../../package/pip/style/" class="md-nav__link">
1566 style
1567 </a>
1568 </li>
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578 <li class="md-nav__item">
1579 <a href="../../../package/pip/template/" class="md-nav__link">
1580 template
1581 </a>
1582 </li>
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592 <li class="md-nav__item">
1593 <a href="../../../package/pip/template-delete/" class="md-nav__link">
1594 templateDelete
1595 </a>
1596 </li>
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606 <li class="md-nav__item">
1607 <a href="../../../package/pip/template-listener/" class="md-nav__link">
1608 templateListener
1609 </a>
1610 </li>
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620 <li class="md-nav__item">
1621 <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1622 userGroupOption
1623 </a>
1624 </li>
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634 <li class="md-nav__item">
1635 <a href="../../../package/pip/user-menu/" class="md-nav__link">
1636 userMenu
1637 </a>
1638 </li>
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648 <li class="md-nav__item">
1649 <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1650 userNotificationEvent
1651 </a>
1652 </li>
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662 <li class="md-nav__item">
1663 <a href="../../../package/pip/user-option/" class="md-nav__link">
1664 userOption
1665 </a>
1666 </li>
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676 <li class="md-nav__item">
1677 <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1678 userProfileMenu
1679 </a>
1680 </li>
1681
1682
1683
1684
1685 </ul>
1686 </nav>
1687 </li>
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697 <li class="md-nav__item">
1698 <a href="../../../package/database-php-api/" class="md-nav__link">
1699 Database PHP API
1700 </a>
1701 </li>
1702
1703
1704
1705
1706 </ul>
1707 </nav>
1708 </li>
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1723
1724
1725
1726
1727 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
1728
1729
1730
1731 <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1732 Migration
1733 <span class="md-nav__icon md-icon"></span>
1734 </label>
1735
1736 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
1737 <label class="md-nav__title" for="__nav_6">
1738 <span class="md-nav__icon md-icon"></span>
1739 Migration
1740 </label>
1741 <ul class="md-nav__list" data-md-scrollfix>
1742
1743
1744
1745
1746
1747
1748
1749 <li class="md-nav__item md-nav__item--nested">
1750
1751
1752
1753
1754 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1755
1756
1757
1758 <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1759 From WoltLab Suite 5.5
1760 <span class="md-nav__icon md-icon"></span>
1761 </label>
1762
1763 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1764 <label class="md-nav__title" for="__nav_6_1">
1765 <span class="md-nav__icon md-icon"></span>
1766 From WoltLab Suite 5.5
1767 </label>
1768 <ul class="md-nav__list" data-md-scrollfix>
1769
1770
1771
1772
1773
1774
1775 <li class="md-nav__item">
1776 <a href="../../wsc55/php/" class="md-nav__link">
1777 PHP API
1778 </a>
1779 </li>
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789 <li class="md-nav__item">
1790 <a href="../../wsc55/javascript/" class="md-nav__link">
1791 TypeScript and JavaScript
1792 </a>
1793 </li>
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803 <li class="md-nav__item">
1804 <a href="../../wsc55/templates/" class="md-nav__link">
1805 Templates
1806 </a>
1807 </li>
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817 <li class="md-nav__item">
1818 <a href="../../wsc55/icons/" class="md-nav__link">
1819 Icons
1820 </a>
1821 </li>
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831 <li class="md-nav__item">
1832 <a href="../../wsc55/dialogs/" class="md-nav__link">
1833 Dialogs
1834 </a>
1835 </li>
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845 <li class="md-nav__item">
1846 <a href="../../wsc55/libraries/" class="md-nav__link">
1847 Third Party Libraries
1848 </a>
1849 </li>
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859 <li class="md-nav__item">
1860 <a href="../../wsc55/deprecations_removals/" class="md-nav__link">
1861 Deprecations and Removals
1862 </a>
1863 </li>
1864
1865
1866
1867
1868 </ul>
1869 </nav>
1870 </li>
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881 <li class="md-nav__item md-nav__item--nested">
1882
1883
1884
1885
1886 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
1887
1888
1889
1890 <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
1891 From WoltLab Suite 5.4
1892 <span class="md-nav__icon md-icon"></span>
1893 </label>
1894
1895 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
1896 <label class="md-nav__title" for="__nav_6_2">
1897 <span class="md-nav__icon md-icon"></span>
1898 From WoltLab Suite 5.4
1899 </label>
1900 <ul class="md-nav__list" data-md-scrollfix>
1901
1902
1903
1904
1905
1906
1907 <li class="md-nav__item">
1908 <a href="../../wsc54/php/" class="md-nav__link">
1909 PHP API
1910 </a>
1911 </li>
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921 <li class="md-nav__item">
1922 <a href="../../wsc54/javascript/" class="md-nav__link">
1923 TypeScript and JavaScript
1924 </a>
1925 </li>
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935 <li class="md-nav__item">
1936 <a href="../../wsc54/templates/" class="md-nav__link">
1937 Templates
1938 </a>
1939 </li>
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949 <li class="md-nav__item">
1950 <a href="../../wsc54/libraries/" class="md-nav__link">
1951 Third Party Libraries
1952 </a>
1953 </li>
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963 <li class="md-nav__item">
1964 <a href="../../wsc54/deprecations_removals/" class="md-nav__link">
1965 Deprecations and Removals
1966 </a>
1967 </li>
1968
1969
1970
1971
1972 </ul>
1973 </nav>
1974 </li>
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985 <li class="md-nav__item md-nav__item--nested">
1986
1987
1988
1989
1990 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
1991
1992
1993
1994 <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
1995 From WoltLab Suite 5.3
1996 <span class="md-nav__icon md-icon"></span>
1997 </label>
1998
1999 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2000 <label class="md-nav__title" for="__nav_6_3">
2001 <span class="md-nav__icon md-icon"></span>
2002 From WoltLab Suite 5.3
2003 </label>
2004 <ul class="md-nav__list" data-md-scrollfix>
2005
2006
2007
2008
2009
2010
2011 <li class="md-nav__item">
2012 <a href="../../wsc53/php/" class="md-nav__link">
2013 PHP API
2014 </a>
2015 </li>
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025 <li class="md-nav__item">
2026 <a href="../../wsc53/session/" class="md-nav__link">
2027 Session Handling and Authentication
2028 </a>
2029 </li>
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039 <li class="md-nav__item">
2040 <a href="../../wsc53/javascript/" class="md-nav__link">
2041 TypeScript and JavaScript
2042 </a>
2043 </li>
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053 <li class="md-nav__item">
2054 <a href="../../wsc53/templates/" class="md-nav__link">
2055 Templates
2056 </a>
2057 </li>
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067 <li class="md-nav__item">
2068 <a href="../../wsc53/libraries/" class="md-nav__link">
2069 Third Party Libraries
2070 </a>
2071 </li>
2072
2073
2074
2075
2076 </ul>
2077 </nav>
2078 </li>
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089 <li class="md-nav__item md-nav__item--nested">
2090
2091
2092
2093
2094 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2095
2096
2097
2098 <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2099 From WoltLab Suite 5.2
2100 <span class="md-nav__icon md-icon"></span>
2101 </label>
2102
2103 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2104 <label class="md-nav__title" for="__nav_6_4">
2105 <span class="md-nav__icon md-icon"></span>
2106 From WoltLab Suite 5.2
2107 </label>
2108 <ul class="md-nav__list" data-md-scrollfix>
2109
2110
2111
2112
2113
2114
2115 <li class="md-nav__item">
2116 <a href="../../wsc52/php/" class="md-nav__link">
2117 PHP API
2118 </a>
2119 </li>
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129 <li class="md-nav__item">
2130 <a href="../../wsc52/templates/" class="md-nav__link">
2131 Templates and Languages
2132 </a>
2133 </li>
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143 <li class="md-nav__item">
2144 <a href="../../wsc52/libraries/" class="md-nav__link">
2145 Third Party Libraries
2146 </a>
2147 </li>
2148
2149
2150
2151
2152 </ul>
2153 </nav>
2154 </li>
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165 <li class="md-nav__item md-nav__item--nested">
2166
2167
2168
2169
2170 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2171
2172
2173
2174 <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2175 From WoltLab Suite 3.1
2176 <span class="md-nav__icon md-icon"></span>
2177 </label>
2178
2179 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2180 <label class="md-nav__title" for="__nav_6_5">
2181 <span class="md-nav__icon md-icon"></span>
2182 From WoltLab Suite 3.1
2183 </label>
2184 <ul class="md-nav__list" data-md-scrollfix>
2185
2186
2187
2188
2189
2190
2191 <li class="md-nav__item">
2192 <a href="../../wsc31/php/" class="md-nav__link">
2193 PHP API
2194 </a>
2195 </li>
2196
2197
2198
2199
2200 </ul>
2201 </nav>
2202 </li>
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
2216
2217
2218
2219
2220 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" checked>
2221
2222
2223
2224 <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2225 From WoltLab Suite 3.0
2226 <span class="md-nav__icon md-icon"></span>
2227 </label>
2228
2229 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="true">
2230 <label class="md-nav__title" for="__nav_6_6">
2231 <span class="md-nav__icon md-icon"></span>
2232 From WoltLab Suite 3.0
2233 </label>
2234 <ul class="md-nav__list" data-md-scrollfix>
2235
2236
2237
2238
2239
2240
2241 <li class="md-nav__item">
2242 <a href="../php/" class="md-nav__link">
2243 PHP API
2244 </a>
2245 </li>
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255 <li class="md-nav__item">
2256 <a href="../javascript/" class="md-nav__link">
2257 JavaScript API
2258 </a>
2259 </li>
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269 <li class="md-nav__item">
2270 <a href="../templates/" class="md-nav__link">
2271 Templates
2272 </a>
2273 </li>
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283 <li class="md-nav__item">
2284 <a href="../css/" class="md-nav__link">
2285 CSS
2286 </a>
2287 </li>
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299 <li class="md-nav__item md-nav__item--active">
2300
2301 <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
2302
2303
2304
2305
2306
2307 <label class="md-nav__link md-nav__link--active" for="__toc">
2308 Package Components
2309 <span class="md-nav__icon md-icon"></span>
2310 </label>
2311
2312 <a href="./" class="md-nav__link md-nav__link--active">
2313 Package Components
2314 </a>
2315
2316
2317
2318 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2319
2320
2321
2322
2323
2324
2325 <label class="md-nav__title" for="__toc">
2326 <span class="md-nav__icon md-icon"></span>
2327 Table of contents
2328 </label>
2329 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2330
2331 <li class="md-nav__item">
2332 <a href="#cronjob-scheduler-uses-server-timezone" class="md-nav__link">
2333 Cronjob Scheduler uses Server Timezone
2334 </a>
2335
2336 </li>
2337
2338 <li class="md-nav__item">
2339 <a href="#exclude-pages-from-becoming-a-landing-page" class="md-nav__link">
2340 Exclude Pages from becoming a Landing Page
2341 </a>
2342
2343 <nav class="md-nav" aria-label="Exclude Pages from becoming a Landing Page">
2344 <ul class="md-nav__list">
2345
2346 <li class="md-nav__item">
2347 <a href="#example-code" class="md-nav__link">
2348 Example Code
2349 </a>
2350
2351 </li>
2352
2353 </ul>
2354 </nav>
2355
2356 </li>
2357
2358 <li class="md-nav__item">
2359 <a href="#new-package-installation-plugin-for-media-providers" class="md-nav__link">
2360 New Package Installation Plugin for Media Providers
2361 </a>
2362
2363 </li>
2364
2365 <li class="md-nav__item">
2366 <a href="#limited-forward-compatibility-for-plugins" class="md-nav__link">
2367 Limited Forward-Compatibility for Plugins
2368 </a>
2369
2370 </li>
2371
2372 </ul>
2373
2374 </nav>
2375
2376 </li>
2377
2378
2379
2380
2381 </ul>
2382 </nav>
2383 </li>
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394 <li class="md-nav__item md-nav__item--nested">
2395
2396
2397
2398
2399 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2400
2401
2402
2403 <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2404 From WCF 2.1
2405 <span class="md-nav__icon md-icon"></span>
2406 </label>
2407
2408 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2409 <label class="md-nav__title" for="__nav_6_7">
2410 <span class="md-nav__icon md-icon"></span>
2411 From WCF 2.1
2412 </label>
2413 <ul class="md-nav__list" data-md-scrollfix>
2414
2415
2416
2417
2418
2419
2420 <li class="md-nav__item">
2421 <a href="../../wcf21/php/" class="md-nav__link">
2422 PHP API
2423 </a>
2424 </li>
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434 <li class="md-nav__item">
2435 <a href="../../wcf21/templates/" class="md-nav__link">
2436 Templates
2437 </a>
2438 </li>
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448 <li class="md-nav__item">
2449 <a href="../../wcf21/css/" class="md-nav__link">
2450 CSS
2451 </a>
2452 </li>
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462 <li class="md-nav__item">
2463 <a href="../../wcf21/package/" class="md-nav__link">
2464 Package Components
2465 </a>
2466 </li>
2467
2468
2469
2470
2471 </ul>
2472 </nav>
2473 </li>
2474
2475
2476
2477
2478 </ul>
2479 </nav>
2480 </li>
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492 <li class="md-nav__item md-nav__item--nested">
2493
2494
2495
2496
2497 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2498
2499
2500
2501 <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2502 Tutorials
2503 <span class="md-nav__icon md-icon"></span>
2504 </label>
2505
2506 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2507 <label class="md-nav__title" for="__nav_7">
2508 <span class="md-nav__icon md-icon"></span>
2509 Tutorials
2510 </label>
2511 <ul class="md-nav__list" data-md-scrollfix>
2512
2513
2514
2515
2516
2517
2518
2519 <li class="md-nav__item md-nav__item--nested">
2520
2521
2522
2523
2524 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2525
2526
2527
2528 <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2529 Tutorial Series
2530 <span class="md-nav__icon md-icon"></span>
2531 </label>
2532
2533 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2534 <label class="md-nav__title" for="__nav_7_1">
2535 <span class="md-nav__icon md-icon"></span>
2536 Tutorial Series
2537 </label>
2538 <ul class="md-nav__list" data-md-scrollfix>
2539
2540
2541
2542
2543
2544
2545 <li class="md-nav__item">
2546 <a href="../../../tutorial/series/overview/" class="md-nav__link">
2547 Overview
2548 </a>
2549 </li>
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559 <li class="md-nav__item">
2560 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2561 Part 1
2562 </a>
2563 </li>
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573 <li class="md-nav__item">
2574 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2575 Part 2
2576 </a>
2577 </li>
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587 <li class="md-nav__item">
2588 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2589 Part 3
2590 </a>
2591 </li>
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601 <li class="md-nav__item">
2602 <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2603 Part 4
2604 </a>
2605 </li>
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615 <li class="md-nav__item">
2616 <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2617 Part 5
2618 </a>
2619 </li>
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629 <li class="md-nav__item">
2630 <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2631 Part 6
2632 </a>
2633 </li>
2634
2635
2636
2637
2638 </ul>
2639 </nav>
2640 </li>
2641
2642
2643
2644
2645 </ul>
2646 </nav>
2647 </li>
2648
2649
2650
2651 </ul>
2652 </nav>
2653 </div>
2654 </div>
2655 </div>
2656
2657
2658
2659 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2660 <div class="md-sidebar__scrollwrap">
2661 <div class="md-sidebar__inner">
2662
2663
2664 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2665
2666
2667
2668
2669
2670
2671 <label class="md-nav__title" for="__toc">
2672 <span class="md-nav__icon md-icon"></span>
2673 Table of contents
2674 </label>
2675 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2676
2677 <li class="md-nav__item">
2678 <a href="#cronjob-scheduler-uses-server-timezone" class="md-nav__link">
2679 Cronjob Scheduler uses Server Timezone
2680 </a>
2681
2682 </li>
2683
2684 <li class="md-nav__item">
2685 <a href="#exclude-pages-from-becoming-a-landing-page" class="md-nav__link">
2686 Exclude Pages from becoming a Landing Page
2687 </a>
2688
2689 <nav class="md-nav" aria-label="Exclude Pages from becoming a Landing Page">
2690 <ul class="md-nav__list">
2691
2692 <li class="md-nav__item">
2693 <a href="#example-code" class="md-nav__link">
2694 Example Code
2695 </a>
2696
2697 </li>
2698
2699 </ul>
2700 </nav>
2701
2702 </li>
2703
2704 <li class="md-nav__item">
2705 <a href="#new-package-installation-plugin-for-media-providers" class="md-nav__link">
2706 New Package Installation Plugin for Media Providers
2707 </a>
2708
2709 </li>
2710
2711 <li class="md-nav__item">
2712 <a href="#limited-forward-compatibility-for-plugins" class="md-nav__link">
2713 Limited Forward-Compatibility for Plugins
2714 </a>
2715
2716 </li>
2717
2718 </ul>
2719
2720 </nav>
2721 </div>
2722 </div>
2723 </div>
2724
2725
2726
2727 <div class="md-content" data-md-component="content">
2728 <article class="md-content__inner md-typeset">
2729
2730
2731
2732
2733
2734
2735
2736 <h1 id="migrating-from-wsc-30-package-components">Migrating from WSC 3.0 - Package Components<a class="headerlink" href="#migrating-from-wsc-30-package-components" title="Permanent link">#</a></h1>
2737 <h2 id="cronjob-scheduler-uses-server-timezone">Cronjob Scheduler uses Server Timezone<a class="headerlink" href="#cronjob-scheduler-uses-server-timezone" title="Permanent link">#</a></h2>
2738 <p>The execution time of cronjobs was previously calculated based on the coordinated universal time (UTC). This was changed in WoltLab Suite 3.1 to use the server timezone or, to be precise, the default timezone set in the administration control panel.</p>
2739 <h2 id="exclude-pages-from-becoming-a-landing-page">Exclude Pages from becoming a Landing Page<a class="headerlink" href="#exclude-pages-from-becoming-a-landing-page" title="Permanent link">#</a></h2>
2740 <p>Some pages do not qualify as landing page, because they're designed around specific expectations that aren't matched in all cases. Examples include the user control panel and its sub-pages that cannot be accessed by guests and will therefore break the landing page for those. While it is somewhat to be expected from control panel pages, there are enough pages that fall under the same restrictions, but aren't easily recognized as such by an administrator.</p>
2741 <p>You can exclude these pages by adding <code>&lt;excludeFromLandingPage&gt;1&lt;/excludeFromLandingPage&gt;</code> (case-sensitive) to the relevant pages in your <code>page.xml</code>.</p>
2742 <h3 id="example-code">Example Code<a class="headerlink" href="#example-code" title="Permanent link">#</a></h3>
2743 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2744 <span class="normal"> 2</span>
2745 <span class="normal"> 3</span>
2746 <span class="normal"> 4</span>
2747 <span class="normal"> 5</span>
2748 <span class="normal"> 6</span>
2749 <span class="normal"> 7</span>
2750 <span class="normal"> 8</span>
2751 <span class="normal"> 9</span>
2752 <span class="normal">10</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2753 <span class="nt">&lt;data</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/tornado/page.xsd&quot;</span><span class="nt">&gt;</span>
2754 <span class="w"> </span><span class="nt">&lt;import&gt;</span>
2755 <span class="w"> </span><span class="nt">&lt;page</span><span class="w"> </span><span class="na">identifier=</span><span class="s">&quot;com.example.foo.Bar&quot;</span><span class="nt">&gt;</span>
2756 <span class="w"> </span><span class="cm">&lt;!-- ... --&gt;</span>
2757 <span class="w"> </span><span class="nt">&lt;excludeFromLandingPage&gt;</span>1<span class="nt">&lt;/excludeFromLandingPage&gt;</span>
2758 <span class="w"> </span><span class="cm">&lt;!-- ... --&gt;</span>
2759 <span class="w"> </span><span class="nt">&lt;/page&gt;</span>
2760 <span class="w"> </span><span class="nt">&lt;/import&gt;</span>
2761 <span class="nt">&lt;/data&gt;</span>
2762 </code></pre></div></td></tr></table></div>
2763 <h2 id="new-package-installation-plugin-for-media-providers">New Package Installation Plugin for Media Providers<a class="headerlink" href="#new-package-installation-plugin-for-media-providers" title="Permanent link">#</a></h2>
2764 <p>Please refer to the documentation of the <a href="../../../package/pip/media-provider/"><code>mediaProvider.xml</code></a> to learn more.</p>
2765 <h2 id="limited-forward-compatibility-for-plugins">Limited Forward-Compatibility for Plugins<a class="headerlink" href="#limited-forward-compatibility-for-plugins" title="Permanent link">#</a></h2>
2766 <p>Please refer to the documentation of the <a href="../../../package/package-xml/#compatibility"><code>&lt;compatibility&gt;</code></a> tag in the <code>package.xml</code>.</p>
2767
2768 <hr>
2769 <div class="md-source-file">
2770 <small>
2771
2772 Last update:
2773 2021-01-08
2774
2775 </small>
2776 </div>
2777
2778
2779
2780
2781
2782
2783 </article>
2784 </div>
2785
2786
2787 </div>
2788
2789 </main>
2790
2791 <footer class="md-footer">
2792
2793 <div class="md-footer-meta md-typeset">
2794 <div class="md-footer-meta__inner md-grid">
2795 <div class="md-copyright">
2796
2797 <div class="md-copyright__highlight">
2798 Copyright © 2020 WoltLab GmbH
2799 </div>
2800
2801
2802 Made with
2803 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2804 Material for MkDocs
2805 </a>
2806
2807 </div>
2808
2809 <div class="md-copyright">
2810 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2811 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2812 </div>
2813
2814 </div>
2815 </div>
2816 </footer>
2817
2818 </div>
2819 <div class="md-dialog" data-md-component="dialog">
2820 <div class="md-dialog__inner md-typeset"></div>
2821 </div>
2822
2823 <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
2824
2825
2826 <script src="../../../assets/javascripts/bundle.b4d07000.min.js"></script>
2827
2828
2829 </body>
2830 </html>