Deployed d602f523 to 6.1 with MkDocs 1.5.3 and mike 1.1.2
[GitHub/WoltLab/woltlab.github.io.git] / 6.1 / migration / wsc53 / session / 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.1/migration/wsc53/session/">
12
13
14 <link rel="prev" href="../php/">
15
16
17 <link rel="next" href="../javascript/">
18
19
20 <link rel="icon" href="../../../assets/default.favicon.ico">
21 <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.2">
22
23
24
25 <title>Session Handling and Authentication - WoltLab Suite Documentation</title>
26
27
28
29 <link rel="stylesheet" href="../../../assets/stylesheets/main.d451bc0e.min.css">
30
31
32 <link rel="stylesheet" href="../../../assets/stylesheets/palette.a5377069.min.css">
33
34
35
36
37
38
39
40
41
42
43
44
45 <link rel="stylesheet" href="../../../stylesheets/extra.css">
46
47 <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>
48
49
50
51
52
53
54 </head>
55
56
57
58
59
60
61
62 <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
63
64
65
66 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
67 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
68 <label class="md-overlay" for="__drawer"></label>
69 <div data-md-component="skip">
70
71
72 <a href="#migrating-from-woltlab-suite-53-session-handling-and-authentication" class="md-skip">
73 Skip to content
74 </a>
75
76 </div>
77 <div data-md-component="announce">
78
79 <aside class="md-banner">
80 <div class="md-banner__inner md-grid md-typeset">
81
82
83 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
84
85 </div>
86
87 </aside>
88
89 </div>
90
91 <div data-md-color-scheme="default" data-md-component="outdated" hidden>
92
93 </div>
94
95
96
97
98
99
100 <header class="md-header md-header--shadow" data-md-component="header">
101 <nav class="md-header__inner md-grid" aria-label="Header">
102 <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
103
104 <img src="../../../assets/logo.png" alt="logo">
105
106 </a>
107 <label class="md-header__button md-icon" for="__drawer">
108
109 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
110 </label>
111 <div class="md-header__title" data-md-component="header-title">
112 <div class="md-header__ellipsis">
113 <div class="md-header__topic">
114 <span class="md-ellipsis">
115 WoltLab Suite Documentation
116 </span>
117 </div>
118 <div class="md-header__topic" data-md-component="header-topic">
119 <span class="md-ellipsis">
120
121 Session Handling and Authentication
122
123 </span>
124 </div>
125 </div>
126 </div>
127
128
129
130
131
132 <label class="md-header__button md-icon" for="__search">
133
134 <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>
135 </label>
136 <div class="md-search" data-md-component="search" role="dialog">
137 <label class="md-search__overlay" for="__search"></label>
138 <div class="md-search__inner" role="search">
139 <form class="md-search__form" name="search">
140 <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>
141 <label class="md-search__icon md-icon" for="__search">
142
143 <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>
144
145 <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>
146 </label>
147 <nav class="md-search__options" aria-label="Search">
148
149 <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
150
151 <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>
152 </button>
153 </nav>
154
155 </form>
156 <div class="md-search__output">
157 <div class="md-search__scrollwrap" data-md-scrollfix>
158 <div class="md-search-result" data-md-component="search-result">
159 <div class="md-search-result__meta">
160 Initializing search
161 </div>
162 <ol class="md-search-result__list" role="presentation"></ol>
163 </div>
164 </div>
165 </div>
166 </div>
167 </div>
168
169
170 <div class="md-header__source">
171 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
172 <div class="md-source__icon md-icon">
173
174 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 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>
175 </div>
176 <div class="md-source__repository">
177 GitHub
178 </div>
179 </a>
180 </div>
181
182 </nav>
183
184 </header>
185
186 <div class="md-container" data-md-component="container">
187
188
189
190
191
192
193 <main class="md-main" data-md-component="main">
194 <div class="md-main__inner md-grid">
195
196
197
198 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
199 <div class="md-sidebar__scrollwrap">
200 <div class="md-sidebar__inner">
201
202
203
204
205 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
206 <label class="md-nav__title" for="__drawer">
207 <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
208
209 <img src="../../../assets/logo.png" alt="logo">
210
211 </a>
212 WoltLab Suite Documentation
213 </label>
214
215 <div class="md-nav__source">
216 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
217 <div class="md-source__icon md-icon">
218
219 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 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>
220 </div>
221 <div class="md-source__repository">
222 GitHub
223 </div>
224 </a>
225 </div>
226
227 <ul class="md-nav__list" data-md-scrollfix>
228
229
230
231
232
233
234 <li class="md-nav__item">
235 <a href="../../../getting-started/" class="md-nav__link">
236
237
238 <span class="md-ellipsis">
239 Getting Started
240 </span>
241
242
243 </a>
244 </li>
245
246
247
248
249
250
251
252
253
254
255
256
257
258 <li class="md-nav__item md-nav__item--nested">
259
260
261
262
263 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
264
265
266 <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
267
268
269 <span class="md-ellipsis">
270 PHP API
271 </span>
272
273
274 <span class="md-nav__icon md-icon"></span>
275 </label>
276
277 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
278 <label class="md-nav__title" for="__nav_2">
279 <span class="md-nav__icon md-icon"></span>
280 PHP API
281 </label>
282 <ul class="md-nav__list" data-md-scrollfix>
283
284
285
286
287
288
289 <li class="md-nav__item">
290 <a href="../../../php/pages/" class="md-nav__link">
291
292
293 <span class="md-ellipsis">
294 Pages
295 </span>
296
297
298 </a>
299 </li>
300
301
302
303
304
305
306
307
308
309 <li class="md-nav__item">
310 <a href="../../../php/database-objects/" class="md-nav__link">
311
312
313 <span class="md-ellipsis">
314 Database Objects
315 </span>
316
317
318 </a>
319 </li>
320
321
322
323
324
325
326
327
328
329 <li class="md-nav__item">
330 <a href="../../../php/database-access/" class="md-nav__link">
331
332
333 <span class="md-ellipsis">
334 Database Access
335 </span>
336
337
338 </a>
339 </li>
340
341
342
343
344
345
346
347
348
349 <li class="md-nav__item">
350 <a href="../../../php/exceptions/" class="md-nav__link">
351
352
353 <span class="md-ellipsis">
354 Exceptions
355 </span>
356
357
358 </a>
359 </li>
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374 <li class="md-nav__item md-nav__item--nested">
375
376
377
378
379 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
380
381
382 <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
383
384
385 <span class="md-ellipsis">
386 API
387 </span>
388
389
390 <span class="md-nav__icon md-icon"></span>
391 </label>
392
393 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
394 <label class="md-nav__title" for="__nav_2_5">
395 <span class="md-nav__icon md-icon"></span>
396 API
397 </label>
398 <ul class="md-nav__list" data-md-scrollfix>
399
400
401
402
403
404
405
406
407
408
409
410 <li class="md-nav__item md-nav__item--nested">
411
412
413
414
415 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
416
417
418 <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
419
420
421 <span class="md-ellipsis">
422 Caches
423 </span>
424
425
426 <span class="md-nav__icon md-icon"></span>
427 </label>
428
429 <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
430 <label class="md-nav__title" for="__nav_2_5_1">
431 <span class="md-nav__icon md-icon"></span>
432 Caches
433 </label>
434 <ul class="md-nav__list" data-md-scrollfix>
435
436
437
438
439
440
441 <li class="md-nav__item">
442 <a href="../../../php/api/caches/" class="md-nav__link">
443
444
445 <span class="md-ellipsis">
446 Overview
447 </span>
448
449
450 </a>
451 </li>
452
453
454
455
456
457
458
459
460
461 <li class="md-nav__item">
462 <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
463
464
465 <span class="md-ellipsis">
466 Persistent Caches
467 </span>
468
469
470 </a>
471 </li>
472
473
474
475
476
477
478
479
480
481 <li class="md-nav__item">
482 <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
483
484
485 <span class="md-ellipsis">
486 Runtime Caches
487 </span>
488
489
490 </a>
491 </li>
492
493
494
495
496 </ul>
497 </nav>
498
499 </li>
500
501
502
503
504
505
506
507
508
509 <li class="md-nav__item">
510 <a href="../../../php/api/comments/" class="md-nav__link">
511
512
513 <span class="md-ellipsis">
514 Comments
515 </span>
516
517
518 </a>
519 </li>
520
521
522
523
524
525
526
527
528
529 <li class="md-nav__item">
530 <a href="../../../php/api/cronjobs/" class="md-nav__link">
531
532
533 <span class="md-ellipsis">
534 Cronjobs
535 </span>
536
537
538 </a>
539 </li>
540
541
542
543
544
545
546
547
548
549 <li class="md-nav__item">
550 <a href="../../../php/api/events/" class="md-nav__link">
551
552
553 <span class="md-ellipsis">
554 Events
555 </span>
556
557
558 </a>
559 </li>
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574 <li class="md-nav__item md-nav__item--nested">
575
576
577
578
579 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
580
581
582 <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
583
584
585 <span class="md-ellipsis">
586 Form Builder
587 </span>
588
589
590 <span class="md-nav__icon md-icon"></span>
591 </label>
592
593 <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
594 <label class="md-nav__title" for="__nav_2_5_5">
595 <span class="md-nav__icon md-icon"></span>
596 Form Builder
597 </label>
598 <ul class="md-nav__list" data-md-scrollfix>
599
600
601
602
603
604
605 <li class="md-nav__item">
606 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
607
608
609 <span class="md-ellipsis">
610 Overview
611 </span>
612
613
614 </a>
615 </li>
616
617
618
619
620
621
622
623
624
625 <li class="md-nav__item">
626 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
627
628
629 <span class="md-ellipsis">
630 Structure
631 </span>
632
633
634 </a>
635 </li>
636
637
638
639
640
641
642
643
644
645 <li class="md-nav__item">
646 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
647
648
649 <span class="md-ellipsis">
650 Fields
651 </span>
652
653
654 </a>
655 </li>
656
657
658
659
660
661
662
663
664
665 <li class="md-nav__item">
666 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
667
668
669 <span class="md-ellipsis">
670 Validation and Data
671 </span>
672
673
674 </a>
675 </li>
676
677
678
679
680
681
682
683
684
685 <li class="md-nav__item">
686 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
687
688
689 <span class="md-ellipsis">
690 Dependencies
691 </span>
692
693
694 </a>
695 </li>
696
697
698
699
700 </ul>
701 </nav>
702
703 </li>
704
705
706
707
708
709
710
711
712
713 <li class="md-nav__item">
714 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
715
716
717 <span class="md-ellipsis">
718 Package Installation Plugins
719 </span>
720
721
722 </a>
723 </li>
724
725
726
727
728
729
730
731
732
733 <li class="md-nav__item">
734 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
735
736
737 <span class="md-ellipsis">
738 User Activity Points
739 </span>
740
741
742 </a>
743 </li>
744
745
746
747
748
749
750
751
752
753 <li class="md-nav__item">
754 <a href="../../../php/api/user_notifications/" class="md-nav__link">
755
756
757 <span class="md-ellipsis">
758 User Notifications
759 </span>
760
761
762 </a>
763 </li>
764
765
766
767
768
769
770
771
772
773 <li class="md-nav__item">
774 <a href="../../../php/api/rss_feeds/" class="md-nav__link">
775
776
777 <span class="md-ellipsis">
778 RSS Feeds
779 </span>
780
781
782 </a>
783 </li>
784
785
786
787
788
789
790
791
792
793 <li class="md-nav__item">
794 <a href="../../../php/api/sitemaps/" class="md-nav__link">
795
796
797 <span class="md-ellipsis">
798 Sitemaps
799 </span>
800
801
802 </a>
803 </li>
804
805
806
807
808 </ul>
809 </nav>
810
811 </li>
812
813
814
815
816
817
818
819
820
821 <li class="md-nav__item">
822 <a href="../../../php/code-style/" class="md-nav__link">
823
824
825 <span class="md-ellipsis">
826 Code Style
827 </span>
828
829
830 </a>
831 </li>
832
833
834
835
836
837
838
839
840
841 <li class="md-nav__item">
842 <a href="../../../php/apps/" class="md-nav__link">
843
844
845 <span class="md-ellipsis">
846 Apps
847 </span>
848
849
850 </a>
851 </li>
852
853
854
855
856
857
858
859
860
861 <li class="md-nav__item">
862 <a href="../../../php/gdpr/" class="md-nav__link">
863
864
865 <span class="md-ellipsis">
866 GDPR
867 </span>
868
869
870 </a>
871 </li>
872
873
874
875
876 </ul>
877 </nav>
878
879 </li>
880
881
882
883
884
885
886
887
888
889
890
891
892
893 <li class="md-nav__item md-nav__item--nested">
894
895
896
897
898 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
899
900
901 <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
902
903
904 <span class="md-ellipsis">
905 Languages, Templates & CSS
906 </span>
907
908
909 <span class="md-nav__icon md-icon"></span>
910 </label>
911
912 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
913 <label class="md-nav__title" for="__nav_3">
914 <span class="md-nav__icon md-icon"></span>
915 Languages, Templates & CSS
916 </label>
917 <ul class="md-nav__list" data-md-scrollfix>
918
919
920
921
922
923
924 <li class="md-nav__item">
925 <a href="../../../view/languages/" class="md-nav__link">
926
927
928 <span class="md-ellipsis">
929 Languages
930 </span>
931
932
933 </a>
934 </li>
935
936
937
938
939
940
941
942
943
944 <li class="md-nav__item">
945 <a href="../../../view/templates/" class="md-nav__link">
946
947
948 <span class="md-ellipsis">
949 Templates
950 </span>
951
952
953 </a>
954 </li>
955
956
957
958
959
960
961
962
963
964 <li class="md-nav__item">
965 <a href="../../../view/template-modifiers/" class="md-nav__link">
966
967
968 <span class="md-ellipsis">
969 Template Modifiers
970 </span>
971
972
973 </a>
974 </li>
975
976
977
978
979
980
981
982
983
984 <li class="md-nav__item">
985 <a href="../../../view/template-plugins/" class="md-nav__link">
986
987
988 <span class="md-ellipsis">
989 Template Plugins
990 </span>
991
992
993 </a>
994 </li>
995
996
997
998
999
1000
1001
1002
1003
1004 <li class="md-nav__item">
1005 <a href="../../../view/css/" class="md-nav__link">
1006
1007
1008 <span class="md-ellipsis">
1009 CSS
1010 </span>
1011
1012
1013 </a>
1014 </li>
1015
1016
1017
1018
1019 </ul>
1020 </nav>
1021
1022 </li>
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036 <li class="md-nav__item md-nav__item--nested">
1037
1038
1039
1040
1041 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
1042
1043
1044 <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
1045
1046
1047 <span class="md-ellipsis">
1048 TypeScript and JavaScript API
1049 </span>
1050
1051
1052 <span class="md-nav__icon md-icon"></span>
1053 </label>
1054
1055 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
1056 <label class="md-nav__title" for="__nav_4">
1057 <span class="md-nav__icon md-icon"></span>
1058 TypeScript and JavaScript API
1059 </label>
1060 <ul class="md-nav__list" data-md-scrollfix>
1061
1062
1063
1064
1065
1066
1067 <li class="md-nav__item">
1068 <a href="../../../javascript/general-usage/" class="md-nav__link">
1069
1070
1071 <span class="md-ellipsis">
1072 General Usage
1073 </span>
1074
1075
1076 </a>
1077 </li>
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087 <li class="md-nav__item">
1088 <a href="../../../javascript/typescript/" class="md-nav__link">
1089
1090
1091 <span class="md-ellipsis">
1092 TypeScript
1093 </span>
1094
1095
1096 </a>
1097 </li>
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112 <li class="md-nav__item md-nav__item--nested">
1113
1114
1115
1116
1117 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
1118
1119
1120 <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
1121
1122
1123 <span class="md-ellipsis">
1124 Components
1125 </span>
1126
1127
1128 <span class="md-nav__icon md-icon"></span>
1129 </label>
1130
1131 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
1132 <label class="md-nav__title" for="__nav_4_3">
1133 <span class="md-nav__icon md-icon"></span>
1134 Components
1135 </label>
1136 <ul class="md-nav__list" data-md-scrollfix>
1137
1138
1139
1140
1141
1142
1143 <li class="md-nav__item">
1144 <a href="../../../javascript/components_ckeditor5/" class="md-nav__link">
1145
1146
1147 <span class="md-ellipsis">
1148 CKEditor 5
1149 </span>
1150
1151
1152 </a>
1153 </li>
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163 <li class="md-nav__item">
1164 <a href="../../../javascript/components_confirmation/" class="md-nav__link">
1165
1166
1167 <span class="md-ellipsis">
1168 Confirmation
1169 </span>
1170
1171
1172 </a>
1173 </li>
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183 <li class="md-nav__item">
1184 <a href="../../../javascript/components_dialog/" class="md-nav__link">
1185
1186
1187 <span class="md-ellipsis">
1188 Dialog
1189 </span>
1190
1191
1192 </a>
1193 </li>
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203 <li class="md-nav__item">
1204 <a href="../../../javascript/components_google_maps/" class="md-nav__link">
1205
1206
1207 <span class="md-ellipsis">
1208 Google Maps
1209 </span>
1210
1211
1212 </a>
1213 </li>
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223 <li class="md-nav__item">
1224 <a href="../../../javascript/components_pagination/" class="md-nav__link">
1225
1226
1227 <span class="md-ellipsis">
1228 Pagination
1229 </span>
1230
1231
1232 </a>
1233 </li>
1234
1235
1236
1237
1238 </ul>
1239 </nav>
1240
1241 </li>
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256 <li class="md-nav__item md-nav__item--nested">
1257
1258
1259
1260
1261 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
1262
1263
1264 <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
1265
1266
1267 <span class="md-ellipsis">
1268 New API
1269 </span>
1270
1271
1272 <span class="md-nav__icon md-icon"></span>
1273 </label>
1274
1275 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
1276 <label class="md-nav__title" for="__nav_4_4">
1277 <span class="md-nav__icon md-icon"></span>
1278 New API
1279 </label>
1280 <ul class="md-nav__list" data-md-scrollfix>
1281
1282
1283
1284
1285
1286
1287 <li class="md-nav__item">
1288 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
1289
1290
1291 <span class="md-ellipsis">
1292 Writing a module
1293 </span>
1294
1295
1296 </a>
1297 </li>
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307 <li class="md-nav__item">
1308 <a href="../../../javascript/new-api_core/" class="md-nav__link">
1309
1310
1311 <span class="md-ellipsis">
1312 Core Functions
1313 </span>
1314
1315
1316 </a>
1317 </li>
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327 <li class="md-nav__item">
1328 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
1329
1330
1331 <span class="md-ellipsis">
1332 DOM
1333 </span>
1334
1335
1336 </a>
1337 </li>
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347 <li class="md-nav__item">
1348 <a href="../../../javascript/new-api_events/" class="md-nav__link">
1349
1350
1351 <span class="md-ellipsis">
1352 Event Handling
1353 </span>
1354
1355
1356 </a>
1357 </li>
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367 <li class="md-nav__item">
1368 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1369
1370
1371 <span class="md-ellipsis">
1372 Ajax
1373 </span>
1374
1375
1376 </a>
1377 </li>
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387 <li class="md-nav__item">
1388 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1389
1390
1391 <span class="md-ellipsis">
1392 Dialogs
1393 </span>
1394
1395
1396 </a>
1397 </li>
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407 <li class="md-nav__item">
1408 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1409
1410
1411 <span class="md-ellipsis">
1412 Browser and Screen Sizes
1413 </span>
1414
1415
1416 </a>
1417 </li>
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427 <li class="md-nav__item">
1428 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1429
1430
1431 <span class="md-ellipsis">
1432 User Interface
1433 </span>
1434
1435
1436 </a>
1437 </li>
1438
1439
1440
1441
1442 </ul>
1443 </nav>
1444
1445 </li>
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455 <li class="md-nav__item">
1456 <a href="../../../javascript/legacy-api/" class="md-nav__link">
1457
1458
1459 <span class="md-ellipsis">
1460 Legacy API
1461 </span>
1462
1463
1464 </a>
1465 </li>
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475 <li class="md-nav__item">
1476 <a href="../../../javascript/code-snippets/" class="md-nav__link">
1477
1478
1479 <span class="md-ellipsis">
1480 Code Snippets
1481 </span>
1482
1483
1484 </a>
1485 </li>
1486
1487
1488
1489
1490 </ul>
1491 </nav>
1492
1493 </li>
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507 <li class="md-nav__item md-nav__item--nested">
1508
1509
1510
1511
1512 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1513
1514
1515 <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1516
1517
1518 <span class="md-ellipsis">
1519 Package Components
1520 </span>
1521
1522
1523 <span class="md-nav__icon md-icon"></span>
1524 </label>
1525
1526 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1527 <label class="md-nav__title" for="__nav_5">
1528 <span class="md-nav__icon md-icon"></span>
1529 Package Components
1530 </label>
1531 <ul class="md-nav__list" data-md-scrollfix>
1532
1533
1534
1535
1536
1537
1538 <li class="md-nav__item">
1539 <a href="../../../package/package-xml/" class="md-nav__link">
1540
1541
1542 <span class="md-ellipsis">
1543 package.xml
1544 </span>
1545
1546
1547 </a>
1548 </li>
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563 <li class="md-nav__item md-nav__item--nested">
1564
1565
1566
1567
1568 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1569
1570
1571 <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1572
1573
1574 <span class="md-ellipsis">
1575 PIPs
1576 </span>
1577
1578
1579 <span class="md-nav__icon md-icon"></span>
1580 </label>
1581
1582 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1583 <label class="md-nav__title" for="__nav_5_2">
1584 <span class="md-nav__icon md-icon"></span>
1585 PIPs
1586 </label>
1587 <ul class="md-nav__list" data-md-scrollfix>
1588
1589
1590
1591
1592
1593
1594 <li class="md-nav__item">
1595 <a href="../../../package/pip/" class="md-nav__link">
1596
1597
1598 <span class="md-ellipsis">
1599 Overview
1600 </span>
1601
1602
1603 </a>
1604 </li>
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614 <li class="md-nav__item">
1615 <a href="../../../package/pip/acl-option/" class="md-nav__link">
1616
1617
1618 <span class="md-ellipsis">
1619 aclOption
1620 </span>
1621
1622
1623 </a>
1624 </li>
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634 <li class="md-nav__item">
1635 <a href="../../../package/pip/acp-menu/" class="md-nav__link">
1636
1637
1638 <span class="md-ellipsis">
1639 acpMenu
1640 </span>
1641
1642
1643 </a>
1644 </li>
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654 <li class="md-nav__item">
1655 <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
1656
1657
1658 <span class="md-ellipsis">
1659 acpSearchProvider
1660 </span>
1661
1662
1663 </a>
1664 </li>
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674 <li class="md-nav__item">
1675 <a href="../../../package/pip/acp-template/" class="md-nav__link">
1676
1677
1678 <span class="md-ellipsis">
1679 acpTemplate
1680 </span>
1681
1682
1683 </a>
1684 </li>
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694 <li class="md-nav__item">
1695 <a href="../../../package/pip/acp-template-delete/" class="md-nav__link">
1696
1697
1698 <span class="md-ellipsis">
1699 acpTemplateDelete
1700 </span>
1701
1702
1703 </a>
1704 </li>
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714 <li class="md-nav__item">
1715 <a href="../../../package/pip/bbcode/" class="md-nav__link">
1716
1717
1718 <span class="md-ellipsis">
1719 bbcode
1720 </span>
1721
1722
1723 </a>
1724 </li>
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734 <li class="md-nav__item">
1735 <a href="../../../package/pip/box/" class="md-nav__link">
1736
1737
1738 <span class="md-ellipsis">
1739 box
1740 </span>
1741
1742
1743 </a>
1744 </li>
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754 <li class="md-nav__item">
1755 <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1756
1757
1758 <span class="md-ellipsis">
1759 clipboardAction
1760 </span>
1761
1762
1763 </a>
1764 </li>
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774 <li class="md-nav__item">
1775 <a href="../../../package/pip/core-object/" class="md-nav__link">
1776
1777
1778 <span class="md-ellipsis">
1779 coreObject
1780 </span>
1781
1782
1783 </a>
1784 </li>
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794 <li class="md-nav__item">
1795 <a href="../../../package/pip/cronjob/" class="md-nav__link">
1796
1797
1798 <span class="md-ellipsis">
1799 cronjob
1800 </span>
1801
1802
1803 </a>
1804 </li>
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814 <li class="md-nav__item">
1815 <a href="../../../package/pip/database/" class="md-nav__link">
1816
1817
1818 <span class="md-ellipsis">
1819 database
1820 </span>
1821
1822
1823 </a>
1824 </li>
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834 <li class="md-nav__item">
1835 <a href="../../../package/pip/event-listener/" class="md-nav__link">
1836
1837
1838 <span class="md-ellipsis">
1839 eventListener
1840 </span>
1841
1842
1843 </a>
1844 </li>
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854 <li class="md-nav__item">
1855 <a href="../../../package/pip/file/" class="md-nav__link">
1856
1857
1858 <span class="md-ellipsis">
1859 file
1860 </span>
1861
1862
1863 </a>
1864 </li>
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874 <li class="md-nav__item">
1875 <a href="../../../package/pip/file-delete/" class="md-nav__link">
1876
1877
1878 <span class="md-ellipsis">
1879 fileDelete
1880 </span>
1881
1882
1883 </a>
1884 </li>
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894 <li class="md-nav__item">
1895 <a href="../../../package/pip/language/" class="md-nav__link">
1896
1897
1898 <span class="md-ellipsis">
1899 language
1900 </span>
1901
1902
1903 </a>
1904 </li>
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914 <li class="md-nav__item">
1915 <a href="../../../package/pip/media-provider/" class="md-nav__link">
1916
1917
1918 <span class="md-ellipsis">
1919 mediaProvider
1920 </span>
1921
1922
1923 </a>
1924 </li>
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934 <li class="md-nav__item">
1935 <a href="../../../package/pip/menu/" class="md-nav__link">
1936
1937
1938 <span class="md-ellipsis">
1939 menu
1940 </span>
1941
1942
1943 </a>
1944 </li>
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954 <li class="md-nav__item">
1955 <a href="../../../package/pip/menu-item/" class="md-nav__link">
1956
1957
1958 <span class="md-ellipsis">
1959 menuItem
1960 </span>
1961
1962
1963 </a>
1964 </li>
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974 <li class="md-nav__item">
1975 <a href="../../../package/pip/object-type/" class="md-nav__link">
1976
1977
1978 <span class="md-ellipsis">
1979 objectType
1980 </span>
1981
1982
1983 </a>
1984 </li>
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994 <li class="md-nav__item">
1995 <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1996
1997
1998 <span class="md-ellipsis">
1999 objectTypeDefinition
2000 </span>
2001
2002
2003 </a>
2004 </li>
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014 <li class="md-nav__item">
2015 <a href="../../../package/pip/option/" class="md-nav__link">
2016
2017
2018 <span class="md-ellipsis">
2019 option
2020 </span>
2021
2022
2023 </a>
2024 </li>
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034 <li class="md-nav__item">
2035 <a href="../../../package/pip/page/" class="md-nav__link">
2036
2037
2038 <span class="md-ellipsis">
2039 page
2040 </span>
2041
2042
2043 </a>
2044 </li>
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054 <li class="md-nav__item">
2055 <a href="../../../package/pip/pip/" class="md-nav__link">
2056
2057
2058 <span class="md-ellipsis">
2059 pip
2060 </span>
2061
2062
2063 </a>
2064 </li>
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074 <li class="md-nav__item">
2075 <a href="../../../package/pip/script/" class="md-nav__link">
2076
2077
2078 <span class="md-ellipsis">
2079 script
2080 </span>
2081
2082
2083 </a>
2084 </li>
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094 <li class="md-nav__item">
2095 <a href="../../../package/pip/smiley/" class="md-nav__link">
2096
2097
2098 <span class="md-ellipsis">
2099 smiley
2100 </span>
2101
2102
2103 </a>
2104 </li>
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114 <li class="md-nav__item">
2115 <a href="../../../package/pip/sql/" class="md-nav__link">
2116
2117
2118 <span class="md-ellipsis">
2119 sql
2120 </span>
2121
2122
2123 </a>
2124 </li>
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134 <li class="md-nav__item">
2135 <a href="../../../package/pip/style/" class="md-nav__link">
2136
2137
2138 <span class="md-ellipsis">
2139 style
2140 </span>
2141
2142
2143 </a>
2144 </li>
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154 <li class="md-nav__item">
2155 <a href="../../../package/pip/template/" class="md-nav__link">
2156
2157
2158 <span class="md-ellipsis">
2159 template
2160 </span>
2161
2162
2163 </a>
2164 </li>
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174 <li class="md-nav__item">
2175 <a href="../../../package/pip/template-delete/" class="md-nav__link">
2176
2177
2178 <span class="md-ellipsis">
2179 templateDelete
2180 </span>
2181
2182
2183 </a>
2184 </li>
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194 <li class="md-nav__item">
2195 <a href="../../../package/pip/template-listener/" class="md-nav__link">
2196
2197
2198 <span class="md-ellipsis">
2199 templateListener
2200 </span>
2201
2202
2203 </a>
2204 </li>
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214 <li class="md-nav__item">
2215 <a href="../../../package/pip/user-group-option/" class="md-nav__link">
2216
2217
2218 <span class="md-ellipsis">
2219 userGroupOption
2220 </span>
2221
2222
2223 </a>
2224 </li>
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234 <li class="md-nav__item">
2235 <a href="../../../package/pip/user-menu/" class="md-nav__link">
2236
2237
2238 <span class="md-ellipsis">
2239 userMenu
2240 </span>
2241
2242
2243 </a>
2244 </li>
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254 <li class="md-nav__item">
2255 <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
2256
2257
2258 <span class="md-ellipsis">
2259 userNotificationEvent
2260 </span>
2261
2262
2263 </a>
2264 </li>
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274 <li class="md-nav__item">
2275 <a href="../../../package/pip/user-option/" class="md-nav__link">
2276
2277
2278 <span class="md-ellipsis">
2279 userOption
2280 </span>
2281
2282
2283 </a>
2284 </li>
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294 <li class="md-nav__item">
2295 <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
2296
2297
2298 <span class="md-ellipsis">
2299 userProfileMenu
2300 </span>
2301
2302
2303 </a>
2304 </li>
2305
2306
2307
2308
2309 </ul>
2310 </nav>
2311
2312 </li>
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322 <li class="md-nav__item">
2323 <a href="../../../package/database-php-api/" class="md-nav__link">
2324
2325
2326 <span class="md-ellipsis">
2327 Database PHP API
2328 </span>
2329
2330
2331 </a>
2332 </li>
2333
2334
2335
2336
2337 </ul>
2338 </nav>
2339
2340 </li>
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
2357
2358
2359
2360
2361 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
2362
2363
2364 <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
2365
2366
2367 <span class="md-ellipsis">
2368 Migration
2369 </span>
2370
2371
2372 <span class="md-nav__icon md-icon"></span>
2373 </label>
2374
2375 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
2376 <label class="md-nav__title" for="__nav_6">
2377 <span class="md-nav__icon md-icon"></span>
2378 Migration
2379 </label>
2380 <ul class="md-nav__list" data-md-scrollfix>
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392 <li class="md-nav__item md-nav__item--nested">
2393
2394
2395
2396
2397 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
2398
2399
2400 <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
2401
2402
2403 <span class="md-ellipsis">
2404 From WoltLab Suite 6.0
2405 </span>
2406
2407
2408 <span class="md-nav__icon md-icon"></span>
2409 </label>
2410
2411 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
2412 <label class="md-nav__title" for="__nav_6_1">
2413 <span class="md-nav__icon md-icon"></span>
2414 From WoltLab Suite 6.0
2415 </label>
2416 <ul class="md-nav__list" data-md-scrollfix>
2417
2418
2419
2420
2421
2422
2423 <li class="md-nav__item">
2424 <a href="../../wsc60/php/" class="md-nav__link">
2425
2426
2427 <span class="md-ellipsis">
2428 PHP API
2429 </span>
2430
2431
2432 </a>
2433 </li>
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443 <li class="md-nav__item">
2444 <a href="../../wsc60/templates/" class="md-nav__link">
2445
2446
2447 <span class="md-ellipsis">
2448 Templates
2449 </span>
2450
2451
2452 </a>
2453 </li>
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463 <li class="md-nav__item">
2464 <a href="../../wsc60/deprecations_removals/" class="md-nav__link">
2465
2466
2467 <span class="md-ellipsis">
2468 Deprecations and Removals
2469 </span>
2470
2471
2472 </a>
2473 </li>
2474
2475
2476
2477
2478 </ul>
2479 </nav>
2480
2481 </li>
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496 <li class="md-nav__item md-nav__item--nested">
2497
2498
2499
2500
2501 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
2502
2503
2504 <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
2505
2506
2507 <span class="md-ellipsis">
2508 From WoltLab Suite 5.5
2509 </span>
2510
2511
2512 <span class="md-nav__icon md-icon"></span>
2513 </label>
2514
2515 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
2516 <label class="md-nav__title" for="__nav_6_2">
2517 <span class="md-nav__icon md-icon"></span>
2518 From WoltLab Suite 5.5
2519 </label>
2520 <ul class="md-nav__list" data-md-scrollfix>
2521
2522
2523
2524
2525
2526
2527 <li class="md-nav__item">
2528 <a href="../../wsc55/php/" class="md-nav__link">
2529
2530
2531 <span class="md-ellipsis">
2532 PHP API
2533 </span>
2534
2535
2536 </a>
2537 </li>
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547 <li class="md-nav__item">
2548 <a href="../../wsc55/javascript/" class="md-nav__link">
2549
2550
2551 <span class="md-ellipsis">
2552 TypeScript and JavaScript
2553 </span>
2554
2555
2556 </a>
2557 </li>
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567 <li class="md-nav__item">
2568 <a href="../../wsc55/templates/" class="md-nav__link">
2569
2570
2571 <span class="md-ellipsis">
2572 Templates
2573 </span>
2574
2575
2576 </a>
2577 </li>
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587 <li class="md-nav__item">
2588 <a href="../../wsc55/icons/" class="md-nav__link">
2589
2590
2591 <span class="md-ellipsis">
2592 Icons
2593 </span>
2594
2595
2596 </a>
2597 </li>
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607 <li class="md-nav__item">
2608 <a href="../../wsc55/dialogs/" class="md-nav__link">
2609
2610
2611 <span class="md-ellipsis">
2612 Dialogs
2613 </span>
2614
2615
2616 </a>
2617 </li>
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627 <li class="md-nav__item">
2628 <a href="../../wsc55/libraries/" class="md-nav__link">
2629
2630
2631 <span class="md-ellipsis">
2632 Third Party Libraries
2633 </span>
2634
2635
2636 </a>
2637 </li>
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647 <li class="md-nav__item">
2648 <a href="../../wsc55/deprecations_removals/" class="md-nav__link">
2649
2650
2651 <span class="md-ellipsis">
2652 Deprecations and Removals
2653 </span>
2654
2655
2656 </a>
2657 </li>
2658
2659
2660
2661
2662 </ul>
2663 </nav>
2664
2665 </li>
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680 <li class="md-nav__item md-nav__item--nested">
2681
2682
2683
2684
2685 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2686
2687
2688 <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2689
2690
2691 <span class="md-ellipsis">
2692 From WoltLab Suite 5.4
2693 </span>
2694
2695
2696 <span class="md-nav__icon md-icon"></span>
2697 </label>
2698
2699 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2700 <label class="md-nav__title" for="__nav_6_3">
2701 <span class="md-nav__icon md-icon"></span>
2702 From WoltLab Suite 5.4
2703 </label>
2704 <ul class="md-nav__list" data-md-scrollfix>
2705
2706
2707
2708
2709
2710
2711 <li class="md-nav__item">
2712 <a href="../../wsc54/php/" class="md-nav__link">
2713
2714
2715 <span class="md-ellipsis">
2716 PHP API
2717 </span>
2718
2719
2720 </a>
2721 </li>
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731 <li class="md-nav__item">
2732 <a href="../../wsc54/javascript/" class="md-nav__link">
2733
2734
2735 <span class="md-ellipsis">
2736 TypeScript and JavaScript
2737 </span>
2738
2739
2740 </a>
2741 </li>
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751 <li class="md-nav__item">
2752 <a href="../../wsc54/templates/" class="md-nav__link">
2753
2754
2755 <span class="md-ellipsis">
2756 Templates
2757 </span>
2758
2759
2760 </a>
2761 </li>
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771 <li class="md-nav__item">
2772 <a href="../../wsc54/libraries/" class="md-nav__link">
2773
2774
2775 <span class="md-ellipsis">
2776 Third Party Libraries
2777 </span>
2778
2779
2780 </a>
2781 </li>
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791 <li class="md-nav__item">
2792 <a href="../../wsc54/deprecations_removals/" class="md-nav__link">
2793
2794
2795 <span class="md-ellipsis">
2796 Deprecations and Removals
2797 </span>
2798
2799
2800 </a>
2801 </li>
2802
2803
2804
2805
2806 </ul>
2807 </nav>
2808
2809 </li>
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
2827
2828
2829
2830
2831 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" checked>
2832
2833
2834 <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2835
2836
2837 <span class="md-ellipsis">
2838 From WoltLab Suite 5.3
2839 </span>
2840
2841
2842 <span class="md-nav__icon md-icon"></span>
2843 </label>
2844
2845 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="true">
2846 <label class="md-nav__title" for="__nav_6_4">
2847 <span class="md-nav__icon md-icon"></span>
2848 From WoltLab Suite 5.3
2849 </label>
2850 <ul class="md-nav__list" data-md-scrollfix>
2851
2852
2853
2854
2855
2856
2857 <li class="md-nav__item">
2858 <a href="../php/" class="md-nav__link">
2859
2860
2861 <span class="md-ellipsis">
2862 PHP API
2863 </span>
2864
2865
2866 </a>
2867 </li>
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879 <li class="md-nav__item md-nav__item--active">
2880
2881 <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
2882
2883
2884
2885
2886
2887 <label class="md-nav__link md-nav__link--active" for="__toc">
2888
2889
2890 <span class="md-ellipsis">
2891 Session Handling and Authentication
2892 </span>
2893
2894
2895 <span class="md-nav__icon md-icon"></span>
2896 </label>
2897
2898 <a href="./" class="md-nav__link md-nav__link--active">
2899
2900
2901 <span class="md-ellipsis">
2902 Session Handling and Authentication
2903 </span>
2904
2905
2906 </a>
2907
2908
2909
2910 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2911
2912
2913
2914
2915
2916
2917 <label class="md-nav__title" for="__toc">
2918 <span class="md-nav__icon md-icon"></span>
2919 Table of contents
2920 </label>
2921 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2922
2923 <li class="md-nav__item">
2924 <a href="#summary-and-concepts" class="md-nav__link">
2925 Summary and Concepts
2926 </a>
2927
2928 <nav class="md-nav" aria-label="Summary and Concepts">
2929 <ul class="md-nav__list">
2930
2931 <li class="md-nav__item">
2932 <a href="#legacy-persistent-login" class="md-nav__link">
2933 Legacy Persistent Login
2934 </a>
2935
2936 </li>
2937
2938 <li class="md-nav__item">
2939 <a href="#multiple-sessions" class="md-nav__link">
2940 Multiple Sessions
2941 </a>
2942
2943 </li>
2944
2945 <li class="md-nav__item">
2946 <a href="#merged-acp-and-frontend-sessions" class="md-nav__link">
2947 Merged ACP and Frontend Sessions
2948 </a>
2949
2950 </li>
2951
2952 <li class="md-nav__item">
2953 <a href="#improved-authentication-and-reauthentication" class="md-nav__link">
2954 Improved Authentication and Reauthentication
2955 </a>
2956
2957 </li>
2958
2959 </ul>
2960 </nav>
2961
2962 </li>
2963
2964 <li class="md-nav__item">
2965 <a href="#additions-and-changes" class="md-nav__link">
2966 Additions and Changes
2967 </a>
2968
2969 <nav class="md-nav" aria-label="Additions and Changes">
2970 <ul class="md-nav__list">
2971
2972 <li class="md-nav__item">
2973 <a href="#password-hashing" class="md-nav__link">
2974 Password Hashing
2975 </a>
2976
2977 </li>
2978
2979 <li class="md-nav__item">
2980 <a href="#session-storage" class="md-nav__link">
2981 Session Storage
2982 </a>
2983
2984 </li>
2985
2986 <li class="md-nav__item">
2987 <a href="#reauthentication" class="md-nav__link">
2988 Reauthentication
2989 </a>
2990
2991 </li>
2992
2993 <li class="md-nav__item">
2994 <a href="#multi-factor-authentication" class="md-nav__link">
2995 Multi-factor Authentication
2996 </a>
2997
2998 <nav class="md-nav" aria-label="Multi-factor Authentication">
2999 <ul class="md-nav__list">
3000
3001 <li class="md-nav__item">
3002 <a href="#adding-multi-factor-methods" class="md-nav__link">
3003 Adding Multi-factor Methods
3004 </a>
3005
3006 </li>
3007
3008 <li class="md-nav__item">
3009 <a href="#enforcing-multi-factor-authentication" class="md-nav__link">
3010 Enforcing Multi-factor Authentication
3011 </a>
3012
3013 </li>
3014
3015 </ul>
3016 </nav>
3017
3018 </li>
3019
3020 </ul>
3021 </nav>
3022
3023 </li>
3024
3025 <li class="md-nav__item">
3026 <a href="#deprecations-and-removals" class="md-nav__link">
3027 Deprecations and Removals
3028 </a>
3029
3030 <nav class="md-nav" aria-label="Deprecations and Removals">
3031 <ul class="md-nav__list">
3032
3033 <li class="md-nav__item">
3034 <a href="#sessionhandler" class="md-nav__link">
3035 SessionHandler
3036 </a>
3037
3038 </li>
3039
3040 <li class="md-nav__item">
3041 <a href="#acp-sessions" class="md-nav__link">
3042 ACP Sessions
3043 </a>
3044
3045 </li>
3046
3047 <li class="md-nav__item">
3048 <a href="#cookies" class="md-nav__link">
3049 Cookies
3050 </a>
3051
3052 </li>
3053
3054 <li class="md-nav__item">
3055 <a href="#virtual-sessions" class="md-nav__link">
3056 Virtual Sessions
3057 </a>
3058
3059 </li>
3060
3061 <li class="md-nav__item">
3062 <a href="#security-token-constants" class="md-nav__link">
3063 Security Token Constants
3064 </a>
3065
3066 </li>
3067
3068 <li class="md-nav__item">
3069 <a href="#passwordutil-and-double-bcrypt-hashes" class="md-nav__link">
3070 PasswordUtil and Double BCrypt Hashes
3071 </a>
3072
3073 </li>
3074
3075 </ul>
3076 </nav>
3077
3078 </li>
3079
3080 </ul>
3081
3082 </nav>
3083
3084 </li>
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094 <li class="md-nav__item">
3095 <a href="../javascript/" class="md-nav__link">
3096
3097
3098 <span class="md-ellipsis">
3099 TypeScript and JavaScript
3100 </span>
3101
3102
3103 </a>
3104 </li>
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114 <li class="md-nav__item">
3115 <a href="../templates/" class="md-nav__link">
3116
3117
3118 <span class="md-ellipsis">
3119 Templates
3120 </span>
3121
3122
3123 </a>
3124 </li>
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134 <li class="md-nav__item">
3135 <a href="../libraries/" class="md-nav__link">
3136
3137
3138 <span class="md-ellipsis">
3139 Third Party Libraries
3140 </span>
3141
3142
3143 </a>
3144 </li>
3145
3146
3147
3148
3149 </ul>
3150 </nav>
3151
3152 </li>
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167 <li class="md-nav__item md-nav__item--nested">
3168
3169
3170
3171
3172 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
3173
3174
3175 <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
3176
3177
3178 <span class="md-ellipsis">
3179 From WoltLab Suite 5.2
3180 </span>
3181
3182
3183 <span class="md-nav__icon md-icon"></span>
3184 </label>
3185
3186 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
3187 <label class="md-nav__title" for="__nav_6_5">
3188 <span class="md-nav__icon md-icon"></span>
3189 From WoltLab Suite 5.2
3190 </label>
3191 <ul class="md-nav__list" data-md-scrollfix>
3192
3193
3194
3195
3196
3197
3198 <li class="md-nav__item">
3199 <a href="../../wsc52/php/" class="md-nav__link">
3200
3201
3202 <span class="md-ellipsis">
3203 PHP API
3204 </span>
3205
3206
3207 </a>
3208 </li>
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218 <li class="md-nav__item">
3219 <a href="../../wsc52/templates/" class="md-nav__link">
3220
3221
3222 <span class="md-ellipsis">
3223 Templates and Languages
3224 </span>
3225
3226
3227 </a>
3228 </li>
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238 <li class="md-nav__item">
3239 <a href="../../wsc52/libraries/" class="md-nav__link">
3240
3241
3242 <span class="md-ellipsis">
3243 Third Party Libraries
3244 </span>
3245
3246
3247 </a>
3248 </li>
3249
3250
3251
3252
3253 </ul>
3254 </nav>
3255
3256 </li>
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271 <li class="md-nav__item md-nav__item--nested">
3272
3273
3274
3275
3276 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
3277
3278
3279 <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
3280
3281
3282 <span class="md-ellipsis">
3283 From WoltLab Suite 3.1
3284 </span>
3285
3286
3287 <span class="md-nav__icon md-icon"></span>
3288 </label>
3289
3290 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
3291 <label class="md-nav__title" for="__nav_6_6">
3292 <span class="md-nav__icon md-icon"></span>
3293 From WoltLab Suite 3.1
3294 </label>
3295 <ul class="md-nav__list" data-md-scrollfix>
3296
3297
3298
3299
3300
3301
3302 <li class="md-nav__item">
3303 <a href="../../wsc31/php/" class="md-nav__link">
3304
3305
3306 <span class="md-ellipsis">
3307 PHP API
3308 </span>
3309
3310
3311 </a>
3312 </li>
3313
3314
3315
3316
3317 </ul>
3318 </nav>
3319
3320 </li>
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335 <li class="md-nav__item md-nav__item--nested">
3336
3337
3338
3339
3340 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
3341
3342
3343 <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
3344
3345
3346 <span class="md-ellipsis">
3347 From WoltLab Suite 3.0
3348 </span>
3349
3350
3351 <span class="md-nav__icon md-icon"></span>
3352 </label>
3353
3354 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
3355 <label class="md-nav__title" for="__nav_6_7">
3356 <span class="md-nav__icon md-icon"></span>
3357 From WoltLab Suite 3.0
3358 </label>
3359 <ul class="md-nav__list" data-md-scrollfix>
3360
3361
3362
3363
3364
3365
3366 <li class="md-nav__item">
3367 <a href="../../wsc30/php/" class="md-nav__link">
3368
3369
3370 <span class="md-ellipsis">
3371 PHP API
3372 </span>
3373
3374
3375 </a>
3376 </li>
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386 <li class="md-nav__item">
3387 <a href="../../wsc30/javascript/" class="md-nav__link">
3388
3389
3390 <span class="md-ellipsis">
3391 JavaScript API
3392 </span>
3393
3394
3395 </a>
3396 </li>
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406 <li class="md-nav__item">
3407 <a href="../../wsc30/templates/" class="md-nav__link">
3408
3409
3410 <span class="md-ellipsis">
3411 Templates
3412 </span>
3413
3414
3415 </a>
3416 </li>
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426 <li class="md-nav__item">
3427 <a href="../../wsc30/css/" class="md-nav__link">
3428
3429
3430 <span class="md-ellipsis">
3431 CSS
3432 </span>
3433
3434
3435 </a>
3436 </li>
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446 <li class="md-nav__item">
3447 <a href="../../wsc30/package/" class="md-nav__link">
3448
3449
3450 <span class="md-ellipsis">
3451 Package Components
3452 </span>
3453
3454
3455 </a>
3456 </li>
3457
3458
3459
3460
3461 </ul>
3462 </nav>
3463
3464 </li>
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479 <li class="md-nav__item md-nav__item--nested">
3480
3481
3482
3483
3484 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_8" >
3485
3486
3487 <label class="md-nav__link" for="__nav_6_8" id="__nav_6_8_label" tabindex="0">
3488
3489
3490 <span class="md-ellipsis">
3491 From WCF 2.1
3492 </span>
3493
3494
3495 <span class="md-nav__icon md-icon"></span>
3496 </label>
3497
3498 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_8_label" aria-expanded="false">
3499 <label class="md-nav__title" for="__nav_6_8">
3500 <span class="md-nav__icon md-icon"></span>
3501 From WCF 2.1
3502 </label>
3503 <ul class="md-nav__list" data-md-scrollfix>
3504
3505
3506
3507
3508
3509
3510 <li class="md-nav__item">
3511 <a href="../../wcf21/php/" class="md-nav__link">
3512
3513
3514 <span class="md-ellipsis">
3515 PHP API
3516 </span>
3517
3518
3519 </a>
3520 </li>
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530 <li class="md-nav__item">
3531 <a href="../../wcf21/templates/" class="md-nav__link">
3532
3533
3534 <span class="md-ellipsis">
3535 Templates
3536 </span>
3537
3538
3539 </a>
3540 </li>
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550 <li class="md-nav__item">
3551 <a href="../../wcf21/css/" class="md-nav__link">
3552
3553
3554 <span class="md-ellipsis">
3555 CSS
3556 </span>
3557
3558
3559 </a>
3560 </li>
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570 <li class="md-nav__item">
3571 <a href="../../wcf21/package/" class="md-nav__link">
3572
3573
3574 <span class="md-ellipsis">
3575 Package Components
3576 </span>
3577
3578
3579 </a>
3580 </li>
3581
3582
3583
3584
3585 </ul>
3586 </nav>
3587
3588 </li>
3589
3590
3591
3592
3593 </ul>
3594 </nav>
3595
3596 </li>
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610 <li class="md-nav__item md-nav__item--nested">
3611
3612
3613
3614
3615 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
3616
3617
3618 <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
3619
3620
3621 <span class="md-ellipsis">
3622 Tutorials
3623 </span>
3624
3625
3626 <span class="md-nav__icon md-icon"></span>
3627 </label>
3628
3629 <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
3630 <label class="md-nav__title" for="__nav_7">
3631 <span class="md-nav__icon md-icon"></span>
3632 Tutorials
3633 </label>
3634 <ul class="md-nav__list" data-md-scrollfix>
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646 <li class="md-nav__item md-nav__item--nested">
3647
3648
3649
3650
3651 <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
3652
3653
3654 <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
3655
3656
3657 <span class="md-ellipsis">
3658 Tutorial Series
3659 </span>
3660
3661
3662 <span class="md-nav__icon md-icon"></span>
3663 </label>
3664
3665 <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
3666 <label class="md-nav__title" for="__nav_7_1">
3667 <span class="md-nav__icon md-icon"></span>
3668 Tutorial Series
3669 </label>
3670 <ul class="md-nav__list" data-md-scrollfix>
3671
3672
3673
3674
3675
3676
3677 <li class="md-nav__item">
3678 <a href="../../../tutorial/series/overview/" class="md-nav__link">
3679
3680
3681 <span class="md-ellipsis">
3682 Overview
3683 </span>
3684
3685
3686 </a>
3687 </li>
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697 <li class="md-nav__item">
3698 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
3699
3700
3701 <span class="md-ellipsis">
3702 Part 1
3703 </span>
3704
3705
3706 </a>
3707 </li>
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717 <li class="md-nav__item">
3718 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
3719
3720
3721 <span class="md-ellipsis">
3722 Part 2
3723 </span>
3724
3725
3726 </a>
3727 </li>
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737 <li class="md-nav__item">
3738 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
3739
3740
3741 <span class="md-ellipsis">
3742 Part 3
3743 </span>
3744
3745
3746 </a>
3747 </li>
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757 <li class="md-nav__item">
3758 <a href="../../../tutorial/series/part_4/" class="md-nav__link">
3759
3760
3761 <span class="md-ellipsis">
3762 Part 4
3763 </span>
3764
3765
3766 </a>
3767 </li>
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777 <li class="md-nav__item">
3778 <a href="../../../tutorial/series/part_5/" class="md-nav__link">
3779
3780
3781 <span class="md-ellipsis">
3782 Part 5
3783 </span>
3784
3785
3786 </a>
3787 </li>
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797 <li class="md-nav__item">
3798 <a href="../../../tutorial/series/part_6/" class="md-nav__link">
3799
3800
3801 <span class="md-ellipsis">
3802 Part 6
3803 </span>
3804
3805
3806 </a>
3807 </li>
3808
3809
3810
3811
3812 </ul>
3813 </nav>
3814
3815 </li>
3816
3817
3818
3819
3820 </ul>
3821 </nav>
3822
3823 </li>
3824
3825
3826
3827 </ul>
3828 </nav>
3829 </div>
3830 </div>
3831 </div>
3832
3833
3834
3835 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
3836 <div class="md-sidebar__scrollwrap">
3837 <div class="md-sidebar__inner">
3838
3839
3840 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
3841
3842
3843
3844
3845
3846
3847 <label class="md-nav__title" for="__toc">
3848 <span class="md-nav__icon md-icon"></span>
3849 Table of contents
3850 </label>
3851 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
3852
3853 <li class="md-nav__item">
3854 <a href="#summary-and-concepts" class="md-nav__link">
3855 Summary and Concepts
3856 </a>
3857
3858 <nav class="md-nav" aria-label="Summary and Concepts">
3859 <ul class="md-nav__list">
3860
3861 <li class="md-nav__item">
3862 <a href="#legacy-persistent-login" class="md-nav__link">
3863 Legacy Persistent Login
3864 </a>
3865
3866 </li>
3867
3868 <li class="md-nav__item">
3869 <a href="#multiple-sessions" class="md-nav__link">
3870 Multiple Sessions
3871 </a>
3872
3873 </li>
3874
3875 <li class="md-nav__item">
3876 <a href="#merged-acp-and-frontend-sessions" class="md-nav__link">
3877 Merged ACP and Frontend Sessions
3878 </a>
3879
3880 </li>
3881
3882 <li class="md-nav__item">
3883 <a href="#improved-authentication-and-reauthentication" class="md-nav__link">
3884 Improved Authentication and Reauthentication
3885 </a>
3886
3887 </li>
3888
3889 </ul>
3890 </nav>
3891
3892 </li>
3893
3894 <li class="md-nav__item">
3895 <a href="#additions-and-changes" class="md-nav__link">
3896 Additions and Changes
3897 </a>
3898
3899 <nav class="md-nav" aria-label="Additions and Changes">
3900 <ul class="md-nav__list">
3901
3902 <li class="md-nav__item">
3903 <a href="#password-hashing" class="md-nav__link">
3904 Password Hashing
3905 </a>
3906
3907 </li>
3908
3909 <li class="md-nav__item">
3910 <a href="#session-storage" class="md-nav__link">
3911 Session Storage
3912 </a>
3913
3914 </li>
3915
3916 <li class="md-nav__item">
3917 <a href="#reauthentication" class="md-nav__link">
3918 Reauthentication
3919 </a>
3920
3921 </li>
3922
3923 <li class="md-nav__item">
3924 <a href="#multi-factor-authentication" class="md-nav__link">
3925 Multi-factor Authentication
3926 </a>
3927
3928 <nav class="md-nav" aria-label="Multi-factor Authentication">
3929 <ul class="md-nav__list">
3930
3931 <li class="md-nav__item">
3932 <a href="#adding-multi-factor-methods" class="md-nav__link">
3933 Adding Multi-factor Methods
3934 </a>
3935
3936 </li>
3937
3938 <li class="md-nav__item">
3939 <a href="#enforcing-multi-factor-authentication" class="md-nav__link">
3940 Enforcing Multi-factor Authentication
3941 </a>
3942
3943 </li>
3944
3945 </ul>
3946 </nav>
3947
3948 </li>
3949
3950 </ul>
3951 </nav>
3952
3953 </li>
3954
3955 <li class="md-nav__item">
3956 <a href="#deprecations-and-removals" class="md-nav__link">
3957 Deprecations and Removals
3958 </a>
3959
3960 <nav class="md-nav" aria-label="Deprecations and Removals">
3961 <ul class="md-nav__list">
3962
3963 <li class="md-nav__item">
3964 <a href="#sessionhandler" class="md-nav__link">
3965 SessionHandler
3966 </a>
3967
3968 </li>
3969
3970 <li class="md-nav__item">
3971 <a href="#acp-sessions" class="md-nav__link">
3972 ACP Sessions
3973 </a>
3974
3975 </li>
3976
3977 <li class="md-nav__item">
3978 <a href="#cookies" class="md-nav__link">
3979 Cookies
3980 </a>
3981
3982 </li>
3983
3984 <li class="md-nav__item">
3985 <a href="#virtual-sessions" class="md-nav__link">
3986 Virtual Sessions
3987 </a>
3988
3989 </li>
3990
3991 <li class="md-nav__item">
3992 <a href="#security-token-constants" class="md-nav__link">
3993 Security Token Constants
3994 </a>
3995
3996 </li>
3997
3998 <li class="md-nav__item">
3999 <a href="#passwordutil-and-double-bcrypt-hashes" class="md-nav__link">
4000 PasswordUtil and Double BCrypt Hashes
4001 </a>
4002
4003 </li>
4004
4005 </ul>
4006 </nav>
4007
4008 </li>
4009
4010 </ul>
4011
4012 </nav>
4013 </div>
4014 </div>
4015 </div>
4016
4017
4018
4019 <div class="md-content" data-md-component="content">
4020 <article class="md-content__inner md-typeset">
4021
4022
4023
4024
4025
4026
4027
4028 <h1 id="migrating-from-woltlab-suite-53-session-handling-and-authentication">Migrating from WoltLab Suite 5.3 - Session Handling and Authentication<a class="headerlink" href="#migrating-from-woltlab-suite-53-session-handling-and-authentication" title="Permanent link">#</a></h1>
4029 <p>WoltLab Suite 5.4 includes a completely refactored session handling.
4030 As long as you only interact with sessions via <code>WCF::getSession()</code>, especially when you perform read-only accesses, you should not notice any breaking changes.</p>
4031 <p>You might appreciate some of the new session methods if you process security sensitive data.</p>
4032 <h2 id="summary-and-concepts">Summary and Concepts<a class="headerlink" href="#summary-and-concepts" title="Permanent link">#</a></h2>
4033 <p>Most of the changes revolve around the removal of the legacy persistent login functionality and the assumption that every user has a single session only.
4034 Both aspects are related to each other.</p>
4035 <h3 id="legacy-persistent-login">Legacy Persistent Login<a class="headerlink" href="#legacy-persistent-login" title="Permanent link">#</a></h3>
4036 <p>The legacy persistent login was rather an automated login.
4037 Upon bootstrapping a session, it was checked whether the user had a cookie pair storing the user’s <code>userID</code> and (a single BCrypt hash of) the user’s password.
4038 If such a cookie pair exists and the BCrypt hash within the cookie matches the user’s password hash when hashed again, the session would immediately <code>changeUser()</code> to the respective user.</p>
4039 <p>This legacy persistent login was completely removed.
4040 Instead, any sessions that belong to an authenticated user will automatically be long-lived.
4041 These long-lived sessions expire no sooner than 14 days after the last activity, ensuring that the user continously stays logged in, provided that they visit the page at least once per fortnight.</p>
4042 <h3 id="multiple-sessions">Multiple Sessions<a class="headerlink" href="#multiple-sessions" title="Permanent link">#</a></h3>
4043 <p>To allow for a proper separation of these long-lived user sessions, WoltLab Suite now allows for multiple sessions per user.
4044 These sessions are completely unrelated to each other.
4045 Specifically, they do not share session variables and they expire independently.</p>
4046 <p>As the existing <code>wcf1_session</code> table is also used for the online lists and location tracking, it will be maintained on a best effort basis.
4047 It no longer stores any private session data.</p>
4048 <p>The actual sessions storing security sensitive information are in an unrelated location.
4049 They must only be accessed via the PHP API exposed by the <code>SessionHandler</code>.</p>
4050 <h3 id="merged-acp-and-frontend-sessions">Merged ACP and Frontend Sessions<a class="headerlink" href="#merged-acp-and-frontend-sessions" title="Permanent link">#</a></h3>
4051 <p>WoltLab Suite 5.4 shares a single session across both the frontend, as well as the ACP.
4052 When a user logs in to the frontend, they will also be logged into the ACP and vice versa.</p>
4053 <p>Actual access to the ACP is controlled via the new <a href="#reauthentication">reauthentication mechanism</a>.</p>
4054 <p>The session variable store is scoped:
4055 Session variables set within the frontend are not available within the ACP and vice versa.</p>
4056 <h3 id="improved-authentication-and-reauthentication">Improved Authentication and Reauthentication<a class="headerlink" href="#improved-authentication-and-reauthentication" title="Permanent link">#</a></h3>
4057 <p>WoltLab Suite 5.4 ships with multi-factor authentication support and a generic re-authentication implementation that can be used to verify the account owner’s presence.</p>
4058 <h2 id="additions-and-changes">Additions and Changes<a class="headerlink" href="#additions-and-changes" title="Permanent link">#</a></h2>
4059 <h3 id="password-hashing">Password Hashing<a class="headerlink" href="#password-hashing" title="Permanent link">#</a></h3>
4060 <p>WoltLab Suite 5.4 includes a new object-oriented password hashing framework that is modeled after PHP’s <code>password_*</code> API.
4061 Check <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/user/authentication/password/PasswordAlgorithmManager.class.php"><code>PasswordAlgorithmManager</code></a> and <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/user/authentication/password/IPasswordAlgorithm.class.php"><code>IPasswordAlgorithm</code></a> for details.</p>
4062 <p>The new default password hash is a standard BCrypt hash.
4063 All newly generated hashes in <code>wcf1_user.password</code> will now include a type prefix, instead of just passwords imported from other systems.</p>
4064 <h3 id="session-storage">Session Storage<a class="headerlink" href="#session-storage" title="Permanent link">#</a></h3>
4065 <p>The <code>wcf1_session</code> table will no longer be used for session storage.
4066 Instead, it is maintained for compatibility with existing online lists.</p>
4067 <p>The actual session storage is considered an implementation detail and you <em>must not</em> directly interact with the session tables.
4068 Future versions might support alternative session backends, such as Redis.</p>
4069 <div class="admonition warning">
4070 <p class="admonition-title">Do not interact directly with the session database tables but only via the <code>SessionHandler</code> class!</p>
4071 </div>
4072 <h3 id="reauthentication">Reauthentication<a class="headerlink" href="#reauthentication" title="Permanent link">#</a></h3>
4073 <p>For security sensitive processing, you might want to ensure that the account owner is actually present instead of a third party accessing a session that was accidentally left logged in.</p>
4074 <p>WoltLab Suite 5.4 ships with a generic reauthentication framework.
4075 To request reauthentication within your controller you need to:</p>
4076 <ol>
4077 <li>Use the <code>wcf\system\user\authentication\TReauthenticationCheck</code> trait.</li>
4078 <li>Call:
4079 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
4080 <span class="normal">2</span>
4081 <span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">requestReauthentication</span><span class="p">(</span><span class="nx">LinkHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getControllerLink</span><span class="p">(</span><span class="k">static</span><span class="o">::</span><span class="na">class</span><span class="p">,</span> <span class="p">[</span>
4082 <span class="cm">/* additional parameters */</span>
4083 <span class="p">]));</span>
4084 </code></pre></div></td></tr></table></div></li>
4085 </ol>
4086 <p><code>requestReauthentication()</code> will check if the user has recently authenticated themselves.
4087 If they did, the request proceeds as usual.
4088 Otherwise, they will be asked to reauthenticate themselves.
4089 After the successful authentication, they will be redirected to the URL that was passed as the first parameter (the current controller within the example).</p>
4090 <p>Details can be found in <a href="https://github.com/WoltLab/WCF/pull/3775">WoltLab/WCF#3775</a>.</p>
4091 <h3 id="multi-factor-authentication">Multi-factor Authentication<a class="headerlink" href="#multi-factor-authentication" title="Permanent link">#</a></h3>
4092 <p>To implement multi-factor authentication securely, WoltLab Suite 5.4 implements the concept of a “pending user change”.
4093 The user will not be logged in (i.e. <code>WCF::getUser()-&gt;userID</code> returns <code>null</code>) until they authenticate themselves with their second factor.</p>
4094 <p>Requesting multi-factor authentication is done on an opt-in basis for compatibility reasons.
4095 If you perform authentication yourself and do not trust the authentication source to perform multi-factor authentication itself, you will need to adjust your logic to request multi-factor authentication from WoltLab Suite:</p>
4096 <p>Previously:</p>
4097 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nx">WCF</span><span class="o">::</span><span class="na">getSession</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">changeUser</span><span class="p">(</span><span class="nv">$targetUser</span><span class="p">);</span>
4098 </code></pre></div></td></tr></table></div>
4099 <p>Now:</p>
4100 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
4101 <span class="normal"> 2</span>
4102 <span class="normal"> 3</span>
4103 <span class="normal"> 4</span>
4104 <span class="normal"> 5</span>
4105 <span class="normal"> 6</span>
4106 <span class="normal"> 7</span>
4107 <span class="normal"> 8</span>
4108 <span class="normal"> 9</span>
4109 <span class="normal">10</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nv">$isPending</span> <span class="o">=</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getSession</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">changeUserAfterMultifactorAuthentication</span><span class="p">(</span><span class="nv">$targetUser</span><span class="p">);</span>
4110 <span class="k">if</span> <span class="p">(</span><span class="nv">$isPending</span><span class="p">)</span> <span class="p">{</span>
4111 <span class="c1">// Redirect to the authentication form. The user will not be logged in.</span>
4112 <span class="c1">// Note: Do not use `getControllerLink` to support both the frontend as well as the ACP.</span>
4113 <span class="nx">HeaderUtil</span><span class="o">::</span><span class="na">redirect</span><span class="p">(</span><span class="nx">LinkHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="p">(</span><span class="s1">&#39;MultifactorAuthentication&#39;</span><span class="p">,</span> <span class="p">[</span>
4114 <span class="s1">&#39;url&#39;</span> <span class="o">=&gt;</span> <span class="cm">/* Return To */</span><span class="p">,</span>
4115 <span class="p">]));</span>
4116 <span class="k">exit</span><span class="p">;</span>
4117 <span class="p">}</span>
4118 <span class="c1">// Proceed as usual. The user will be logged in.</span>
4119 </code></pre></div></td></tr></table></div>
4120 <h4 id="adding-multi-factor-methods">Adding Multi-factor Methods<a class="headerlink" href="#adding-multi-factor-methods" title="Permanent link">#</a></h4>
4121 <p>Adding your own multi-factor method requires the implementation of a single object type:</p>
4122 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">objectType.xml</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
4123 <span class="normal">2</span>
4124 <span class="normal">3</span>
4125 <span class="normal">4</span>
4126 <span class="normal">5</span>
4127 <span class="normal">6</span>
4128 <span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nt">&lt;type&gt;</span>
4129 <span class="w"> </span><span class="nt">&lt;name&gt;</span>com.example.multifactor.foobar<span class="nt">&lt;/name&gt;</span>
4130 <span class="w"> </span><span class="nt">&lt;definitionname&gt;</span>com.woltlab.wcf.multifactor<span class="nt">&lt;/definitionname&gt;</span>
4131 <span class="w"> </span><span class="nt">&lt;icon&gt;</span><span class="cm">&lt;!-- Font Awesome 4 Icon Name goes here. --&gt;</span><span class="nt">&lt;/icon&gt;</span>
4132 <span class="w"> </span><span class="nt">&lt;priority&gt;</span><span class="cm">&lt;!-- Determines the sort order, higher priority will be preferred for authentication. --&gt;</span><span class="nt">&lt;/priority&gt;</span>
4133 <span class="w"> </span><span class="nt">&lt;classname&gt;</span>wcf\system\user\multifactor\FoobarMultifactorMethod<span class="nt">&lt;/classname&gt;</span>
4134 <span class="nt">&lt;/type&gt;</span>
4135 </code></pre></div></td></tr></table></div>
4136 <p>The given classname must implement the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/user/multifactor/IMultifactorMethod.class.php"><code>IMultifactorMethod</code></a> interface.</p>
4137 <p>As a self-contained example, you can find the initial implementation of the email multi-factor method in <a href="https://github.com/WoltLab/WCF/pull/3729">WoltLab/WCF#3729</a>.
4138 Please check <a href="https://github.com/WoltLab/WCF/commits/master/wcfsetup/install/files/lib/system/user/multifactor/EmailMultifactorMethod.class.php">the version history</a> of the PHP class to make sure you do not miss important changes that were added later.</p>
4139 <div class="admonition warning">
4140 <p class="admonition-title">Multi-factor authentication is security sensitive. Make sure to carefully read the remarks in <code>IMultifactorMethod</code> for possible issues. Also make sure to carefully test your implementation against all sorts of incorrect input and consider attack vectors such as race conditions. It is strongly recommended to generously check the current state by leveraging assertions and exceptions.</p>
4141 </div>
4142 <h4 id="enforcing-multi-factor-authentication">Enforcing Multi-factor Authentication<a class="headerlink" href="#enforcing-multi-factor-authentication" title="Permanent link">#</a></h4>
4143 <p>To enforce Multi-factor Authentication within your controller you need to:</p>
4144 <ol>
4145 <li>Use the <code>wcf\system\user\multifactor\TMultifactorRequirementEnforcer</code> trait.</li>
4146 <li>Call: <code>$this-&gt;enforceMultifactorAuthentication();</code></li>
4147 </ol>
4148 <p><code>enforceMultifactorAuthentication()</code> will check if the user is in a group that requires multi-factor authentication, but does not yet have multi-factor authentication enabled.
4149 If they did, the request proceeds as usual.
4150 Otherwise, a <code>NamedUserException</code> is thrown.</p>
4151 <h2 id="deprecations-and-removals">Deprecations and Removals<a class="headerlink" href="#deprecations-and-removals" title="Permanent link">#</a></h2>
4152 <h3 id="sessionhandler">SessionHandler<a class="headerlink" href="#sessionhandler" title="Permanent link">#</a></h3>
4153 <p>Most of the changes with regard to the new session handling happened in <code>SessionHandler</code>.
4154 Most notably, <code>SessionHandler</code> now is marked <code>final</code> to ensure proper encapsulation of data.</p>
4155 <p>A number of methods in <code>SessionHandler</code> are now deprecated and result in a noop.
4156 This change mostly affects methods that have been used to bootstrap the session, such as <code>setHasValidCookie()</code>.</p>
4157 <p>Additionally, accessing the following keys on the session is deprecated.
4158 They directly map to an existing method in another class and any uses can easily be updated:
4159 - <code>ipAddress</code>
4160 - <code>userAgent</code>
4161 - <code>requestURI</code>
4162 - <code>requestMethod</code>
4163 - <code>lastActivityTime</code></p>
4164 <p>Refer to <a href="https://github.com/WoltLab/WCF/blob/439de4963c947c3569a0c584f795245f693155b0/wcfsetup/install/files/lib/system/session/SessionHandler.class.php#L168-L178">the implementation</a> for details.</p>
4165 <h3 id="acp-sessions">ACP Sessions<a class="headerlink" href="#acp-sessions" title="Permanent link">#</a></h3>
4166 <p>The database tables related to ACP sessions have been removed.
4167 The PHP classes have been preserved due to being used within the class hierarchy of the legacy sessions.</p>
4168 <h3 id="cookies">Cookies<a class="headerlink" href="#cookies" title="Permanent link">#</a></h3>
4169 <p>The <code>_userID</code>, <code>_password</code>, <code>_cookieHash</code> and <code>_cookieHash_acp</code> cookies will no longer be created nor consumed.</p>
4170 <h3 id="virtual-sessions">Virtual Sessions<a class="headerlink" href="#virtual-sessions" title="Permanent link">#</a></h3>
4171 <p>The virtual session logic existed to support multiple devices per single session in <code>wcf1_session</code>.
4172 Virtual sessions are no longer required with the refactored session handling.</p>
4173 <p>Anything related to virtual sessions has been completely removed as they are considered an implementation detail.
4174 This removal includes PHP classes and database tables.</p>
4175 <h3 id="security-token-constants">Security Token Constants<a class="headerlink" href="#security-token-constants" title="Permanent link">#</a></h3>
4176 <p>The security token constants are deprecated.
4177 Instead, the methods of <code>SessionHandler</code> should be used (e.g. <code>-&gt;getSecurityToken()</code>).
4178 Within templates, you should migrate to the <code>{csrfToken}</code> tag in place of <code>{@SECURITY_TOKEN_INPUT_TAG}</code>.
4179 The <code>{csrfToken}</code> tag is a drop-in replacement and was backported to WoltLab Suite 5.2+, allowing you to maintain compatibility across a broad range of versions.</p>
4180 <h3 id="passwordutil-and-double-bcrypt-hashes">PasswordUtil and Double BCrypt Hashes<a class="headerlink" href="#passwordutil-and-double-bcrypt-hashes" title="Permanent link">#</a></h3>
4181 <p>Most of the methods in PasswordUtil are deprecated in favor of the new password hashing framework.</p>
4182
4183 <hr>
4184 <div class="md-source-file">
4185 <small>
4186
4187 Last update:
4188 2022-05-13
4189
4190 </small>
4191 </div>
4192
4193
4194
4195
4196
4197
4198 </article>
4199 </div>
4200
4201
4202 </div>
4203
4204 </main>
4205
4206 <footer class="md-footer">
4207
4208 <div class="md-footer-meta md-typeset">
4209 <div class="md-footer-meta__inner md-grid">
4210 <div class="md-copyright">
4211
4212 <div class="md-copyright__highlight">
4213 Copyright © 2020 WoltLab GmbH
4214 </div>
4215
4216
4217 Made with
4218 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
4219 Material for MkDocs
4220 </a>
4221
4222 </div>
4223
4224 <div class="md-copyright">
4225 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
4226 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
4227 </div>
4228
4229 </div>
4230 </div>
4231 </footer>
4232
4233 </div>
4234 <div class="md-dialog" data-md-component="dialog">
4235 <div class="md-dialog__inner md-typeset"></div>
4236 </div>
4237
4238 <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.a264c092.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>
4239
4240
4241 <script src="../../../assets/javascripts/bundle.726fbb30.min.js"></script>
4242
4243
4244 </body>
4245 </html>