3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"shortcut icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.0.5">
17 <title>PHP API - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.77f3fd56.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.7fa14f5b.min.css">
28 <meta name=
"theme-color" content=
"#009485">
37 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
51 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
56 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
57 <label class=
"md-overlay" for=
"__drawer"></label>
58 <div data-md-component=
"skip">
61 <a href=
"#migrating-from-wsc-53-php" class=
"md-skip">
66 <div data-md-component=
"announce">
68 <aside class=
"md-announce">
69 <div class=
"md-announce__inner md-grid md-typeset">
71 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation">
84 <img src=
"../../../assets/logo.png" alt=
"logo">
87 <label class=
"md-header__button md-icon" for=
"__drawer">
88 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 <div class=
"md-header__title" data-md-component=
"header-title">
91 <div class=
"md-header__ellipsis">
92 <div class=
"md-header__topic">
93 <span class=
"md-ellipsis">
94 WoltLab Suite Documentation
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
106 <div class=
"md-header__options">
110 <label class=
"md-header__button md-icon" for=
"__search">
111 <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>
114 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
115 <label class=
"md-search__overlay" for=
"__search"></label>
116 <div class=
"md-search__inner" role=
"search">
117 <form class=
"md-search__form" name=
"search">
118 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
119 <label class=
"md-search__icon md-icon" for=
"__search">
120 <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>
121 <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>
123 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
124 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41L17.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>
127 <div class=
"md-search__output">
128 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
129 <div class=
"md-search-result" data-md-component=
"search-result">
130 <div class=
"md-search-result__meta">
133 <ol class=
"md-search-result__list"></ol>
144 <div class=
"md-container" data-md-component=
"container">
149 <main class=
"md-main" data-md-component=
"main">
150 <div class=
"md-main__inner md-grid">
154 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
155 <div class=
"md-sidebar__scrollwrap">
156 <div class=
"md-sidebar__inner">
162 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
163 <label class=
"md-nav__title" for=
"__drawer">
164 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation">
166 <img src=
"../../../assets/logo.png" alt=
"logo">
169 WoltLab Suite Documentation
172 <ul class=
"md-nav__list" data-md-scrollfix
>
181 <li class=
"md-nav__item">
182 <a href=
"../../../getting-started/" class=
"md-nav__link">
197 <li class=
"md-nav__item md-nav__item--nested">
200 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
202 <label class=
"md-nav__link" for=
"__nav_2">
204 <span class=
"md-nav__icon md-icon"></span>
206 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
207 <label class=
"md-nav__title" for=
"__nav_2">
208 <span class=
"md-nav__icon md-icon"></span>
211 <ul class=
"md-nav__list" data-md-scrollfix
>
217 <li class=
"md-nav__item">
218 <a href=
"../../../php/pages/" class=
"md-nav__link">
229 <li class=
"md-nav__item">
230 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
241 <li class=
"md-nav__item">
242 <a href=
"../../../php/database-access/" class=
"md-nav__link">
253 <li class=
"md-nav__item">
254 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
266 <li class=
"md-nav__item md-nav__item--nested">
269 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
271 <label class=
"md-nav__link" for=
"__nav_2_5">
273 <span class=
"md-nav__icon md-icon"></span>
275 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
276 <label class=
"md-nav__title" for=
"__nav_2_5">
277 <span class=
"md-nav__icon md-icon"></span>
280 <ul class=
"md-nav__list" data-md-scrollfix
>
286 <li class=
"md-nav__item">
287 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
298 <li class=
"md-nav__item">
299 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
322 <li class=
"md-nav__item">
323 <a href=
"../../../php/api/events/" class=
"md-nav__link">
335 <li class=
"md-nav__item md-nav__item--nested">
338 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
340 <label class=
"md-nav__link" for=
"__nav_2_5_5">
342 <span class=
"md-nav__icon md-icon"></span>
344 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
345 <label class=
"md-nav__title" for=
"__nav_2_5_5">
346 <span class=
"md-nav__icon md-icon"></span>
349 <ul class=
"md-nav__list" data-md-scrollfix
>
355 <li class=
"md-nav__item">
356 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
367 <li class=
"md-nav__item">
368 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
379 <li class=
"md-nav__item">
380 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
391 <li class=
"md-nav__item">
392 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
403 <li class=
"md-nav__item">
404 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
421 <li class=
"md-nav__item">
422 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
423 Package Installation Plugins
433 <li class=
"md-nav__item">
434 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
445 <li class=
"md-nav__item">
446 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
457 <li class=
"md-nav__item">
458 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
475 <li class=
"md-nav__item">
476 <a href=
"../../../php/code-style/" class=
"md-nav__link">
487 <li class=
"md-nav__item">
488 <a href=
"../../../php/apps/" class=
"md-nav__link">
499 <li class=
"md-nav__item">
500 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
521 <li class=
"md-nav__item md-nav__item--nested">
524 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
526 <label class=
"md-nav__link" for=
"__nav_3">
527 Languages, Templates & CSS
528 <span class=
"md-nav__icon md-icon"></span>
530 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
531 <label class=
"md-nav__title" for=
"__nav_3">
532 <span class=
"md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
535 <ul class=
"md-nav__list" data-md-scrollfix
>
541 <li class=
"md-nav__item">
542 <a href=
"../../../view/languages/" class=
"md-nav__link">
553 <li class=
"md-nav__item">
554 <a href=
"../../../view/templates/" class=
"md-nav__link">
565 <li class=
"md-nav__item">
566 <a href=
"../../../view/css/" class=
"md-nav__link">
587 <li class=
"md-nav__item md-nav__item--nested">
590 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
592 <label class=
"md-nav__link" for=
"__nav_4">
594 <span class=
"md-nav__icon md-icon"></span>
596 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
597 <label class=
"md-nav__title" for=
"__nav_4">
598 <span class=
"md-nav__icon md-icon"></span>
601 <ul class=
"md-nav__list" data-md-scrollfix
>
607 <li class=
"md-nav__item">
608 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
620 <li class=
"md-nav__item md-nav__item--nested">
623 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
625 <label class=
"md-nav__link" for=
"__nav_4_2">
627 <span class=
"md-nav__icon md-icon"></span>
629 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
630 <label class=
"md-nav__title" for=
"__nav_4_2">
631 <span class=
"md-nav__icon md-icon"></span>
634 <ul class=
"md-nav__list" data-md-scrollfix
>
640 <li class=
"md-nav__item">
641 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
652 <li class=
"md-nav__item">
653 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
664 <li class=
"md-nav__item">
665 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
676 <li class=
"md-nav__item">
677 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
688 <li class=
"md-nav__item">
689 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
700 <li class=
"md-nav__item">
701 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
712 <li class=
"md-nav__item">
713 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
724 <li class=
"md-nav__item">
725 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
726 Browser and Screen Sizes
736 <li class=
"md-nav__item">
737 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
754 <li class=
"md-nav__item">
755 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
766 <li class=
"md-nav__item">
767 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
778 <li class=
"md-nav__item">
779 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
800 <li class=
"md-nav__item md-nav__item--nested">
803 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
805 <label class=
"md-nav__link" for=
"__nav_5">
807 <span class=
"md-nav__icon md-icon"></span>
809 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
810 <label class=
"md-nav__title" for=
"__nav_5">
811 <span class=
"md-nav__icon md-icon"></span>
814 <ul class=
"md-nav__list" data-md-scrollfix
>
820 <li class=
"md-nav__item">
821 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
833 <li class=
"md-nav__item md-nav__item--nested">
836 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
838 <label class=
"md-nav__link" for=
"__nav_5_2">
840 <span class=
"md-nav__icon md-icon"></span>
842 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
843 <label class=
"md-nav__title" for=
"__nav_5_2">
844 <span class=
"md-nav__icon md-icon"></span>
847 <ul class=
"md-nav__list" data-md-scrollfix
>
853 <li class=
"md-nav__item">
854 <a href=
"../../../package/pip/" class=
"md-nav__link">
865 <li class=
"md-nav__item">
866 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
877 <li class=
"md-nav__item">
878 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
889 <li class=
"md-nav__item">
890 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
901 <li class=
"md-nav__item">
902 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
913 <li class=
"md-nav__item">
914 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
925 <li class=
"md-nav__item">
926 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
937 <li class=
"md-nav__item">
938 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
949 <li class=
"md-nav__item">
950 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
961 <li class=
"md-nav__item">
962 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
973 <li class=
"md-nav__item">
974 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
985 <li class=
"md-nav__item">
986 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
997 <li class=
"md-nav__item">
998 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1009 <li class=
"md-nav__item">
1010 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1021 <li class=
"md-nav__item">
1022 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1033 <li class=
"md-nav__item">
1034 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1045 <li class=
"md-nav__item">
1046 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1057 <li class=
"md-nav__item">
1058 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1059 objectTypeDefinition
1069 <li class=
"md-nav__item">
1070 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1081 <li class=
"md-nav__item">
1082 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1093 <li class=
"md-nav__item">
1094 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1105 <li class=
"md-nav__item">
1106 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1117 <li class=
"md-nav__item">
1118 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1129 <li class=
"md-nav__item">
1130 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1141 <li class=
"md-nav__item">
1142 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1153 <li class=
"md-nav__item">
1154 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1165 <li class=
"md-nav__item">
1166 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1177 <li class=
"md-nav__item">
1178 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1189 <li class=
"md-nav__item">
1190 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1201 <li class=
"md-nav__item">
1202 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1203 userNotificationEvent
1213 <li class=
"md-nav__item">
1214 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1225 <li class=
"md-nav__item">
1226 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1243 <li class=
"md-nav__item">
1244 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1267 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1270 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" checked
>
1272 <label class=
"md-nav__link" for=
"__nav_6">
1274 <span class=
"md-nav__icon md-icon"></span>
1276 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1277 <label class=
"md-nav__title" for=
"__nav_6">
1278 <span class=
"md-nav__icon md-icon"></span>
1281 <ul class=
"md-nav__list" data-md-scrollfix
>
1290 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1293 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" checked
>
1295 <label class=
"md-nav__link" for=
"__nav_6_1">
1296 Migrating from WSC
5.3
1297 <span class=
"md-nav__icon md-icon"></span>
1299 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1300 <label class=
"md-nav__title" for=
"__nav_6_1">
1301 <span class=
"md-nav__icon md-icon"></span>
1302 Migrating from WSC
5.3
1304 <ul class=
"md-nav__list" data-md-scrollfix
>
1312 <li class=
"md-nav__item md-nav__item--active">
1314 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1319 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1321 <span class=
"md-nav__icon md-icon"></span>
1324 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1329 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1335 <label class=
"md-nav__title" for=
"__toc">
1336 <span class=
"md-nav__icon md-icon"></span>
1339 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1341 <li class=
"md-nav__item">
1342 <a href=
"#minimum-requirements" class=
"md-nav__link">
1343 Minimum requirements
1348 <li class=
"md-nav__item">
1349 <a href=
"#flood-control" class=
"md-nav__link">
1355 <li class=
"md-nav__item">
1356 <a href=
"#php-database-api" class=
"md-nav__link">
1362 <li class=
"md-nav__item">
1363 <a href=
"#captcha" class=
"md-nav__link">
1369 <li class=
"md-nav__item">
1370 <a href=
"#search" class=
"md-nav__link">
1376 <li class=
"md-nav__item">
1377 <a href=
"#styles" class=
"md-nav__link">
1383 <li class=
"md-nav__item">
1384 <a href=
"#tags" class=
"md-nav__link">
1390 <li class=
"md-nav__item">
1391 <a href=
"#avatars" class=
"md-nav__link">
1409 <li class=
"md-nav__item">
1410 <a href=
"../session/" class=
"md-nav__link">
1411 Session Handling and Authentication
1421 <li class=
"md-nav__item">
1422 <a href=
"../javascript/" class=
"md-nav__link">
1433 <li class=
"md-nav__item">
1434 <a href=
"../templates/" class=
"md-nav__link">
1445 <li class=
"md-nav__item">
1446 <a href=
"../libraries/" class=
"md-nav__link">
1447 Third Party Libraries
1464 <li class=
"md-nav__item md-nav__item--nested">
1467 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1469 <label class=
"md-nav__link" for=
"__nav_6_2">
1470 Migrating from WSC
5.2
1471 <span class=
"md-nav__icon md-icon"></span>
1473 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1474 <label class=
"md-nav__title" for=
"__nav_6_2">
1475 <span class=
"md-nav__icon md-icon"></span>
1476 Migrating from WSC
5.2
1478 <ul class=
"md-nav__list" data-md-scrollfix
>
1484 <li class=
"md-nav__item">
1485 <a href=
"../../wsc52/php/" class=
"md-nav__link">
1496 <li class=
"md-nav__item">
1497 <a href=
"../../wsc52/templates/" class=
"md-nav__link">
1498 Templates and Languages
1508 <li class=
"md-nav__item">
1509 <a href=
"../../wsc52/libraries/" class=
"md-nav__link">
1510 Third Party Libraries
1527 <li class=
"md-nav__item md-nav__item--nested">
1530 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1532 <label class=
"md-nav__link" for=
"__nav_6_3">
1533 Migrating from WSC
3.1
1534 <span class=
"md-nav__icon md-icon"></span>
1536 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1537 <label class=
"md-nav__title" for=
"__nav_6_3">
1538 <span class=
"md-nav__icon md-icon"></span>
1539 Migrating from WSC
3.1
1541 <ul class=
"md-nav__list" data-md-scrollfix
>
1547 <li class=
"md-nav__item">
1548 <a href=
"../../wsc31/php/" class=
"md-nav__link">
1566 <li class=
"md-nav__item md-nav__item--nested">
1569 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1571 <label class=
"md-nav__link" for=
"__nav_6_4">
1572 Migrating from WSC
3.0
1573 <span class=
"md-nav__icon md-icon"></span>
1575 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1576 <label class=
"md-nav__title" for=
"__nav_6_4">
1577 <span class=
"md-nav__icon md-icon"></span>
1578 Migrating from WSC
3.0
1580 <ul class=
"md-nav__list" data-md-scrollfix
>
1586 <li class=
"md-nav__item">
1587 <a href=
"../../wsc30/php/" class=
"md-nav__link">
1598 <li class=
"md-nav__item">
1599 <a href=
"../../wsc30/javascript/" class=
"md-nav__link">
1610 <li class=
"md-nav__item">
1611 <a href=
"../../wsc30/templates/" class=
"md-nav__link">
1622 <li class=
"md-nav__item">
1623 <a href=
"../../wsc30/css/" class=
"md-nav__link">
1634 <li class=
"md-nav__item">
1635 <a href=
"../../wsc30/package/" class=
"md-nav__link">
1653 <li class=
"md-nav__item md-nav__item--nested">
1656 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1658 <label class=
"md-nav__link" for=
"__nav_6_5">
1659 Migrating from WCF
2.1
1660 <span class=
"md-nav__icon md-icon"></span>
1662 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1663 <label class=
"md-nav__title" for=
"__nav_6_5">
1664 <span class=
"md-nav__icon md-icon"></span>
1665 Migrating from WCF
2.1
1667 <ul class=
"md-nav__list" data-md-scrollfix
>
1673 <li class=
"md-nav__item">
1674 <a href=
"../../wcf21/php/" class=
"md-nav__link">
1685 <li class=
"md-nav__item">
1686 <a href=
"../../wcf21/templates/" class=
"md-nav__link">
1697 <li class=
"md-nav__item">
1698 <a href=
"../../wcf21/css/" class=
"md-nav__link">
1709 <li class=
"md-nav__item">
1710 <a href=
"../../wcf21/package/" class=
"md-nav__link">
1737 <li class=
"md-nav__item md-nav__item--nested">
1740 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1742 <label class=
"md-nav__link" for=
"__nav_7">
1744 <span class=
"md-nav__icon md-icon"></span>
1746 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1747 <label class=
"md-nav__title" for=
"__nav_7">
1748 <span class=
"md-nav__icon md-icon"></span>
1751 <ul class=
"md-nav__list" data-md-scrollfix
>
1758 <li class=
"md-nav__item md-nav__item--nested">
1761 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1763 <label class=
"md-nav__link" for=
"__nav_7_1">
1765 <span class=
"md-nav__icon md-icon"></span>
1767 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1768 <label class=
"md-nav__title" for=
"__nav_7_1">
1769 <span class=
"md-nav__icon md-icon"></span>
1772 <ul class=
"md-nav__list" data-md-scrollfix
>
1778 <li class=
"md-nav__item">
1779 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1790 <li class=
"md-nav__item">
1791 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1802 <li class=
"md-nav__item">
1803 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1814 <li class=
"md-nav__item">
1815 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1842 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1843 <div class=
"md-sidebar__scrollwrap">
1844 <div class=
"md-sidebar__inner">
1846 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1852 <label class=
"md-nav__title" for=
"__toc">
1853 <span class=
"md-nav__icon md-icon"></span>
1856 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1858 <li class=
"md-nav__item">
1859 <a href=
"#minimum-requirements" class=
"md-nav__link">
1860 Minimum requirements
1865 <li class=
"md-nav__item">
1866 <a href=
"#flood-control" class=
"md-nav__link">
1872 <li class=
"md-nav__item">
1873 <a href=
"#php-database-api" class=
"md-nav__link">
1879 <li class=
"md-nav__item">
1880 <a href=
"#captcha" class=
"md-nav__link">
1886 <li class=
"md-nav__item">
1887 <a href=
"#search" class=
"md-nav__link">
1893 <li class=
"md-nav__item">
1894 <a href=
"#styles" class=
"md-nav__link">
1900 <li class=
"md-nav__item">
1901 <a href=
"#tags" class=
"md-nav__link">
1907 <li class=
"md-nav__item">
1908 <a href=
"#avatars" class=
"md-nav__link">
1922 <div class=
"md-content" data-md-component=
"content">
1923 <article class=
"md-content__inner md-typeset">
1927 <h1 id=
"migrating-from-wsc-53-php">Migrating from WSC
5.3 - PHP
<a class=
"headerlink" href=
"#migrating-from-wsc-53-php" title=
"Permanent link">#
</a></h1>
1928 <h2 id=
"minimum-requirements">Minimum requirements
<a class=
"headerlink" href=
"#minimum-requirements" title=
"Permanent link">#
</a></h2>
1929 <p>The minimum requirements have been increased to the following:
</p>
1931 <li><strong>PHP:
</strong> 7.2.24</li>
1932 <li><strong>MySQL:
</strong> 5.7.31 or
8.0.19</li>
1933 <li><strong>MariaDB:
</strong> 10.1.44</li>
1935 <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>
1936 <p>It is recommended to make use of scalar types and other newly introduced features whereever possible.
1937 Please refer to the PHP documentation for details.
</p>
1938 <h2 id=
"flood-control">Flood Control
<a class=
"headerlink" href=
"#flood-control" title=
"Permanent link">#
</a></h2>
1939 <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.
1940 With WoltLab Suite
5.4, we have added a general API that manages such rate limiting.
1941 Leveraging this API is easily done.
</p>
1943 <li>Register an object type for the definition
<code>com.woltlab.wcf.floodControl
</code>:
<code>com.example.foo.myContent
</code>.
</li>
1944 <li>Whenever the active user creates content of this type, call
1945 <div class=
"highlight"><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>
1947 You should only call this method if the user creates the content themselves.
1948 If the content is automatically created by the system, for example when copying / duplicating existing content, no activity should be registered.
</li>
1950 <p>To check the last time when the active user created content of the relevant type, use
1951 <div class=
"highlight"><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>
1953 If you want to limit the number of content items created within a certain period of time, for example within one day, use
1954 <div class=
"highlight"><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>
1955 <span class=
"c1">// number of content items created within the last day
</span>
1956 <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>
1957 <span class=
"c1">// timestamp when the earliest content item was created within the last day
</span>
1958 <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>
1960 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>
1961 <div class=
"admonition info">
1962 <p class=
"admonition-title">Flood control entries are only stored for
31 days and older entries are cleaned up daily.
</p>
1966 <p>The previously mentioned methods of
<code>FloodControl
</code> use the active user and the current timestamp as reference point.
1967 <code>FloodControl
</code> also provides methods to register content or check flood control for other registered users or for guests via their IP address.
1968 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>
1969 <div class=
"admonition warning">
1970 <p class=
"admonition-title">Do not interact directly with the flood control database table but only via the
<code>FloodControl
</code> class!
</p>
1972 <h2 id=
"php-database-api">PHP Database API
<a class=
"headerlink" href=
"#php-database-api" title=
"Permanent link">#
</a></h2>
1973 <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>
1974 <div class=
"highlight"><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>
1975 <span class=
"o">-
></span><span class=
"na">columns
</span><span class=
"p">([
</span>
1976 <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>
1977 <span class=
"o">-
></span><span class=
"na">renameTo
</span><span class=
"p">(
</span><span class=
"s1">'newName
'</span><span class=
"p">)
</span>
1978 <span class=
"p">]);
</span>
1980 <div class=
"admonition info">
1981 <p class=
"admonition-title">Like with every change to existing database tables, packages can only rename columns that they installed.
</p>
1983 <h2 id=
"captcha">Captcha
<a class=
"headerlink" href=
"#captcha" title=
"Permanent link">#
</a></h2>
1984 <p>The reCAPTCHA v1 implementation was completely removed.
1985 This includes the
<code>\wcf\system\recaptcha\RecaptchaHandler
</code> class (not to be confused with the one in the
<code>captcha
</code> namespace).
</p>
1986 <p>The reCAPTCHA v1 endpoints have already been turned off by Google and always return a HTTP
404.
1987 Thus the implementation was completely non-functional even before this change.
</p>
1988 <p>See
<a href=
"https://github.com/WoltLab/WCF/pull/3781">WoltLab/WCF#
3781</a> for details.
</p>
1989 <h2 id=
"search">Search
<a class=
"headerlink" href=
"#search" title=
"Permanent link">#
</a></h2>
1990 <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.
1991 The implementation was completely removed:
<code>AbstractSearchEngine::parseSearchQuery()
</code> now always throws a
<code>\BadMethodCallException
</code>.
</p>
1992 <p>If you implemented a custom search engine and relied on this method, you can inline the previous implementation to preserve existing behavior.
1993 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>
1994 <p>See
<a href=
"https://github.com/WoltLab/WCF/issues/3815">WoltLab/WCF#
3815</a> for details.
</p>
1995 <h2 id=
"styles">Styles
<a class=
"headerlink" href=
"#styles" title=
"Permanent link">#
</a></h2>
1996 <p>The
<code>StyleCompiler
</code> class is marked
<code>final
</code> now.
1997 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.
1998 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>
1999 <p>See
<a href=
"https://github.com/WoltLab/WCF/pull/3929">WoltLab/WCF#
3929</a> for details.
</p>
2000 <h2 id=
"tags">Tags
<a class=
"headerlink" href=
"#tags" title=
"Permanent link">#
</a></h2>
2001 <p>Use of the
<code>wcf1_tag_to_object.languageID
</code> column is deprecated.
2002 The
<code>languageID
</code> column is redundant, because its value can be derived from the
<code>tagID
</code>.
2003 With WoltLab Suite
5.4, it will no longer be part of any indices, allowing more efficient index usage in the general case.
</p>
2004 <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>
2005 <p>See
<a href=
"https://github.com/WoltLab/WCF/pull/3904">WoltLab/WCF#
3904</a> for details.
</p>
2006 <h2 id=
"avatars">Avatars
<a class=
"headerlink" href=
"#avatars" title=
"Permanent link">#
</a></h2>
2007 <p>The
<code>ISafeFormatAvatar
</code> interface was added to properly support fallback image types for use in emails.
2008 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>
2009 <p>See
<a href=
"https://github.com/WoltLab/WCF/pull/4001">WoltLab/WCF#
4001</a> for details.
</p>
2023 <footer class=
"md-footer">
2025 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2027 <a href=
"../../../package/database-php-api/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2028 <div class=
"md-footer__button md-icon">
2029 <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>
2031 <div class=
"md-footer__title">
2032 <div class=
"md-ellipsis">
2033 <span class=
"md-footer__direction">
2042 <a href=
"../session/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2043 <div class=
"md-footer__title">
2044 <div class=
"md-ellipsis">
2045 <span class=
"md-footer__direction">
2048 Session Handling and Authentication
2051 <div class=
"md-footer__button md-icon">
2052 <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>
2058 <div class=
"md-footer-meta md-typeset">
2059 <div class=
"md-footer-meta__inner md-grid">
2060 <div class=
"md-footer-copyright">
2062 <div class=
"md-footer-copyright__highlight">
2063 Copyright ©
2020 WoltLab GmbH
2067 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2072 <div class=
"md-footer-copyright">
2073 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2074 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2081 <div class=
"md-dialog" data-md-component=
"dialog">
2082 <div class=
"md-dialog__inner md-typeset"></div>
2084 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../../assets/javascripts/workers/search.fb4a9340.min.js",
"version": {
"provider":
"mike"}}
</script>
2087 <script src=
"../../../assets/javascripts/bundle.5cf3e710.min.js"></script>