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