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