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/migration/wsc53/php/">
14 <link rel=
"prev" href=
"../../wsc54/deprecations_removals/">
17 <link rel=
"next" href=
"../session/">
19 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
20 <meta name=
"generator" content=
"mkdocs-1.5.2, mkdocs-material-9.1.21">
24 <title>PHP API - WoltLab Suite Documentation
</title>
28 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.eebd395e.min.css">
31 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ecc896b0.min.css">
41 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
43 <script>__md_scope=new URL(
"../../..",location),__md_hash=e=
>[...e].reduce((e,_)=
>(e<
<5)-e+_.charCodeAt(
0),
0),__md_get=(e,_=localStorage,t=__md_scope)=
>JSON.parse(_.getItem(t.pathname+
"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=
>{try{t.setItem(a.pathname+
"."+e,JSON.stringify(_))}catch(e){}}
</script>
58 <body dir=
"ltr" data-md-color-scheme=
"default" data-md-color-primary=
"teal" data-md-color-accent=
"indigo">
62 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
63 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
64 <label class=
"md-overlay" for=
"__drawer"></label>
65 <div data-md-component=
"skip">
68 <a href=
"#migrating-from-woltlab-suite-53-php" class=
"md-skip">
73 <div data-md-component=
"announce">
75 <aside class=
"md-banner">
76 <div class=
"md-banner__inner md-grid md-typeset">
79 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
87 <div data-md-color-scheme=
"default" data-md-component=
"outdated" hidden
>
96 <header class=
"md-header md-header--shadow" data-md-component=
"header">
97 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
98 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
100 <img src=
"../../../assets/logo.png" alt=
"logo">
103 <label class=
"md-header__button md-icon" for=
"__drawer">
104 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
106 <div class=
"md-header__title" data-md-component=
"header-title">
107 <div class=
"md-header__ellipsis">
108 <div class=
"md-header__topic">
109 <span class=
"md-ellipsis">
110 WoltLab Suite Documentation
113 <div class=
"md-header__topic" data-md-component=
"header-topic">
114 <span class=
"md-ellipsis">
127 <label class=
"md-header__button md-icon" for=
"__search">
128 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
130 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
131 <label class=
"md-search__overlay" for=
"__search"></label>
132 <div class=
"md-search__inner" role=
"search">
133 <form class=
"md-search__form" name=
"search">
134 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" required
>
135 <label class=
"md-search__icon md-icon" for=
"__search">
136 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
137 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
139 <nav class=
"md-search__options" aria-label=
"Search">
141 <button type=
"reset" class=
"md-search__icon md-icon" title=
"Clear" aria-label=
"Clear" tabindex=
"-1">
142 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
147 <div class=
"md-search__output">
148 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
149 <div class=
"md-search-result" data-md-component=
"search-result">
150 <div class=
"md-search-result__meta">
153 <ol class=
"md-search-result__list" role=
"presentation"></ol>
161 <div class=
"md-header__source">
162 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
163 <div class=
"md-source__icon md-icon">
165 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
167 <div class=
"md-source__repository">
177 <div class=
"md-container" data-md-component=
"container">
184 <main class=
"md-main" data-md-component=
"main">
185 <div class=
"md-main__inner md-grid">
189 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
190 <div class=
"md-sidebar__scrollwrap">
191 <div class=
"md-sidebar__inner">
195 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
196 <label class=
"md-nav__title" for=
"__drawer">
197 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
199 <img src=
"../../../assets/logo.png" alt=
"logo">
202 WoltLab Suite Documentation
205 <div class=
"md-nav__source">
206 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
207 <div class=
"md-source__icon md-icon">
209 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
211 <div class=
"md-source__repository">
217 <ul class=
"md-nav__list" data-md-scrollfix
>
226 <li class=
"md-nav__item">
227 <a href=
"../../../getting-started/" class=
"md-nav__link">
242 <li class=
"md-nav__item md-nav__item--nested">
247 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2" >
251 <label class=
"md-nav__link" for=
"__nav_2" id=
"__nav_2_label" tabindex=
"0">
253 <span class=
"md-nav__icon md-icon"></span>
256 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_2_label" aria-expanded=
"false">
257 <label class=
"md-nav__title" for=
"__nav_2">
258 <span class=
"md-nav__icon md-icon"></span>
261 <ul class=
"md-nav__list" data-md-scrollfix
>
268 <li class=
"md-nav__item">
269 <a href=
"../../../php/pages/" class=
"md-nav__link">
282 <li class=
"md-nav__item">
283 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
296 <li class=
"md-nav__item">
297 <a href=
"../../../php/database-access/" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
325 <li class=
"md-nav__item md-nav__item--nested">
330 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5" >
334 <label class=
"md-nav__link" for=
"__nav_2_5" id=
"__nav_2_5_label" tabindex=
"0">
336 <span class=
"md-nav__icon md-icon"></span>
339 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_2_5_label" aria-expanded=
"false">
340 <label class=
"md-nav__title" for=
"__nav_2_5">
341 <span class=
"md-nav__icon md-icon"></span>
344 <ul class=
"md-nav__list" data-md-scrollfix
>
352 <li class=
"md-nav__item md-nav__item--nested">
357 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5_1" >
361 <label class=
"md-nav__link" for=
"__nav_2_5_1" id=
"__nav_2_5_1_label" tabindex=
"0">
363 <span class=
"md-nav__icon md-icon"></span>
366 <nav class=
"md-nav" data-md-level=
"3" aria-labelledby=
"__nav_2_5_1_label" aria-expanded=
"false">
367 <label class=
"md-nav__title" for=
"__nav_2_5_1">
368 <span class=
"md-nav__icon md-icon"></span>
371 <ul class=
"md-nav__list" data-md-scrollfix
>
378 <li class=
"md-nav__item">
379 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
392 <li class=
"md-nav__item">
393 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
406 <li class=
"md-nav__item">
407 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
427 <li class=
"md-nav__item">
428 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
455 <li class=
"md-nav__item">
456 <a href=
"../../../php/api/events/" class=
"md-nav__link">
470 <li class=
"md-nav__item md-nav__item--nested">
475 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5_5" >
479 <label class=
"md-nav__link" for=
"__nav_2_5_5" id=
"__nav_2_5_5_label" tabindex=
"0">
481 <span class=
"md-nav__icon md-icon"></span>
484 <nav class=
"md-nav" data-md-level=
"3" aria-labelledby=
"__nav_2_5_5_label" aria-expanded=
"false">
485 <label class=
"md-nav__title" for=
"__nav_2_5_5">
486 <span class=
"md-nav__icon md-icon"></span>
489 <ul class=
"md-nav__list" data-md-scrollfix
>
496 <li class=
"md-nav__item">
497 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
510 <li class=
"md-nav__item">
511 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
524 <li class=
"md-nav__item">
525 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
538 <li class=
"md-nav__item">
539 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
552 <li class=
"md-nav__item">
553 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
575 Package Installation Plugins
587 <li class=
"md-nav__item">
588 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
601 <li class=
"md-nav__item">
602 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
615 <li class=
"md-nav__item">
616 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
636 <li class=
"md-nav__item">
637 <a href=
"../../../php/code-style/" class=
"md-nav__link">
650 <li class=
"md-nav__item">
651 <a href=
"../../../php/apps/" class=
"md-nav__link">
664 <li class=
"md-nav__item">
665 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
687 <li class=
"md-nav__item md-nav__item--nested">
692 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_3" >
696 <label class=
"md-nav__link" for=
"__nav_3" id=
"__nav_3_label" tabindex=
"0">
697 Languages, Templates & CSS
698 <span class=
"md-nav__icon md-icon"></span>
701 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_3_label" aria-expanded=
"false">
702 <label class=
"md-nav__title" for=
"__nav_3">
703 <span class=
"md-nav__icon md-icon"></span>
704 Languages, Templates & CSS
706 <ul class=
"md-nav__list" data-md-scrollfix
>
713 <li class=
"md-nav__item">
714 <a href=
"../../../view/languages/" class=
"md-nav__link">
727 <li class=
"md-nav__item">
728 <a href=
"../../../view/templates/" class=
"md-nav__link">
741 <li class=
"md-nav__item">
742 <a href=
"../../../view/template-modifiers/" class=
"md-nav__link">
755 <li class=
"md-nav__item">
756 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
769 <li class=
"md-nav__item">
770 <a href=
"../../../view/css/" class=
"md-nav__link">
792 <li class=
"md-nav__item md-nav__item--nested">
797 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4" >
801 <label class=
"md-nav__link" for=
"__nav_4" id=
"__nav_4_label" tabindex=
"0">
802 TypeScript and JavaScript API
803 <span class=
"md-nav__icon md-icon"></span>
806 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_4_label" aria-expanded=
"false">
807 <label class=
"md-nav__title" for=
"__nav_4">
808 <span class=
"md-nav__icon md-icon"></span>
809 TypeScript and JavaScript API
811 <ul class=
"md-nav__list" data-md-scrollfix
>
818 <li class=
"md-nav__item">
819 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
832 <li class=
"md-nav__item">
833 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
847 <li class=
"md-nav__item md-nav__item--nested">
852 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4_3" >
856 <label class=
"md-nav__link" for=
"__nav_4_3" id=
"__nav_4_3_label" tabindex=
"0">
858 <span class=
"md-nav__icon md-icon"></span>
861 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_4_3_label" aria-expanded=
"false">
862 <label class=
"md-nav__title" for=
"__nav_4_3">
863 <span class=
"md-nav__icon md-icon"></span>
866 <ul class=
"md-nav__list" data-md-scrollfix
>
873 <li class=
"md-nav__item">
874 <a href=
"../../../javascript/components_ckeditor5/" class=
"md-nav__link">
887 <li class=
"md-nav__item">
888 <a href=
"../../../javascript/components_confirmation/" class=
"md-nav__link">
901 <li class=
"md-nav__item">
902 <a href=
"../../../javascript/components_dialog/" class=
"md-nav__link">
915 <li class=
"md-nav__item">
916 <a href=
"../../../javascript/components_google_maps/" class=
"md-nav__link">
929 <li class=
"md-nav__item">
930 <a href=
"../../../javascript/components_pagination/" class=
"md-nav__link">
951 <li class=
"md-nav__item md-nav__item--nested">
956 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4_4" >
960 <label class=
"md-nav__link" for=
"__nav_4_4" id=
"__nav_4_4_label" tabindex=
"0">
962 <span class=
"md-nav__icon md-icon"></span>
965 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_4_4_label" aria-expanded=
"false">
966 <label class=
"md-nav__title" for=
"__nav_4_4">
967 <span class=
"md-nav__icon md-icon"></span>
970 <ul class=
"md-nav__list" data-md-scrollfix
>
977 <li class=
"md-nav__item">
978 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
991 <li class=
"md-nav__item">
992 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
1005 <li class=
"md-nav__item">
1006 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
1019 <li class=
"md-nav__item">
1020 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
1033 <li class=
"md-nav__item">
1034 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
1047 <li class=
"md-nav__item">
1048 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
1061 <li class=
"md-nav__item">
1062 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
1063 Browser and Screen Sizes
1075 <li class=
"md-nav__item">
1076 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
1096 <li class=
"md-nav__item">
1097 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
1110 <li class=
"md-nav__item">
1111 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
1133 <li class=
"md-nav__item md-nav__item--nested">
1138 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5" >
1142 <label class=
"md-nav__link" for=
"__nav_5" id=
"__nav_5_label" tabindex=
"0">
1144 <span class=
"md-nav__icon md-icon"></span>
1147 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_5_label" aria-expanded=
"false">
1148 <label class=
"md-nav__title" for=
"__nav_5">
1149 <span class=
"md-nav__icon md-icon"></span>
1152 <ul class=
"md-nav__list" data-md-scrollfix
>
1159 <li class=
"md-nav__item">
1160 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
1174 <li class=
"md-nav__item md-nav__item--nested">
1179 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5_2" >
1183 <label class=
"md-nav__link" for=
"__nav_5_2" id=
"__nav_5_2_label" tabindex=
"0">
1185 <span class=
"md-nav__icon md-icon"></span>
1188 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_5_2_label" aria-expanded=
"false">
1189 <label class=
"md-nav__title" for=
"__nav_5_2">
1190 <span class=
"md-nav__icon md-icon"></span>
1193 <ul class=
"md-nav__list" data-md-scrollfix
>
1200 <li class=
"md-nav__item">
1201 <a href=
"../../../package/pip/" class=
"md-nav__link">
1214 <li class=
"md-nav__item">
1215 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
1228 <li class=
"md-nav__item">
1229 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
1242 <li class=
"md-nav__item">
1243 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
1256 <li class=
"md-nav__item">
1257 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1270 <li class=
"md-nav__item">
1271 <a href=
"../../../package/pip/acp-template-delete/" class=
"md-nav__link">
1284 <li class=
"md-nav__item">
1285 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1298 <li class=
"md-nav__item">
1299 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1312 <li class=
"md-nav__item">
1313 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1326 <li class=
"md-nav__item">
1327 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1340 <li class=
"md-nav__item">
1341 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1354 <li class=
"md-nav__item">
1355 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1368 <li class=
"md-nav__item">
1369 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1382 <li class=
"md-nav__item">
1383 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1396 <li class=
"md-nav__item">
1397 <a href=
"../../../package/pip/file-delete/" class=
"md-nav__link">
1410 <li class=
"md-nav__item">
1411 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1424 <li class=
"md-nav__item">
1425 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1438 <li class=
"md-nav__item">
1439 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1452 <li class=
"md-nav__item">
1453 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1466 <li class=
"md-nav__item">
1467 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1480 <li class=
"md-nav__item">
1481 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1482 objectTypeDefinition
1494 <li class=
"md-nav__item">
1495 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1508 <li class=
"md-nav__item">
1509 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1522 <li class=
"md-nav__item">
1523 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1536 <li class=
"md-nav__item">
1537 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1550 <li class=
"md-nav__item">
1551 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1564 <li class=
"md-nav__item">
1565 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1578 <li class=
"md-nav__item">
1579 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1592 <li class=
"md-nav__item">
1593 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1606 <li class=
"md-nav__item">
1607 <a href=
"../../../package/pip/template-delete/" class=
"md-nav__link">
1620 <li class=
"md-nav__item">
1621 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1634 <li class=
"md-nav__item">
1635 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1648 <li class=
"md-nav__item">
1649 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1662 <li class=
"md-nav__item">
1663 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1664 userNotificationEvent
1676 <li class=
"md-nav__item">
1677 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1690 <li class=
"md-nav__item">
1691 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1711 <li class=
"md-nav__item">
1712 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1736 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1741 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6" checked
>
1745 <label class=
"md-nav__link" for=
"__nav_6" id=
"__nav_6_label" tabindex=
"0">
1747 <span class=
"md-nav__icon md-icon"></span>
1750 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_6_label" aria-expanded=
"true">
1751 <label class=
"md-nav__title" for=
"__nav_6">
1752 <span class=
"md-nav__icon md-icon"></span>
1755 <ul class=
"md-nav__list" data-md-scrollfix
>
1763 <li class=
"md-nav__item md-nav__item--nested">
1768 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_1" >
1772 <label class=
"md-nav__link" for=
"__nav_6_1" id=
"__nav_6_1_label" tabindex=
"0">
1773 From WoltLab Suite
5.5
1774 <span class=
"md-nav__icon md-icon"></span>
1777 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_1_label" aria-expanded=
"false">
1778 <label class=
"md-nav__title" for=
"__nav_6_1">
1779 <span class=
"md-nav__icon md-icon"></span>
1780 From WoltLab Suite
5.5
1782 <ul class=
"md-nav__list" data-md-scrollfix
>
1789 <li class=
"md-nav__item">
1790 <a href=
"../../wsc55/php/" class=
"md-nav__link">
1803 <li class=
"md-nav__item">
1804 <a href=
"../../wsc55/javascript/" class=
"md-nav__link">
1805 TypeScript and JavaScript
1817 <li class=
"md-nav__item">
1818 <a href=
"../../wsc55/templates/" class=
"md-nav__link">
1831 <li class=
"md-nav__item">
1832 <a href=
"../../wsc55/icons/" class=
"md-nav__link">
1845 <li class=
"md-nav__item">
1846 <a href=
"../../wsc55/dialogs/" class=
"md-nav__link">
1859 <li class=
"md-nav__item">
1860 <a href=
"../../wsc55/libraries/" class=
"md-nav__link">
1861 Third Party Libraries
1873 <li class=
"md-nav__item">
1874 <a href=
"../../wsc55/deprecations_removals/" class=
"md-nav__link">
1875 Deprecations and Removals
1895 <li class=
"md-nav__item md-nav__item--nested">
1900 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_2" >
1904 <label class=
"md-nav__link" for=
"__nav_6_2" id=
"__nav_6_2_label" tabindex=
"0">
1905 From WoltLab Suite
5.4
1906 <span class=
"md-nav__icon md-icon"></span>
1909 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_2_label" aria-expanded=
"false">
1910 <label class=
"md-nav__title" for=
"__nav_6_2">
1911 <span class=
"md-nav__icon md-icon"></span>
1912 From WoltLab Suite
5.4
1914 <ul class=
"md-nav__list" data-md-scrollfix
>
1921 <li class=
"md-nav__item">
1922 <a href=
"../../wsc54/php/" class=
"md-nav__link">
1935 <li class=
"md-nav__item">
1936 <a href=
"../../wsc54/javascript/" class=
"md-nav__link">
1937 TypeScript and JavaScript
1949 <li class=
"md-nav__item">
1950 <a href=
"../../wsc54/templates/" class=
"md-nav__link">
1963 <li class=
"md-nav__item">
1964 <a href=
"../../wsc54/libraries/" class=
"md-nav__link">
1965 Third Party Libraries
1977 <li class=
"md-nav__item">
1978 <a href=
"../../wsc54/deprecations_removals/" class=
"md-nav__link">
1979 Deprecations and Removals
2001 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
2006 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_3" checked
>
2010 <label class=
"md-nav__link" for=
"__nav_6_3" id=
"__nav_6_3_label" tabindex=
"0">
2011 From WoltLab Suite
5.3
2012 <span class=
"md-nav__icon md-icon"></span>
2015 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_3_label" aria-expanded=
"true">
2016 <label class=
"md-nav__title" for=
"__nav_6_3">
2017 <span class=
"md-nav__icon md-icon"></span>
2018 From WoltLab Suite
5.3
2020 <ul class=
"md-nav__list" data-md-scrollfix
>
2029 <li class=
"md-nav__item md-nav__item--active">
2031 <input class=
"md-nav__toggle md-toggle" type=
"checkbox" id=
"__toc">
2037 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
2039 <span class=
"md-nav__icon md-icon"></span>
2042 <a href=
"./" class=
"md-nav__link md-nav__link--active">
2048 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2055 <label class=
"md-nav__title" for=
"__toc">
2056 <span class=
"md-nav__icon md-icon"></span>
2059 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2061 <li class=
"md-nav__item">
2062 <a href=
"#minimum-requirements" class=
"md-nav__link">
2063 Minimum requirements
2068 <li class=
"md-nav__item">
2069 <a href=
"#flood-control" class=
"md-nav__link">
2075 <li class=
"md-nav__item">
2076 <a href=
"#databasepackageinstallationplugin" class=
"md-nav__link">
2077 DatabasePackageInstallationPlugin
2082 <li class=
"md-nav__item">
2083 <a href=
"#php-database-api" class=
"md-nav__link">
2089 <li class=
"md-nav__item">
2090 <a href=
"#captcha" class=
"md-nav__link">
2096 <li class=
"md-nav__item">
2097 <a href=
"#search" class=
"md-nav__link">
2103 <li class=
"md-nav__item">
2104 <a href=
"#styles" class=
"md-nav__link">
2110 <li class=
"md-nav__item">
2111 <a href=
"#tags" class=
"md-nav__link">
2117 <li class=
"md-nav__item">
2118 <a href=
"#avatars" class=
"md-nav__link">
2124 <li class=
"md-nav__item">
2125 <a href=
"#linebreakseparatedtext-option-type" class=
"md-nav__link">
2126 lineBreakSeparatedText Option Type
2131 <li class=
"md-nav__item">
2132 <a href=
"#ignoring-of-users" class=
"md-nav__link">
2138 <li class=
"md-nav__item">
2139 <a href=
"#databaseprepare" class=
"md-nav__link">
2159 <li class=
"md-nav__item">
2160 <a href=
"../session/" class=
"md-nav__link">
2161 Session Handling and Authentication
2173 <li class=
"md-nav__item">
2174 <a href=
"../javascript/" class=
"md-nav__link">
2175 TypeScript and JavaScript
2187 <li class=
"md-nav__item">
2188 <a href=
"../templates/" class=
"md-nav__link">
2201 <li class=
"md-nav__item">
2202 <a href=
"../libraries/" class=
"md-nav__link">
2203 Third Party Libraries
2223 <li class=
"md-nav__item md-nav__item--nested">
2228 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_4" >
2232 <label class=
"md-nav__link" for=
"__nav_6_4" id=
"__nav_6_4_label" tabindex=
"0">
2233 From WoltLab Suite
5.2
2234 <span class=
"md-nav__icon md-icon"></span>
2237 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_4_label" aria-expanded=
"false">
2238 <label class=
"md-nav__title" for=
"__nav_6_4">
2239 <span class=
"md-nav__icon md-icon"></span>
2240 From WoltLab Suite
5.2
2242 <ul class=
"md-nav__list" data-md-scrollfix
>
2249 <li class=
"md-nav__item">
2250 <a href=
"../../wsc52/php/" class=
"md-nav__link">
2263 <li class=
"md-nav__item">
2264 <a href=
"../../wsc52/templates/" class=
"md-nav__link">
2265 Templates and Languages
2277 <li class=
"md-nav__item">
2278 <a href=
"../../wsc52/libraries/" class=
"md-nav__link">
2279 Third Party Libraries
2299 <li class=
"md-nav__item md-nav__item--nested">
2304 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_5" >
2308 <label class=
"md-nav__link" for=
"__nav_6_5" id=
"__nav_6_5_label" tabindex=
"0">
2309 From WoltLab Suite
3.1
2310 <span class=
"md-nav__icon md-icon"></span>
2313 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_5_label" aria-expanded=
"false">
2314 <label class=
"md-nav__title" for=
"__nav_6_5">
2315 <span class=
"md-nav__icon md-icon"></span>
2316 From WoltLab Suite
3.1
2318 <ul class=
"md-nav__list" data-md-scrollfix
>
2325 <li class=
"md-nav__item">
2326 <a href=
"../../wsc31/php/" class=
"md-nav__link">
2347 <li class=
"md-nav__item md-nav__item--nested">
2352 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_6" >
2356 <label class=
"md-nav__link" for=
"__nav_6_6" id=
"__nav_6_6_label" tabindex=
"0">
2357 From WoltLab Suite
3.0
2358 <span class=
"md-nav__icon md-icon"></span>
2361 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_6_label" aria-expanded=
"false">
2362 <label class=
"md-nav__title" for=
"__nav_6_6">
2363 <span class=
"md-nav__icon md-icon"></span>
2364 From WoltLab Suite
3.0
2366 <ul class=
"md-nav__list" data-md-scrollfix
>
2373 <li class=
"md-nav__item">
2374 <a href=
"../../wsc30/php/" class=
"md-nav__link">
2387 <li class=
"md-nav__item">
2388 <a href=
"../../wsc30/javascript/" class=
"md-nav__link">
2401 <li class=
"md-nav__item">
2402 <a href=
"../../wsc30/templates/" class=
"md-nav__link">
2415 <li class=
"md-nav__item">
2416 <a href=
"../../wsc30/css/" class=
"md-nav__link">
2429 <li class=
"md-nav__item">
2430 <a href=
"../../wsc30/package/" class=
"md-nav__link">
2451 <li class=
"md-nav__item md-nav__item--nested">
2456 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_7" >
2460 <label class=
"md-nav__link" for=
"__nav_6_7" id=
"__nav_6_7_label" tabindex=
"0">
2462 <span class=
"md-nav__icon md-icon"></span>
2465 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_7_label" aria-expanded=
"false">
2466 <label class=
"md-nav__title" for=
"__nav_6_7">
2467 <span class=
"md-nav__icon md-icon"></span>
2470 <ul class=
"md-nav__list" data-md-scrollfix
>
2477 <li class=
"md-nav__item">
2478 <a href=
"../../wcf21/php/" class=
"md-nav__link">
2491 <li class=
"md-nav__item">
2492 <a href=
"../../wcf21/templates/" class=
"md-nav__link">
2505 <li class=
"md-nav__item">
2506 <a href=
"../../wcf21/css/" class=
"md-nav__link">
2519 <li class=
"md-nav__item">
2520 <a href=
"../../wcf21/package/" class=
"md-nav__link">
2549 <li class=
"md-nav__item md-nav__item--nested">
2554 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7" >
2558 <label class=
"md-nav__link" for=
"__nav_7" id=
"__nav_7_label" tabindex=
"0">
2560 <span class=
"md-nav__icon md-icon"></span>
2563 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_7_label" aria-expanded=
"false">
2564 <label class=
"md-nav__title" for=
"__nav_7">
2565 <span class=
"md-nav__icon md-icon"></span>
2568 <ul class=
"md-nav__list" data-md-scrollfix
>
2576 <li class=
"md-nav__item md-nav__item--nested">
2581 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7_1" >
2585 <label class=
"md-nav__link" for=
"__nav_7_1" id=
"__nav_7_1_label" tabindex=
"0">
2587 <span class=
"md-nav__icon md-icon"></span>
2590 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_7_1_label" aria-expanded=
"false">
2591 <label class=
"md-nav__title" for=
"__nav_7_1">
2592 <span class=
"md-nav__icon md-icon"></span>
2595 <ul class=
"md-nav__list" data-md-scrollfix
>
2602 <li class=
"md-nav__item">
2603 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
2616 <li class=
"md-nav__item">
2617 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
2630 <li class=
"md-nav__item">
2631 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
2644 <li class=
"md-nav__item">
2645 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
2658 <li class=
"md-nav__item">
2659 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
2672 <li class=
"md-nav__item">
2673 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
2686 <li class=
"md-nav__item">
2687 <a href=
"../../../tutorial/series/part_6/" class=
"md-nav__link">
2716 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2717 <div class=
"md-sidebar__scrollwrap">
2718 <div class=
"md-sidebar__inner">
2721 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2728 <label class=
"md-nav__title" for=
"__toc">
2729 <span class=
"md-nav__icon md-icon"></span>
2732 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2734 <li class=
"md-nav__item">
2735 <a href=
"#minimum-requirements" class=
"md-nav__link">
2736 Minimum requirements
2741 <li class=
"md-nav__item">
2742 <a href=
"#flood-control" class=
"md-nav__link">
2748 <li class=
"md-nav__item">
2749 <a href=
"#databasepackageinstallationplugin" class=
"md-nav__link">
2750 DatabasePackageInstallationPlugin
2755 <li class=
"md-nav__item">
2756 <a href=
"#php-database-api" class=
"md-nav__link">
2762 <li class=
"md-nav__item">
2763 <a href=
"#captcha" class=
"md-nav__link">
2769 <li class=
"md-nav__item">
2770 <a href=
"#search" class=
"md-nav__link">
2776 <li class=
"md-nav__item">
2777 <a href=
"#styles" class=
"md-nav__link">
2783 <li class=
"md-nav__item">
2784 <a href=
"#tags" class=
"md-nav__link">
2790 <li class=
"md-nav__item">
2791 <a href=
"#avatars" class=
"md-nav__link">
2797 <li class=
"md-nav__item">
2798 <a href=
"#linebreakseparatedtext-option-type" class=
"md-nav__link">
2799 lineBreakSeparatedText Option Type
2804 <li class=
"md-nav__item">
2805 <a href=
"#ignoring-of-users" class=
"md-nav__link">
2811 <li class=
"md-nav__item">
2812 <a href=
"#databaseprepare" class=
"md-nav__link">
2827 <div class=
"md-content" data-md-component=
"content">
2828 <article class=
"md-content__inner md-typeset">
2836 <h1 id=
"migrating-from-woltlab-suite-53-php">Migrating from WoltLab Suite
5.3 - PHP
<a class=
"headerlink" href=
"#migrating-from-woltlab-suite-53-php" title=
"Permanent link">#
</a></h1>
2837 <h2 id=
"minimum-requirements">Minimum requirements
<a class=
"headerlink" href=
"#minimum-requirements" title=
"Permanent link">#
</a></h2>
2838 <p>The minimum requirements have been increased to the following:
</p>
2840 <li><strong>PHP:
</strong> 7.2.24</li>
2841 <li><strong>MySQL:
</strong> 5.7.31 or
8.0.19</li>
2842 <li><strong>MariaDB:
</strong> 10.1.44</li>
2844 <p>Most notably PHP
7.2 contains usable support for scalar types by the addition of nullable types in PHP
7.1 and parameter type widening in PHP
7.2.
</p>
2845 <p>It is recommended to make use of scalar types and other newly introduced features whereever possible.
2846 Please refer to the PHP documentation for details.
</p>
2847 <h2 id=
"flood-control">Flood Control
<a class=
"headerlink" href=
"#flood-control" title=
"Permanent link">#
</a></h2>
2848 <p>To prevent users from creating massive amounts of contents in short periods of time, i.e., spam, existing systems already use flood control mechanisms to limit the amount of contents created within a certain period of time.
2849 With WoltLab Suite
5.4, we have added a general API that manages such rate limiting.
2850 Leveraging this API is easily done.
</p>
2852 <li>Register an object type for the definition
<code>com.woltlab.wcf.floodControl
</code>:
<code>com.example.foo.myContent
</code>.
</li>
2853 <li>Whenever the active user creates content of this type, call
2854 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"nx">FloodControl
</span><span class=
"o">::
</span><span class=
"na">getInstance
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">registerContent
</span><span class=
"p">(
</span><span class=
"s1">'com.example.foo.myContent
'</span><span class=
"p">);
</span>
2855 </code></pre></div></td></tr></table></div>
2856 You should only call this method if the user creates the content themselves.
2857 If the content is automatically created by the system, for example when copying / duplicating existing content, no activity should be registered.
</li>
2859 <p>To check the last time when the active user created content of the relevant type, use
2860 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"nx">FloodControl
</span><span class=
"o">::
</span><span class=
"na">getInstance
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">getLastTime
</span><span class=
"p">(
</span><span class=
"s1">'com.example.foo.myContent
'</span><span class=
"p">);
</span>
2861 </code></pre></div></td></tr></table></div>
2862 If you want to limit the number of content items created within a certain period of time, for example within one day, use
2863 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2864 <span class=
"normal">2</span>
2865 <span class=
"normal">3</span>
2866 <span class=
"normal">4</span>
2867 <span class=
"normal">5</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"nv">$data
</span> <span class=
"o">=
</span> <span class=
"nx">FloodControl
</span><span class=
"o">::
</span><span class=
"na">getInstance
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">countContent
</span><span class=
"p">(
</span><span class=
"s1">'com.example.foo.myContent
'</span><span class=
"p">,
</span> <span class=
"k">new
</span> <span class=
"nx">\DateInterval
</span><span class=
"p">(
</span><span class=
"s1">'P1D
'</span><span class=
"p">));
</span>
2868 <span class=
"c1">// number of content items created within the last day
</span>
2869 <span class=
"nv">$count
</span> <span class=
"o">=
</span> <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'count
'</span><span class=
"p">];
</span>
2870 <span class=
"c1">// timestamp when the earliest content item was created within the last day
</span>
2871 <span class=
"nv">$earliestTime
</span> <span class=
"o">=
</span> <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'earliestTime
'</span><span class=
"p">];
</span>
2872 </code></pre></div></td></tr></table></div>
2873 The method also returns
<code>earliestTime
</code> so that you can tell the user in the error message when they are able again to create new content of the relevant type.
</p>
2874 <div class=
"admonition info">
2875 <p class=
"admonition-title">Flood control entries are only stored for
31 days and older entries are cleaned up daily.
</p>
2879 <p>The previously mentioned methods of
<code>FloodControl
</code> use the active user and the current timestamp as reference point.
2880 <code>FloodControl
</code> also provides methods to register content or check flood control for other registered users or for guests via their IP address.
2881 For further details on these methods, please refer to the
<a href=
"https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/flood/FloodControl.class.php">documentation in the FloodControl class
</a>.
</p>
2882 <div class=
"admonition warning">
2883 <p class=
"admonition-title">Do not interact directly with the flood control database table but only via the
<code>FloodControl
</code> class!
</p>
2885 <h2 id=
"databasepackageinstallationplugin">DatabasePackageInstallationPlugin
<a class=
"headerlink" href=
"#databasepackageinstallationplugin" title=
"Permanent link">#
</a></h2>
2886 <p><code>DatabasePackageInstallationPlugin
</code> is a new idempotent package installation plugin (thus it is available in the sync function in the devtools) to update the database schema using the PHP-based database API.
2887 <code>DatabasePackageInstallationPlugin
</code> is similar to
<code>ScriptPackageInstallationPlugin
</code> by requiring a PHP script that is included during the execution of the script.
2888 The script is expected to return an array of
<code>DatabaseTable
</code> objects representing the schema changes so that in contrast to using
<code>ScriptPackageInstallationPlugin
</code>, no
<code>DatabaseTableChangeProcessor
</code> object has to be created.
2889 The PHP file must be located in the
<code>acp/database/
</code> directory for the devtools sync function to recognize the file.
</p>
2890 <h2 id=
"php-database-api">PHP Database API
<a class=
"headerlink" href=
"#php-database-api" title=
"Permanent link">#
</a></h2>
2891 <p>The PHP API to add and change database tables during package installations and updates in the
<code>wcf\system\database\table
</code> namespace now also supports renaming existing table columns with the new
<code>IDatabaseTableColumn::renameTo()
</code> method:
</p>
2892 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2893 <span class=
"normal">2</span>
2894 <span class=
"normal">3</span>
2895 <span class=
"normal">4</span>
2896 <span class=
"normal">5</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"nx">PartialDatabaseTable
</span><span class=
"o">::
</span><span class=
"na">create
</span><span class=
"p">(
</span><span class=
"s1">'wcf1_test
'</span><span class=
"p">)
</span>
2897 <span class=
"o">-
></span><span class=
"na">columns
</span><span class=
"p">([
</span>
2898 <span class=
"nx">NotNullInt10DatabaseTableColumn
</span><span class=
"o">::
</span><span class=
"na">create
</span><span class=
"p">(
</span><span class=
"s1">'oldName
'</span><span class=
"p">)
</span>
2899 <span class=
"o">-
></span><span class=
"na">renameTo
</span><span class=
"p">(
</span><span class=
"s1">'newName
'</span><span class=
"p">)
</span>
2900 <span class=
"p">]);
</span>
2901 </code></pre></div></td></tr></table></div>
2902 <div class=
"admonition info">
2903 <p class=
"admonition-title">Like with every change to existing database tables, packages can only rename columns that they installed.
</p>
2905 <h2 id=
"captcha">Captcha
<a class=
"headerlink" href=
"#captcha" title=
"Permanent link">#
</a></h2>
2906 <p>The reCAPTCHA v1 implementation was completely removed.
2907 This includes the
<code>\wcf\system\recaptcha\RecaptchaHandler
</code> class (not to be confused with the one in the
<code>captcha
</code> namespace).
</p>
2908 <p>The reCAPTCHA v1 endpoints have already been turned off by Google and always return a HTTP
404.
2909 Thus the implementation was completely non-functional even before this change.
</p>
2910 <p>See
<a href=
"https://github.com/WoltLab/WCF/pull/3781">WoltLab/WCF#
3781</a> for details.
</p>
2911 <h2 id=
"search">Search
<a class=
"headerlink" href=
"#search" title=
"Permanent link">#
</a></h2>
2912 <p>The generic implementation in the
<code>AbstractSearchEngine::parseSearchQuery()
</code> method was dangerous, because it did not have knowledge about the search engine’s specifics.
2913 The implementation was completely removed:
<code>AbstractSearchEngine::parseSearchQuery()
</code> now always throws a
<code>\BadMethodCallException
</code>.
</p>
2914 <p>If you implemented a custom search engine and relied on this method, you can inline the previous implementation to preserve existing behavior.
2915 You should take the time to verify the rewritten queries against the manual of the search engine to make sure it cannot generate malformed queries or security issues.
</p>
2916 <p>See
<a href=
"https://github.com/WoltLab/WCF/issues/3815">WoltLab/WCF#
3815</a> for details.
</p>
2917 <h2 id=
"styles">Styles
<a class=
"headerlink" href=
"#styles" title=
"Permanent link">#
</a></h2>
2918 <p>The
<code>StyleCompiler
</code> class is marked
<code>final
</code> now.
2919 The internal SCSS compiler object being stored in the
<code>$compiler
</code> property was a design issue that leaked compiler state across multiple compiled styles, possibly causing misgenerated stylesheets.
2920 As the removal of the
<code>$compiler
</code> property effectively broke compatibility within the
<code>StyleCompiler
</code> and as the
<code>StyleCompiler
</code> never was meant to be extended, it was marked final.
</p>
2921 <p>See
<a href=
"https://github.com/WoltLab/WCF/pull/3929">WoltLab/WCF#
3929</a> for details.
</p>
2922 <h2 id=
"tags">Tags
<a class=
"headerlink" href=
"#tags" title=
"Permanent link">#
</a></h2>
2923 <p>Use of the
<code>wcf1_tag_to_object.languageID
</code> column is deprecated.
2924 The
<code>languageID
</code> column is redundant, because its value can be derived from the
<code>tagID
</code>.
2925 With WoltLab Suite
5.4, it will no longer be part of any indices, allowing more efficient index usage in the general case.
</p>
2926 <p>If you need to filter the contents of
<code>wcf1_tag_to_object
</code> by language, you should perform an
<code>INNER JOIN wcf1_tag tag ON tag.tagID = tag_to_object.tagID
</code> and filter on
<code>wcf1_tag.languageID
</code>.
</p>
2927 <p>See
<a href=
"https://github.com/WoltLab/WCF/pull/3904">WoltLab/WCF#
3904</a> for details.
</p>
2928 <h2 id=
"avatars">Avatars
<a class=
"headerlink" href=
"#avatars" title=
"Permanent link">#
</a></h2>
2929 <p>The
<code>ISafeFormatAvatar
</code> interface was added to properly support fallback image types for use in emails.
2930 If your custom
<code>IUserAvatar
</code> implementation supports image types without broad support (i.e. anything other than PNG, JPEG, and GIF), then you should implement the
<code>ISafeFormatAvatar
</code> interface to return a fallback PNG, JPEG, or GIF image.
</p>
2931 <p>See
<a href=
"https://github.com/WoltLab/WCF/pull/4001">WoltLab/WCF#
4001</a> for details.
</p>
2932 <h2 id=
"linebreakseparatedtext-option-type"><code>lineBreakSeparatedText
</code> Option Type
<a class=
"headerlink" href=
"#linebreakseparatedtext-option-type" title=
"Permanent link">#
</a></h2>
2933 <p>Currently, several of the (user group) options installed by our packages use the
<code>textarea
</code> option type and split its value by linebreaks to get a list of items, for example for allowed file extensions.
2934 To improve the user interface when setting up the value of such options, we have added the
<code>lineBreakSeparatedText
</code> option type as a drop-in replacement where the individual items are explicitly represented as distinct items in the user interface.
</p>
2935 <h2 id=
"ignoring-of-users">Ignoring of Users
<a class=
"headerlink" href=
"#ignoring-of-users" title=
"Permanent link">#
</a></h2>
2936 <p>WoltLab Suite
5.4 distinguishes between blocking direct contact only and hiding all contents when ignoring users.
2937 To allow for detecting the difference, the
<code>UserProfile::getIgnoredUsers()
</code> and
<code>UserProfile::isIgnoredUser()
</code> methods received a new
<code>$type
</code> parameter.
2938 Pass either
<code>UserIgnore::TYPE_BLOCK_DIRECT_CONTACT
</code> or
<code>UserIgnore::TYPE_HIDE_MESSAGES
</code> depending on whether the check refers to a non-directed usage or content.
</p>
2939 <p>See
<a href=
"https://github.com/WoltLab/WCF/pull/4064">WoltLab/WCF#
4064</a> and
<a href=
"https://github.com/WoltLab/WCF/issues/3981">WoltLab/WCF#
3981</a> for details.
</p>
2940 <h2 id=
"databaseprepare"><code>Database::prepare()
</code><a class=
"headerlink" href=
"#databaseprepare" title=
"Permanent link">#
</a></h2>
2941 <p><code>Database::prepare(string $statement, int $limit =
0, int $offset =
0): PreparedStatement
</code> works the same way as
<code>Database::prepareStatement()
</code> but additionally also replaces all occurences of
<code>app1_
</code> with
<code>app{WCF_N}_
</code> for all installed apps.
2942 This new method makes it superfluous to use
<code>WCF_N
</code> when building queries.
</p>
2945 <div class=
"md-source-file">
2967 <footer class=
"md-footer">
2969 <div class=
"md-footer-meta md-typeset">
2970 <div class=
"md-footer-meta__inner md-grid">
2971 <div class=
"md-copyright">
2973 <div class=
"md-copyright__highlight">
2974 Copyright ©
2020 WoltLab GmbH
2979 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2985 <div class=
"md-copyright">
2986 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2987 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2995 <div class=
"md-dialog" data-md-component=
"dialog">
2996 <div class=
"md-dialog__inner md-typeset"></div>
2999 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [
"navigation.tracking"],
"search":
"../../../assets/javascripts/workers/search.74e28a9f.min.js",
"translations": {
"clipboard.copied":
"Copied to clipboard",
"clipboard.copy":
"Copy to clipboard",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.placeholder":
"Type to start searching",
"search.result.term.missing":
"Missing",
"select.version":
"Select version"},
"version": {
"provider":
"mike"}}
</script>
3002 <script src=
"../../../assets/javascripts/bundle.220ee61c.min.js"></script>