3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
11 <link rel=
"canonical" href=
"https://docs.woltlab.com/6.0/php/gdpr/">
13 <link rel=
"icon" href=
"../../assets/default.favicon.ico">
14 <meta name=
"generator" content=
"mkdocs-1.3.1, mkdocs-material-8.4.2">
18 <title>GDPR - WoltLab Suite Documentation
</title>
22 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.69437709.min.css">
25 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.cbb835fc.min.css">
29 <meta name=
"theme-color" content=
"#009485">
39 <link rel=
"stylesheet" href=
"../../stylesheets/extra.css">
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>
55 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
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">
65 <a href=
"#general-data-protection-regulation-gdpr" class=
"md-skip">
70 <div data-md-component=
"announce">
72 <aside class=
"md-banner">
73 <div class=
"md-banner__inner md-grid md-typeset">
76 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
84 <div data-md-component=
"outdated" hidden
>
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">
95 <img src=
"../../assets/logo.png" alt=
"logo">
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>
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
108 <div class=
"md-header__topic" data-md-component=
"header-topic">
109 <span class=
"md-ellipsis">
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>
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>
132 <nav class=
"md-search__options" aria-label=
"Search">
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>
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">
146 <ol class=
"md-search-result__list"></ol>
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">
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>
160 <div class=
"md-source__repository">
170 <div class=
"md-container" data-md-component=
"container">
177 <main class=
"md-main" data-md-component=
"main">
178 <div class=
"md-main__inner md-grid">
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">
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">
192 <img src=
"../../assets/logo.png" alt=
"logo">
195 WoltLab Suite Documentation
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">
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>
204 <div class=
"md-source__repository">
210 <ul class=
"md-nav__list" data-md-scrollfix
>
219 <li class=
"md-nav__item">
220 <a href=
"../../getting-started/" class=
"md-nav__link">
237 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
240 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" checked
>
245 <label class=
"md-nav__link" for=
"__nav_2">
247 <span class=
"md-nav__icon md-icon"></span>
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>
255 <ul class=
"md-nav__list" data-md-scrollfix
>
262 <li class=
"md-nav__item">
263 <a href=
"../pages/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../database-objects/" class=
"md-nav__link">
290 <li class=
"md-nav__item">
291 <a href=
"../database-access/" class=
"md-nav__link">
304 <li class=
"md-nav__item">
305 <a href=
"../exceptions/" class=
"md-nav__link">
319 <li class=
"md-nav__item md-nav__item--nested">
322 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
327 <label class=
"md-nav__link" for=
"__nav_2_5">
329 <span class=
"md-nav__icon md-icon"></span>
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>
337 <ul class=
"md-nav__list" data-md-scrollfix
>
345 <li class=
"md-nav__item md-nav__item--nested">
348 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
353 <label class=
"md-nav__link" for=
"__nav_2_5_1">
355 <span class=
"md-nav__icon md-icon"></span>
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>
363 <ul class=
"md-nav__list" data-md-scrollfix
>
370 <li class=
"md-nav__item">
371 <a href=
"../api/caches/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../api/caches_persistent-caches/" class=
"md-nav__link">
398 <li class=
"md-nav__item">
399 <a href=
"../api/caches_runtime-caches/" class=
"md-nav__link">
419 <li class=
"md-nav__item">
420 <a href=
"../api/comments/" class=
"md-nav__link">
433 <li class=
"md-nav__item">
434 <a href=
"../api/cronjobs/" class=
"md-nav__link">
447 <li class=
"md-nav__item">
448 <a href=
"../api/events/" class=
"md-nav__link">
462 <li class=
"md-nav__item md-nav__item--nested">
465 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
470 <label class=
"md-nav__link" for=
"__nav_2_5_5">
472 <span class=
"md-nav__icon md-icon"></span>
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>
480 <ul class=
"md-nav__list" data-md-scrollfix
>
487 <li class=
"md-nav__item">
488 <a href=
"../api/form_builder/overview/" class=
"md-nav__link">
501 <li class=
"md-nav__item">
502 <a href=
"../api/form_builder/structure/" class=
"md-nav__link">
515 <li class=
"md-nav__item">
516 <a href=
"../api/form_builder/form_fields/" class=
"md-nav__link">
529 <li class=
"md-nav__item">
530 <a href=
"../api/form_builder/validation_data/" class=
"md-nav__link">
543 <li class=
"md-nav__item">
544 <a href=
"../api/form_builder/dependencies/" class=
"md-nav__link">
564 <li class=
"md-nav__item">
565 <a href=
"../api/package_installation_plugins/" class=
"md-nav__link">
566 Package Installation Plugins
578 <li class=
"md-nav__item">
579 <a href=
"../api/user_activity_points/" class=
"md-nav__link">
592 <li class=
"md-nav__item">
593 <a href=
"../api/user_notifications/" class=
"md-nav__link">
606 <li class=
"md-nav__item">
607 <a href=
"../api/sitemaps/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../code-style/" class=
"md-nav__link">
641 <li class=
"md-nav__item">
642 <a href=
"../apps/" class=
"md-nav__link">
657 <li class=
"md-nav__item md-nav__item--active">
659 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
665 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
667 <span class=
"md-nav__icon md-icon"></span>
670 <a href=
"./" class=
"md-nav__link md-nav__link--active">
676 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
683 <label class=
"md-nav__title" for=
"__toc">
684 <span class=
"md-nav__icon md-icon"></span>
687 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
689 <li class=
"md-nav__item">
690 <a href=
"#introduction" class=
"md-nav__link">
696 <li class=
"md-nav__item">
697 <a href=
"#including-data-in-the-export" class=
"md-nav__link">
698 Including Data in the Export
701 <nav class=
"md-nav" aria-label=
"Including Data in the Export">
702 <ul class=
"md-nav__list">
704 <li class=
"md-nav__item">
705 <a href=
"#example-code" class=
"md-nav__link">
711 <li class=
"md-nav__item">
712 <a href=
"#data" class=
"md-nav__link">
718 <li class=
"md-nav__item">
719 <a href=
"#exportuserproperties" class=
"md-nav__link">
720 $exportUserProperties
725 <li class=
"md-nav__item">
726 <a href=
"#exportuserpropertiesifnotempty" class=
"md-nav__link">
727 $exportUserPropertiesIfNotEmpty
732 <li class=
"md-nav__item">
733 <a href=
"#exportuseroptionsettings" class=
"md-nav__link">
734 $exportUserOptionSettings
739 <li class=
"md-nav__item">
740 <a href=
"#exportuseroptionsettingsifnotempty" class=
"md-nav__link">
741 $exportUserOptionSettingsIfNotEmpty
746 <li class=
"md-nav__item">
747 <a href=
"#ipaddresses" class=
"md-nav__link">
753 <li class=
"md-nav__item">
754 <a href=
"#skipuseroptions" class=
"md-nav__link">
788 <li class=
"md-nav__item md-nav__item--nested">
791 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
796 <label class=
"md-nav__link" for=
"__nav_3">
797 Languages, Templates & CSS
798 <span class=
"md-nav__icon md-icon"></span>
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
806 <ul class=
"md-nav__list" data-md-scrollfix
>
813 <li class=
"md-nav__item">
814 <a href=
"../../view/languages/" class=
"md-nav__link">
827 <li class=
"md-nav__item">
828 <a href=
"../../view/templates/" class=
"md-nav__link">
841 <li class=
"md-nav__item">
842 <a href=
"../../view/template-plugins/" class=
"md-nav__link">
855 <li class=
"md-nav__item">
856 <a href=
"../../view/css/" class=
"md-nav__link">
878 <li class=
"md-nav__item md-nav__item--nested">
881 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
886 <label class=
"md-nav__link" for=
"__nav_4">
887 TypeScript and JavaScript API
888 <span class=
"md-nav__icon md-icon"></span>
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
896 <ul class=
"md-nav__list" data-md-scrollfix
>
903 <li class=
"md-nav__item">
904 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
917 <li class=
"md-nav__item">
918 <a href=
"../../javascript/typescript/" class=
"md-nav__link">
932 <li class=
"md-nav__item md-nav__item--nested">
935 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
940 <label class=
"md-nav__link" for=
"__nav_4_3">
942 <span class=
"md-nav__icon md-icon"></span>
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>
950 <ul class=
"md-nav__list" data-md-scrollfix
>
957 <li class=
"md-nav__item">
958 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
971 <li class=
"md-nav__item">
972 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
985 <li class=
"md-nav__item">
986 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
999 <li class=
"md-nav__item">
1000 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
1013 <li class=
"md-nav__item">
1014 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
1027 <li class=
"md-nav__item">
1028 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
1041 <li class=
"md-nav__item">
1042 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
1055 <li class=
"md-nav__item">
1056 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
1057 Browser and Screen Sizes
1069 <li class=
"md-nav__item">
1070 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
1090 <li class=
"md-nav__item">
1091 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
1104 <li class=
"md-nav__item">
1105 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
1118 <li class=
"md-nav__item">
1119 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
1141 <li class=
"md-nav__item md-nav__item--nested">
1144 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1149 <label class=
"md-nav__link" for=
"__nav_5">
1151 <span class=
"md-nav__icon md-icon"></span>
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>
1159 <ul class=
"md-nav__list" data-md-scrollfix
>
1166 <li class=
"md-nav__item">
1167 <a href=
"../../package/package-xml/" class=
"md-nav__link">
1181 <li class=
"md-nav__item md-nav__item--nested">
1184 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1189 <label class=
"md-nav__link" for=
"__nav_5_2">
1191 <span class=
"md-nav__icon md-icon"></span>
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>
1199 <ul class=
"md-nav__list" data-md-scrollfix
>
1206 <li class=
"md-nav__item">
1207 <a href=
"../../package/pip/" class=
"md-nav__link">
1220 <li class=
"md-nav__item">
1221 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1234 <li class=
"md-nav__item">
1235 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1248 <li class=
"md-nav__item">
1249 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1262 <li class=
"md-nav__item">
1263 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1276 <li class=
"md-nav__item">
1277 <a href=
"../../package/pip/acp-template-delete/" class=
"md-nav__link">
1290 <li class=
"md-nav__item">
1291 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1304 <li class=
"md-nav__item">
1305 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1318 <li class=
"md-nav__item">
1319 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1332 <li class=
"md-nav__item">
1333 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1346 <li class=
"md-nav__item">
1347 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1360 <li class=
"md-nav__item">
1361 <a href=
"../../package/pip/database/" class=
"md-nav__link">
1374 <li class=
"md-nav__item">
1375 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1388 <li class=
"md-nav__item">
1389 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1402 <li class=
"md-nav__item">
1403 <a href=
"../../package/pip/file-delete/" class=
"md-nav__link">
1416 <li class=
"md-nav__item">
1417 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1430 <li class=
"md-nav__item">
1431 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1444 <li class=
"md-nav__item">
1445 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1458 <li class=
"md-nav__item">
1459 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1472 <li class=
"md-nav__item">
1473 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1486 <li class=
"md-nav__item">
1487 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1488 objectTypeDefinition
1500 <li class=
"md-nav__item">
1501 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1514 <li class=
"md-nav__item">
1515 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1528 <li class=
"md-nav__item">
1529 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1542 <li class=
"md-nav__item">
1543 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1556 <li class=
"md-nav__item">
1557 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1570 <li class=
"md-nav__item">
1571 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1584 <li class=
"md-nav__item">
1585 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1598 <li class=
"md-nav__item">
1599 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1612 <li class=
"md-nav__item">
1613 <a href=
"../../package/pip/template-delete/" class=
"md-nav__link">
1626 <li class=
"md-nav__item">
1627 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1640 <li class=
"md-nav__item">
1641 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1654 <li class=
"md-nav__item">
1655 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1668 <li class=
"md-nav__item">
1669 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1670 userNotificationEvent
1682 <li class=
"md-nav__item">
1683 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1696 <li class=
"md-nav__item">
1697 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1717 <li class=
"md-nav__item">
1718 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1740 <li class=
"md-nav__item md-nav__item--nested">
1743 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1748 <label class=
"md-nav__link" for=
"__nav_6">
1750 <span class=
"md-nav__icon md-icon"></span>
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>
1758 <ul class=
"md-nav__list" data-md-scrollfix
>
1766 <li class=
"md-nav__item md-nav__item--nested">
1769 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
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>
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
1784 <ul class=
"md-nav__list" data-md-scrollfix
>
1791 <li class=
"md-nav__item">
1792 <a href=
"../../migration/wsc55/php/" class=
"md-nav__link">
1805 <li class=
"md-nav__item">
1806 <a href=
"../../migration/wsc55/javascript/" class=
"md-nav__link">
1807 TypeScript and JavaScript
1819 <li class=
"md-nav__item">
1820 <a href=
"../../migration/wsc55/templates/" class=
"md-nav__link">
1833 <li class=
"md-nav__item">
1834 <a href=
"../../migration/wsc55/libraries/" class=
"md-nav__link">
1835 Third Party Libraries
1847 <li class=
"md-nav__item">
1848 <a href=
"../../migration/wsc55/deprecations_removals/" class=
"md-nav__link">
1849 Deprecations and Removals
1869 <li class=
"md-nav__item md-nav__item--nested">
1872 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
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>
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
1887 <ul class=
"md-nav__list" data-md-scrollfix
>
1894 <li class=
"md-nav__item">
1895 <a href=
"../../migration/wsc54/php/" class=
"md-nav__link">
1908 <li class=
"md-nav__item">
1909 <a href=
"../../migration/wsc54/javascript/" class=
"md-nav__link">
1910 TypeScript and JavaScript
1922 <li class=
"md-nav__item">
1923 <a href=
"../../migration/wsc54/templates/" class=
"md-nav__link">
1936 <li class=
"md-nav__item">
1937 <a href=
"../../migration/wsc54/libraries/" class=
"md-nav__link">
1938 Third Party Libraries
1950 <li class=
"md-nav__item">
1951 <a href=
"../../migration/wsc54/deprecations_removals/" class=
"md-nav__link">
1952 Deprecations and Removals
1972 <li class=
"md-nav__item md-nav__item--nested">
1975 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
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>
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
1990 <ul class=
"md-nav__list" data-md-scrollfix
>
1997 <li class=
"md-nav__item">
1998 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
2011 <li class=
"md-nav__item">
2012 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
2013 Session Handling and Authentication
2025 <li class=
"md-nav__item">
2026 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
2027 TypeScript and JavaScript
2039 <li class=
"md-nav__item">
2040 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
2053 <li class=
"md-nav__item">
2054 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
2055 Third Party Libraries
2075 <li class=
"md-nav__item md-nav__item--nested">
2078 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
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>
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
2093 <ul class=
"md-nav__list" data-md-scrollfix
>
2100 <li class=
"md-nav__item">
2101 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
2114 <li class=
"md-nav__item">
2115 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
2116 Templates and Languages
2128 <li class=
"md-nav__item">
2129 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
2130 Third Party Libraries
2150 <li class=
"md-nav__item md-nav__item--nested">
2153 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
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>
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
2168 <ul class=
"md-nav__list" data-md-scrollfix
>
2175 <li class=
"md-nav__item">
2176 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
2197 <li class=
"md-nav__item md-nav__item--nested">
2200 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_6" type=
"checkbox" id=
"__nav_6_6" >
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>
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
2215 <ul class=
"md-nav__list" data-md-scrollfix
>
2222 <li class=
"md-nav__item">
2223 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
2236 <li class=
"md-nav__item">
2237 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
2250 <li class=
"md-nav__item">
2251 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
2264 <li class=
"md-nav__item">
2265 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
2278 <li class=
"md-nav__item">
2279 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
2300 <li class=
"md-nav__item md-nav__item--nested">
2303 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_7" type=
"checkbox" id=
"__nav_6_7" >
2308 <label class=
"md-nav__link" for=
"__nav_6_7">
2310 <span class=
"md-nav__icon md-icon"></span>
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>
2318 <ul class=
"md-nav__list" data-md-scrollfix
>
2325 <li class=
"md-nav__item">
2326 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
2339 <li class=
"md-nav__item">
2340 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
2353 <li class=
"md-nav__item">
2354 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
2367 <li class=
"md-nav__item">
2368 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
2397 <li class=
"md-nav__item md-nav__item--nested">
2400 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
2405 <label class=
"md-nav__link" for=
"__nav_7">
2407 <span class=
"md-nav__icon md-icon"></span>
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>
2415 <ul class=
"md-nav__list" data-md-scrollfix
>
2423 <li class=
"md-nav__item md-nav__item--nested">
2426 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
2431 <label class=
"md-nav__link" for=
"__nav_7_1">
2433 <span class=
"md-nav__icon md-icon"></span>
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>
2441 <ul class=
"md-nav__list" data-md-scrollfix
>
2448 <li class=
"md-nav__item">
2449 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
2462 <li class=
"md-nav__item">
2463 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
2476 <li class=
"md-nav__item">
2477 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
2490 <li class=
"md-nav__item">
2491 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
2504 <li class=
"md-nav__item">
2505 <a href=
"../../tutorial/series/part_4/" class=
"md-nav__link">
2518 <li class=
"md-nav__item">
2519 <a href=
"../../tutorial/series/part_5/" class=
"md-nav__link">
2532 <li class=
"md-nav__item">
2533 <a href=
"../../tutorial/series/part_6/" class=
"md-nav__link">
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">
2567 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2574 <label class=
"md-nav__title" for=
"__toc">
2575 <span class=
"md-nav__icon md-icon"></span>
2578 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2580 <li class=
"md-nav__item">
2581 <a href=
"#introduction" class=
"md-nav__link">
2587 <li class=
"md-nav__item">
2588 <a href=
"#including-data-in-the-export" class=
"md-nav__link">
2589 Including Data in the Export
2592 <nav class=
"md-nav" aria-label=
"Including Data in the Export">
2593 <ul class=
"md-nav__list">
2595 <li class=
"md-nav__item">
2596 <a href=
"#example-code" class=
"md-nav__link">
2602 <li class=
"md-nav__item">
2603 <a href=
"#data" class=
"md-nav__link">
2609 <li class=
"md-nav__item">
2610 <a href=
"#exportuserproperties" class=
"md-nav__link">
2611 $exportUserProperties
2616 <li class=
"md-nav__item">
2617 <a href=
"#exportuserpropertiesifnotempty" class=
"md-nav__link">
2618 $exportUserPropertiesIfNotEmpty
2623 <li class=
"md-nav__item">
2624 <a href=
"#exportuseroptionsettings" class=
"md-nav__link">
2625 $exportUserOptionSettings
2630 <li class=
"md-nav__item">
2631 <a href=
"#exportuseroptionsettingsifnotempty" class=
"md-nav__link">
2632 $exportUserOptionSettingsIfNotEmpty
2637 <li class=
"md-nav__item">
2638 <a href=
"#ipaddresses" class=
"md-nav__link">
2644 <li class=
"md-nav__item">
2645 <a href=
"#skipuseroptions" class=
"md-nav__link">
2664 <div class=
"md-content" data-md-component=
"content">
2665 <article class=
"md-content__inner md-typeset">
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>
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>
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"><?
</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>
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">&</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">-
></span><span class=
"na">user
</span><span class=
"p">;
</span>
2719 <span class=
"nv">$eventObj
</span><span class=
"o">-
></span><span class=
"na">data
</span><span class=
"p">[
</span><span class=
"s1">'my.fancy.plugin
'</span><span class=
"p">]
</span> <span class=
"o">=
</span> <span class=
"p">[
</span>
2720 <span class=
"s1">'superPersonalData
'</span> <span class=
"o">=
></span> <span class=
"s2">"This text is super personal and should be included in the output
"</span><span class=
"p">,
</span>
2721 <span class=
"s1">'weirdIpAddresses
'</span> <span class=
"o">=
></span> <span class=
"nv">$eventObj
</span><span class=
"o">-
></span><span class=
"na">exportIpAddresses
</span><span class=
"p">(
</span><span class=
"s1">'app
'</span><span class=
"o">.
</span><span class=
"nx">WCF_N
</span><span class=
"o">.
</span><span class=
"s1">'_non_standard_column_names_for_ip_addresses
'</span><span class=
"p">,
</span> <span class=
"s1">'ipAddressColumnName
'</span><span class=
"p">,
</span> <span class=
"s1">'timeColumnName
'</span><span class=
"p">,
</span> <span class=
"s1">'userIDColumnName
'</span><span class=
"p">)
</span>
2722 <span class=
"p">];
</span>
2723 <span class=
"nv">$eventObj
</span><span class=
"o">-
></span><span class=
"na">exportUserProperties
</span><span class=
"p">[]
</span> <span class=
"o">=
</span> <span class=
"s1">'shouldAlwaysExportThisField
'</span><span class=
"p">;
</span>
2724 <span class=
"nv">$eventObj
</span><span class=
"o">-
></span><span class=
"na">exportUserPropertiesIfNotEmpty
</span><span class=
"p">[]
</span> <span class=
"o">=
</span> <span class=
"s1">'myFancyField
'</span><span class=
"p">;
</span>
2725 <span class=
"nv">$eventObj
</span><span class=
"o">-
></span><span class=
"na">exportUserOptionSettings
</span><span class=
"p">[]
</span> <span class=
"o">=
</span> <span class=
"s1">'thisSettingIsAlwaysExported
'</span><span class=
"p">;
</span>
2726 <span class=
"nv">$eventObj
</span><span class=
"o">-
></span><span class=
"na">exportUserOptionSettingsIfNotEmpty
</span><span class=
"p">[]
</span> <span class=
"o">=
</span> <span class=
"s1">'someSettingContainingPersonalData
'</span><span class=
"p">;
</span>
2727 <span class=
"nv">$eventObj
</span><span class=
"o">-
></span><span class=
"na">ipAddresses
</span><span class=
"p">[
</span><span class=
"s1">'my.fancy.plugin
'</span><span class=
"p">]
</span> <span class=
"o">=
</span> <span class=
"p">[
</span><span class=
"s1">'wcf
'</span><span class=
"o">.
</span><span class=
"nx">WCF_N
</span><span class=
"o">.
</span><span class=
"s1">'_my_fancy_table
'</span><span class=
"p">,
</span> <span class=
"s1">'wcf
'</span><span class=
"o">.
</span><span class=
"nx">WCF_N
</span><span class=
"o">.
</span><span class=
"s1">'_i_also_store_ipaddresses_here
'</span><span class=
"p">];
</span>
2728 <span class=
"nv">$eventObj
</span><span class=
"o">-
></span><span class=
"na">skipUserOptions
</span><span class=
"p">[]
</span> <span class=
"o">=
</span> <span class=
"s1">'thisLooksLikePersonalDataButItIsNot
'</span><span class=
"p">;
</span>
2729 <span class=
"nv">$eventObj
</span><span class=
"o">-
></span><span class=
"na">skipUserOptions
</span><span class=
"p">[]
</span> <span class=
"o">=
</span> <span class=
"s1">'thisIsAlsoNotPersonalDataPleaseIgnoreIt
'</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
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
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>
2774 <div class=
"md-source-file">
2794 <footer class=
"md-footer">
2797 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer" >
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>
2804 <div class=
"md-footer__title">
2805 <div class=
"md-ellipsis">
2806 <span class=
"md-footer__direction">
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">
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>
2832 <div class=
"md-footer-meta md-typeset">
2833 <div class=
"md-footer-meta__inner md-grid">
2834 <div class=
"md-copyright">
2836 <div class=
"md-copyright__highlight">
2837 Copyright ©
2020 WoltLab GmbH
2842 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
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>
2858 <div class=
"md-dialog" data-md-component=
"dialog">
2859 <div class=
"md-dialog__inner md-typeset"></div>
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>
2865 <script src=
"../../assets/javascripts/bundle.9c69f0bc.min.js"></script>