3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>PHP API - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ef6f36e2.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <script>function __prefix(e){return new URL(
"../../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
57 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
58 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
59 <label class=
"md-overlay" for=
"__drawer"></label>
60 <div data-md-component=
"skip">
63 <a href=
"#migrating-from-wsc-30-php" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <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" data-md-component=
"logo">
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">
109 <label class=
"md-header__button md-icon" for=
"__search">
110 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
113 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
114 <label class=
"md-search__overlay" for=
"__search"></label>
115 <div class=
"md-search__inner" role=
"search">
116 <form class=
"md-search__form" name=
"search">
117 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
118 <label class=
"md-search__icon md-icon" for=
"__search">
119 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
120 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
122 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
123 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
126 <div class=
"md-search__output">
127 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
128 <div class=
"md-search-result" data-md-component=
"search-result">
129 <div class=
"md-search-result__meta">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
142 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
143 <div class=
"md-source__icon md-icon">
145 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
166 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
167 <div class=
"md-sidebar__scrollwrap">
168 <div class=
"md-sidebar__inner">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
184 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
185 <div class=
"md-source__icon md-icon">
187 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
229 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
230 <label class=
"md-nav__title" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
298 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
299 <label class=
"md-nav__title" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
310 <li class=
"md-nav__item md-nav__item--nested">
313 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
315 <label class=
"md-nav__link" for=
"__nav_2_5_1">
317 <span class=
"md-nav__icon md-icon"></span>
319 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
320 <label class=
"md-nav__title" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
324 <ul class=
"md-nav__list" data-md-scrollfix
>
330 <li class=
"md-nav__item">
331 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
342 <li class=
"md-nav__item">
343 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
354 <li class=
"md-nav__item">
355 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
372 <li class=
"md-nav__item">
373 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../../php/api/events/" class=
"md-nav__link">
409 <li class=
"md-nav__item md-nav__item--nested">
412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
414 <label class=
"md-nav__link" for=
"__nav_2_5_5">
416 <span class=
"md-nav__icon md-icon"></span>
418 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
419 <label class=
"md-nav__title" for=
"__nav_2_5_5">
420 <span class=
"md-nav__icon md-icon"></span>
423 <ul class=
"md-nav__list" data-md-scrollfix
>
429 <li class=
"md-nav__item">
430 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
453 <li class=
"md-nav__item">
454 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
465 <li class=
"md-nav__item">
466 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
495 <li class=
"md-nav__item">
496 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
497 Package Installation Plugins
507 <li class=
"md-nav__item">
508 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
549 <li class=
"md-nav__item">
550 <a href=
"../../../php/code-style/" class=
"md-nav__link">
561 <li class=
"md-nav__item">
562 <a href=
"../../../php/apps/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
595 <li class=
"md-nav__item md-nav__item--nested">
598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
600 <label class=
"md-nav__link" for=
"__nav_3">
601 Languages, Templates & CSS
602 <span class=
"md-nav__icon md-icon"></span>
604 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
605 <label class=
"md-nav__title" for=
"__nav_3">
606 <span class=
"md-nav__icon md-icon"></span>
607 Languages, Templates & CSS
609 <ul class=
"md-nav__list" data-md-scrollfix
>
615 <li class=
"md-nav__item">
616 <a href=
"../../../view/languages/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../../../view/templates/" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"../../../view/css/" class=
"md-nav__link">
673 <li class=
"md-nav__item md-nav__item--nested">
676 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
678 <label class=
"md-nav__link" for=
"__nav_4">
679 TypeScript and JavaScript API
680 <span class=
"md-nav__icon md-icon"></span>
682 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
683 <label class=
"md-nav__title" for=
"__nav_4">
684 <span class=
"md-nav__icon md-icon"></span>
685 TypeScript and JavaScript API
687 <ul class=
"md-nav__list" data-md-scrollfix
>
693 <li class=
"md-nav__item">
694 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
705 <li class=
"md-nav__item">
706 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
718 <li class=
"md-nav__item md-nav__item--nested">
721 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
723 <label class=
"md-nav__link" for=
"__nav_4_3">
725 <span class=
"md-nav__icon md-icon"></span>
727 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
728 <label class=
"md-nav__title" for=
"__nav_4_3">
729 <span class=
"md-nav__icon md-icon"></span>
732 <ul class=
"md-nav__list" data-md-scrollfix
>
738 <li class=
"md-nav__item">
739 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
750 <li class=
"md-nav__item">
751 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
762 <li class=
"md-nav__item">
763 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
774 <li class=
"md-nav__item">
775 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
786 <li class=
"md-nav__item">
787 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
798 <li class=
"md-nav__item">
799 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
810 <li class=
"md-nav__item">
811 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
822 <li class=
"md-nav__item">
823 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
824 Browser and Screen Sizes
834 <li class=
"md-nav__item">
835 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
852 <li class=
"md-nav__item">
853 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
864 <li class=
"md-nav__item">
865 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
876 <li class=
"md-nav__item">
877 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
898 <li class=
"md-nav__item md-nav__item--nested">
901 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
903 <label class=
"md-nav__link" for=
"__nav_5">
905 <span class=
"md-nav__icon md-icon"></span>
907 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
908 <label class=
"md-nav__title" for=
"__nav_5">
909 <span class=
"md-nav__icon md-icon"></span>
912 <ul class=
"md-nav__list" data-md-scrollfix
>
918 <li class=
"md-nav__item">
919 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
931 <li class=
"md-nav__item md-nav__item--nested">
934 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
936 <label class=
"md-nav__link" for=
"__nav_5_2">
938 <span class=
"md-nav__icon md-icon"></span>
940 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
941 <label class=
"md-nav__title" for=
"__nav_5_2">
942 <span class=
"md-nav__icon md-icon"></span>
945 <ul class=
"md-nav__list" data-md-scrollfix
>
951 <li class=
"md-nav__item">
952 <a href=
"../../../package/pip/" class=
"md-nav__link">
963 <li class=
"md-nav__item">
964 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
975 <li class=
"md-nav__item">
976 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
987 <li class=
"md-nav__item">
988 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
999 <li class=
"md-nav__item">
1000 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1011 <li class=
"md-nav__item">
1012 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1023 <li class=
"md-nav__item">
1024 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1035 <li class=
"md-nav__item">
1036 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1047 <li class=
"md-nav__item">
1048 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1059 <li class=
"md-nav__item">
1060 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1071 <li class=
"md-nav__item">
1072 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1083 <li class=
"md-nav__item">
1084 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1095 <li class=
"md-nav__item">
1096 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1107 <li class=
"md-nav__item">
1108 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1119 <li class=
"md-nav__item">
1120 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1131 <li class=
"md-nav__item">
1132 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1143 <li class=
"md-nav__item">
1144 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1155 <li class=
"md-nav__item">
1156 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1167 <li class=
"md-nav__item">
1168 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1169 objectTypeDefinition
1179 <li class=
"md-nav__item">
1180 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1191 <li class=
"md-nav__item">
1192 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1203 <li class=
"md-nav__item">
1204 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1215 <li class=
"md-nav__item">
1216 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1227 <li class=
"md-nav__item">
1228 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1239 <li class=
"md-nav__item">
1240 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1251 <li class=
"md-nav__item">
1252 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1263 <li class=
"md-nav__item">
1264 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1275 <li class=
"md-nav__item">
1276 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1287 <li class=
"md-nav__item">
1288 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1299 <li class=
"md-nav__item">
1300 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1311 <li class=
"md-nav__item">
1312 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1313 userNotificationEvent
1323 <li class=
"md-nav__item">
1324 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1335 <li class=
"md-nav__item">
1336 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1353 <li class=
"md-nav__item">
1354 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1377 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1380 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" checked
>
1382 <label class=
"md-nav__link" for=
"__nav_6">
1384 <span class=
"md-nav__icon md-icon"></span>
1386 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1387 <label class=
"md-nav__title" for=
"__nav_6">
1388 <span class=
"md-nav__icon md-icon"></span>
1391 <ul class=
"md-nav__list" data-md-scrollfix
>
1398 <li class=
"md-nav__item md-nav__item--nested">
1401 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1403 <label class=
"md-nav__link" for=
"__nav_6_1">
1404 Migrating from WSC
5.3
1405 <span class=
"md-nav__icon md-icon"></span>
1407 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1408 <label class=
"md-nav__title" for=
"__nav_6_1">
1409 <span class=
"md-nav__icon md-icon"></span>
1410 Migrating from WSC
5.3
1412 <ul class=
"md-nav__list" data-md-scrollfix
>
1418 <li class=
"md-nav__item">
1419 <a href=
"../../wsc53/php/" class=
"md-nav__link">
1430 <li class=
"md-nav__item">
1431 <a href=
"../../wsc53/session/" class=
"md-nav__link">
1432 Session Handling and Authentication
1442 <li class=
"md-nav__item">
1443 <a href=
"../../wsc53/javascript/" class=
"md-nav__link">
1444 TypeScript and JavaScript
1454 <li class=
"md-nav__item">
1455 <a href=
"../../wsc53/templates/" class=
"md-nav__link">
1466 <li class=
"md-nav__item">
1467 <a href=
"../../wsc53/libraries/" class=
"md-nav__link">
1468 Third Party Libraries
1485 <li class=
"md-nav__item md-nav__item--nested">
1488 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1490 <label class=
"md-nav__link" for=
"__nav_6_2">
1491 Migrating from WSC
5.2
1492 <span class=
"md-nav__icon md-icon"></span>
1494 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1495 <label class=
"md-nav__title" for=
"__nav_6_2">
1496 <span class=
"md-nav__icon md-icon"></span>
1497 Migrating from WSC
5.2
1499 <ul class=
"md-nav__list" data-md-scrollfix
>
1505 <li class=
"md-nav__item">
1506 <a href=
"../../wsc52/php/" class=
"md-nav__link">
1517 <li class=
"md-nav__item">
1518 <a href=
"../../wsc52/templates/" class=
"md-nav__link">
1519 Templates and Languages
1529 <li class=
"md-nav__item">
1530 <a href=
"../../wsc52/libraries/" class=
"md-nav__link">
1531 Third Party Libraries
1548 <li class=
"md-nav__item md-nav__item--nested">
1551 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1553 <label class=
"md-nav__link" for=
"__nav_6_3">
1554 Migrating from WSC
3.1
1555 <span class=
"md-nav__icon md-icon"></span>
1557 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1558 <label class=
"md-nav__title" for=
"__nav_6_3">
1559 <span class=
"md-nav__icon md-icon"></span>
1560 Migrating from WSC
3.1
1562 <ul class=
"md-nav__list" data-md-scrollfix
>
1568 <li class=
"md-nav__item">
1569 <a href=
"../../wsc31/php/" class=
"md-nav__link">
1589 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1592 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" checked
>
1594 <label class=
"md-nav__link" for=
"__nav_6_4">
1595 Migrating from WSC
3.0
1596 <span class=
"md-nav__icon md-icon"></span>
1598 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1599 <label class=
"md-nav__title" for=
"__nav_6_4">
1600 <span class=
"md-nav__icon md-icon"></span>
1601 Migrating from WSC
3.0
1603 <ul class=
"md-nav__list" data-md-scrollfix
>
1611 <li class=
"md-nav__item md-nav__item--active">
1613 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1618 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1620 <span class=
"md-nav__icon md-icon"></span>
1623 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1628 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1634 <label class=
"md-nav__title" for=
"__toc">
1635 <span class=
"md-nav__icon md-icon"></span>
1638 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1640 <li class=
"md-nav__item">
1641 <a href=
"#approval-system-for-comments" class=
"md-nav__link">
1642 Approval-System for Comments
1647 <li class=
"md-nav__item">
1648 <a href=
"#raw-html-in-user-activity-events" class=
"md-nav__link">
1649 Raw HTML in User Activity Events
1654 <li class=
"md-nav__item">
1655 <a href=
"#permission-to-view-likes-of-an-object" class=
"md-nav__link">
1656 Permission to View Likes of an Object
1661 <li class=
"md-nav__item">
1662 <a href=
"#developer-tools-sync-feature" class=
"md-nav__link">
1663 Developer Tools: Sync Feature
1668 <li class=
"md-nav__item">
1669 <a href=
"#media-providers" class=
"md-nav__link">
1673 <nav class=
"md-nav" aria-label=
"Media Providers">
1674 <ul class=
"md-nav__list">
1676 <li class=
"md-nav__item">
1677 <a href=
"#example-implementation" class=
"md-nav__link">
1678 Example Implementation
1681 <nav class=
"md-nav" aria-label=
"Example Implementation">
1682 <ul class=
"md-nav__list">
1684 <li class=
"md-nav__item">
1685 <a href=
"#mediaproviderxml" class=
"md-nav__link">
1691 <li class=
"md-nav__item">
1692 <a href=
"#php-callback" class=
"md-nav__link">
1708 <li class=
"md-nav__item">
1709 <a href=
"#re-evaluate-html-messages" class=
"md-nav__link">
1710 Re-Evaluate HTML Messages
1713 <nav class=
"md-nav" aria-label=
"Re-Evaluate HTML Messages">
1714 <ul class=
"md-nav__list">
1716 <li class=
"md-nav__item">
1717 <a href=
"#example-usage" class=
"md-nav__link">
1740 <li class=
"md-nav__item">
1741 <a href=
"../javascript/" class=
"md-nav__link">
1752 <li class=
"md-nav__item">
1753 <a href=
"../templates/" class=
"md-nav__link">
1764 <li class=
"md-nav__item">
1765 <a href=
"../css/" class=
"md-nav__link">
1776 <li class=
"md-nav__item">
1777 <a href=
"../package/" class=
"md-nav__link">
1795 <li class=
"md-nav__item md-nav__item--nested">
1798 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1800 <label class=
"md-nav__link" for=
"__nav_6_5">
1801 Migrating from WCF
2.1
1802 <span class=
"md-nav__icon md-icon"></span>
1804 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1805 <label class=
"md-nav__title" for=
"__nav_6_5">
1806 <span class=
"md-nav__icon md-icon"></span>
1807 Migrating from WCF
2.1
1809 <ul class=
"md-nav__list" data-md-scrollfix
>
1815 <li class=
"md-nav__item">
1816 <a href=
"../../wcf21/php/" class=
"md-nav__link">
1827 <li class=
"md-nav__item">
1828 <a href=
"../../wcf21/templates/" class=
"md-nav__link">
1839 <li class=
"md-nav__item">
1840 <a href=
"../../wcf21/css/" class=
"md-nav__link">
1851 <li class=
"md-nav__item">
1852 <a href=
"../../wcf21/package/" class=
"md-nav__link">
1879 <li class=
"md-nav__item md-nav__item--nested">
1882 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1884 <label class=
"md-nav__link" for=
"__nav_7">
1886 <span class=
"md-nav__icon md-icon"></span>
1888 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1889 <label class=
"md-nav__title" for=
"__nav_7">
1890 <span class=
"md-nav__icon md-icon"></span>
1893 <ul class=
"md-nav__list" data-md-scrollfix
>
1900 <li class=
"md-nav__item md-nav__item--nested">
1903 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1905 <label class=
"md-nav__link" for=
"__nav_7_1">
1907 <span class=
"md-nav__icon md-icon"></span>
1909 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1910 <label class=
"md-nav__title" for=
"__nav_7_1">
1911 <span class=
"md-nav__icon md-icon"></span>
1914 <ul class=
"md-nav__list" data-md-scrollfix
>
1920 <li class=
"md-nav__item">
1921 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1932 <li class=
"md-nav__item">
1933 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1944 <li class=
"md-nav__item">
1945 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1956 <li class=
"md-nav__item">
1957 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1984 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1985 <div class=
"md-sidebar__scrollwrap">
1986 <div class=
"md-sidebar__inner">
1988 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1994 <label class=
"md-nav__title" for=
"__toc">
1995 <span class=
"md-nav__icon md-icon"></span>
1998 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2000 <li class=
"md-nav__item">
2001 <a href=
"#approval-system-for-comments" class=
"md-nav__link">
2002 Approval-System for Comments
2007 <li class=
"md-nav__item">
2008 <a href=
"#raw-html-in-user-activity-events" class=
"md-nav__link">
2009 Raw HTML in User Activity Events
2014 <li class=
"md-nav__item">
2015 <a href=
"#permission-to-view-likes-of-an-object" class=
"md-nav__link">
2016 Permission to View Likes of an Object
2021 <li class=
"md-nav__item">
2022 <a href=
"#developer-tools-sync-feature" class=
"md-nav__link">
2023 Developer Tools: Sync Feature
2028 <li class=
"md-nav__item">
2029 <a href=
"#media-providers" class=
"md-nav__link">
2033 <nav class=
"md-nav" aria-label=
"Media Providers">
2034 <ul class=
"md-nav__list">
2036 <li class=
"md-nav__item">
2037 <a href=
"#example-implementation" class=
"md-nav__link">
2038 Example Implementation
2041 <nav class=
"md-nav" aria-label=
"Example Implementation">
2042 <ul class=
"md-nav__list">
2044 <li class=
"md-nav__item">
2045 <a href=
"#mediaproviderxml" class=
"md-nav__link">
2051 <li class=
"md-nav__item">
2052 <a href=
"#php-callback" class=
"md-nav__link">
2068 <li class=
"md-nav__item">
2069 <a href=
"#re-evaluate-html-messages" class=
"md-nav__link">
2070 Re-Evaluate HTML Messages
2073 <nav class=
"md-nav" aria-label=
"Re-Evaluate HTML Messages">
2074 <ul class=
"md-nav__list">
2076 <li class=
"md-nav__item">
2077 <a href=
"#example-usage" class=
"md-nav__link">
2096 <div class=
"md-content" data-md-component=
"content">
2097 <article class=
"md-content__inner md-typeset">
2100 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/migration/wsc30/php.md" title=
"Edit this page" class=
"md-content__button md-icon">
2101 <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>
2105 <h1 id=
"migrating-from-wsc-30-php">Migrating from WSC
3.0 - PHP
<a class=
"headerlink" href=
"#migrating-from-wsc-30-php" title=
"Permanent link">#
</a></h1>
2106 <h2 id=
"approval-system-for-comments">Approval-System for Comments
<a class=
"headerlink" href=
"#approval-system-for-comments" title=
"Permanent link">#
</a></h2>
2107 <p>Comments can now be set to require approval by a moderator before being published. This feature is disabled by default if you do not provide a permission in the manager class, enabling it requires a new permission that has to be provided in a special property of your manage implementation.
</p>
2108 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2109 <span class=
"k">class
</span> <span class=
"nc">ExampleCommentManager
</span> <span class=
"k">extends
</span> <span class=
"nx">AbstractCommentManager
</span> <span class=
"p">{
</span>
2110 <span class=
"k">protected
</span> <span class=
"nv">$permissionAddWithoutModeration
</span> <span class=
"o">=
</span> <span class=
"s1">'foo.bar.example.canAddCommentWithoutModeration
'</span><span class=
"p">;
</span>
2111 <span class=
"p">}
</span>
2113 <h2 id=
"raw-html-in-user-activity-events">Raw HTML in User Activity Events
<a class=
"headerlink" href=
"#raw-html-in-user-activity-events" title=
"Permanent link">#
</a></h2>
2114 <p>User activity events were previously encapsulated inside
<code><div
class=
"htmlContent">…
</div
></code>, with impacts on native elements such as lists. You can now disable the class usage by defining your event as raw HTML:
</p>
2115 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2116 <span class=
"k">class
</span> <span class=
"nc">ExampleUserActivityEvent
</span> <span class=
"p">{
</span>
2117 <span class=
"c1">// enables raw HTML for output, defaults to `false`
</span>
2118 <span class=
"k">protected
</span> <span class=
"nv">$isRawHtml
</span> <span class=
"o">=
</span> <span class=
"k">true
</span><span class=
"p">;
</span>
2119 <span class=
"p">}
</span>
2121 <h2 id=
"permission-to-view-likes-of-an-object">Permission to View Likes of an Object
<a class=
"headerlink" href=
"#permission-to-view-likes-of-an-object" title=
"Permanent link">#
</a></h2>
2122 <p>Being able to view the like summary of an object was restricted to users that were able to like the object itself. This creates situations where the object type in general is likable, but the particular object cannot be liked by the current users, while also denying them to view the like summary (but it gets partly exposed through the footer note/summary!).
</p>
2123 <p>Implement the interface
<code>\wcf\data\like\IRestrictedLikeObjectTypeProvider
</code> in your object provider to add support for this new permission check.
</p>
2124 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2125 <span class=
"k">class
</span> <span class=
"nc">LikeableExampleProvider
</span> <span class=
"k">extends
</span> <span class=
"nx">ExampleProvider
</span> <span class=
"k">implements
</span> <span class=
"nx">IRestrictedLikeObjectTypeProvider
</span><span class=
"p">,
</span> <span class=
"nx">IViewableLikeProvider
</span> <span class=
"p">{
</span>
2126 <span class=
"k">public
</span> <span class=
"k">function
</span> <span class=
"nf">canViewLikes
</span><span class=
"p">(
</span><span class=
"nx">ILikeObject
</span> <span class=
"nv">$object
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2127 <span class=
"c1">// perform your permission checks here
</span>
2128 <span class=
"k">return
</span> <span class=
"k">true
</span><span class=
"p">;
</span>
2129 <span class=
"p">}
</span>
2130 <span class=
"p">}
</span>
2132 <h2 id=
"developer-tools-sync-feature">Developer Tools: Sync Feature
<a class=
"headerlink" href=
"#developer-tools-sync-feature" title=
"Permanent link">#
</a></h2>
2133 <p>The synchronization feature of the newly added developer tools works by invoking a package installation plugin (PIP) outside of a regular installation, while simulating the basic environment that is already exposed by the API.
</p>
2134 <p>However, not all PIPs qualify for this kind of execution, especially because it could be invoked multiple times in a row by the user. This is solved by requiring a special marking for PIPs that have no side-effects (= idempotent) when invoked any amount of times with the same arguments.
</p>
2135 <p>There's another feature that allows all matching PIPs to be executed in a row using a single button click. In order to solve dependencies on other PIPs, any implementing PIP must also provide the method
<code>getSyncDependencies()
</code> that returns the dependent PIPs in an arbitrary order.
</p>
2136 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2137 <span class=
"k">class
</span> <span class=
"nc">ExamplePackageInstallationPlugin
</span> <span class=
"k">extends
</span> <span class=
"nx">AbstractXMLPackageInstallationPlugin
</span> <span class=
"k">implements
</span> <span class=
"nx">IIdempotentPackageInstallationPlugin
</span> <span class=
"p">{
</span>
2138 <span class=
"k">public
</span> <span class=
"k">static
</span> <span class=
"k">function
</span> <span class=
"nf">getSyncDependencies
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2139 <span class=
"c1">// provide a list of dependent PIPs in arbitrary order
</span>
2140 <span class=
"k">return
</span> <span class=
"p">[];
</span>
2141 <span class=
"p">}
</span>
2142 <span class=
"p">}
</span>
2144 <h2 id=
"media-providers">Media Providers
<a class=
"headerlink" href=
"#media-providers" title=
"Permanent link">#
</a></h2>
2145 <p>Media providers were added through regular SQL queries in earlier versions, but this is neither convenient, nor did it offer a reliable method to update an existing provider. WoltLab Suite
3.1 adds a new
<code>mediaProvider
</code>-PIP that also offers a
<code>className
</code> parameter to off-load the result evaluation and HTML generation.
</p>
2146 <h3 id=
"example-implementation">Example Implementation
<a class=
"headerlink" href=
"#example-implementation" title=
"Permanent link">#
</a></h3>
2147 <h4 id=
"mediaproviderxml">mediaProvider.xml
<a class=
"headerlink" href=
"#mediaproviderxml" title=
"Permanent link">#
</a></h4>
2148 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
2149 <span class=
"nt"><data
</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/tornado/mediaProvider.xsd
"</span><span class=
"nt">></span>
2150 <span class=
"nt"><import
></span>
2151 <span class=
"nt"><provider
</span> <span class=
"na">name=
</span><span class=
"s">"example
"</span><span class=
"nt">></span>
2152 <span class=
"nt"><title
></span>Example Provider
<span class=
"nt"></title
></span>
2153 <span class=
"nt"><regex
></span><span class=
"cp"><![CDATA[https?://example.com/watch?v=(?P
<ID
>[a-zA-Z0-
9])]]
></span><span class=
"nt"></regex
></span>
2154 <span class=
"nt"><className
></span><span class=
"cp"><![CDATA[wcf\system\bbcode\media\provider\ExampleBBCodeMediaProvider]]
></span><span class=
"nt"></className
></span>
2155 <span class=
"nt"></provider
></span>
2156 <span class=
"nt"></import
></span>
2157 <span class=
"nt"></data
></span>
2159 <h4 id=
"php-callback">PHP Callback
<a class=
"headerlink" href=
"#php-callback" title=
"Permanent link">#
</a></h4>
2160 <p>The full match is provided for
<code>$url
</code>, while any capture groups from the regular expression are assigned to
<code>$matches
</code>.
</p>
2161 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2162 <span class=
"k">class
</span> <span class=
"nc">ExampleBBCodeMediaProvider
</span> <span class=
"k">implements
</span> <span class=
"nx">IBBCodeMediaProvider
</span> <span class=
"p">{
</span>
2163 <span class=
"k">public
</span> <span class=
"k">function
</span> <span class=
"nf">parse
</span><span class=
"p">(
</span><span class=
"nv">$url
</span><span class=
"p">,
</span> <span class=
"k">array
</span> <span class=
"nv">$matches
</span> <span class=
"o">=
</span> <span class=
"p">[])
</span> <span class=
"p">{
</span>
2164 <span class=
"k">return
</span> <span class=
"s2">"final HTML output
"</span><span class=
"p">;
</span>
2165 <span class=
"p">}
</span>
2166 <span class=
"p">}
</span>
2168 <h2 id=
"re-evaluate-html-messages">Re-Evaluate HTML Messages
<a class=
"headerlink" href=
"#re-evaluate-html-messages" title=
"Permanent link">#
</a></h2>
2169 <div class=
"admonition warning">
2170 <p class=
"admonition-title">You need to manually set the disallowed bbcodes in order to avoid unintentional bbcode evaluation. Please see
<a href=
"https://github.com/WoltLab/WCF/commit/7e058783da1378dda5393a9bb4df9cfe94e5b394">this commit
</a> for a reference implementation inside worker processes.
</p>
2172 <p>The HtmlInputProcessor only supported two ways to handle an existing HTML message:
</p>
2174 <li>Load the string through
<code>process()
</code> and run it through the validation and sanitation process, both of them are rather expensive operations and do not qualify for rebuild data workers.
</li>
2175 <li>Detect embedded content using
<code>processEmbeddedContent()
</code> which bypasses most tasks that are carried out by
<code>process()
</code> which aren't required, but does not allow a modification of the message.
</li>
2177 <p>The newly added method
<code>reprocess($message, $objectType, $objectID)
</code> solves this short-coming by offering a full bbcode and text re-evaluation while bypassing any input filters, assuming that the input HTML was already filtered previously.
</p>
2178 <h3 id=
"example-usage">Example Usage
<a class=
"headerlink" href=
"#example-usage" title=
"Permanent link">#
</a></h3>
2179 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2180 <span class=
"c1">// rebuild data workers tend to contain code similar to this:
</span>
2181 <span class=
"k">foreach
</span> <span class=
"p">(
</span><span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">objectList
</span> <span class=
"k">as
</span> <span class=
"nv">$message
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2182 <span class=
"c1">// ...
</span>
2183 <span class=
"k">if
</span> <span class=
"p">(
</span><span class=
"o">!
</span><span class=
"nv">$message
</span><span class=
"o">-
></span><span class=
"na">enableHtml
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2184 <span class=
"c1">// ...
</span>
2185 <span class=
"p">}
</span>
2186 <span class=
"k">else
</span> <span class=
"p">{
</span>
2187 <span class=
"c1">// OLD:
</span>
2188 <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">getHtmlInputProcessor
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">processEmbeddedContent
</span><span class=
"p">(
</span><span class=
"nv">$message
</span><span class=
"o">-
></span><span class=
"na">message
</span><span class=
"p">,
</span> <span class=
"s1">'com.example.foo.message
'</span><span class=
"p">,
</span> <span class=
"nv">$message
</span><span class=
"o">-
></span><span class=
"na">messageID
</span><span class=
"p">);
</span>
2190 <span class=
"c1">// REPLACE WITH:
</span>
2191 <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">getHtmlInputProcessor
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">reprocess
</span><span class=
"p">(
</span><span class=
"nv">$message
</span><span class=
"o">-
></span><span class=
"na">message
</span><span class=
"p">,
</span> <span class=
"s1">'com.example.foo.message
'</span><span class=
"p">,
</span> <span class=
"nv">$message
</span><span class=
"o">-
></span><span class=
"na">messageID
</span><span class=
"p">);
</span>
2192 <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'message
'</span><span class=
"p">]
</span> <span class=
"o">=
</span> <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">getHtmlInputProcessor
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">getHtml
</span><span class=
"p">();
</span>
2193 <span class=
"p">}
</span>
2194 <span class=
"c1">// ...
</span>
2195 <span class=
"p">}
</span>
2202 <div class=
"md-source-date">
2205 Last update:
2021-
01-
08
2224 <footer class=
"md-footer">
2226 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2228 <a href=
"../../wsc31/php/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2229 <div class=
"md-footer__button md-icon">
2230 <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>
2232 <div class=
"md-footer__title">
2233 <div class=
"md-ellipsis">
2234 <span class=
"md-footer__direction">
2243 <a href=
"../javascript/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2244 <div class=
"md-footer__title">
2245 <div class=
"md-ellipsis">
2246 <span class=
"md-footer__direction">
2252 <div class=
"md-footer__button md-icon">
2253 <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>
2259 <div class=
"md-footer-meta md-typeset">
2260 <div class=
"md-footer-meta__inner md-grid">
2261 <div class=
"md-footer-copyright">
2263 <div class=
"md-footer-copyright__highlight">
2264 Copyright ©
2020 WoltLab GmbH
2268 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2273 <div class=
"md-footer-copyright">
2274 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2275 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2282 <div class=
"md-dialog" data-md-component=
"dialog">
2283 <div class=
"md-dialog__inner md-typeset"></div>
2285 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../../assets/javascripts/workers/search.fe42c31b.min.js",
"version": {
"provider":
"mike"}}
</script>
2288 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>