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>Comments - 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=
"#comments" 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">
222 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
225 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" checked
>
227 <label class=
"md-nav__link" for=
"__nav_2">
229 <span class=
"md-nav__icon md-icon"></span>
231 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
232 <label class=
"md-nav__title" for=
"__nav_2">
233 <span class=
"md-nav__icon md-icon"></span>
236 <ul class=
"md-nav__list" data-md-scrollfix
>
242 <li class=
"md-nav__item">
243 <a href=
"../../pages/" class=
"md-nav__link">
254 <li class=
"md-nav__item">
255 <a href=
"../../database-objects/" class=
"md-nav__link">
266 <li class=
"md-nav__item">
267 <a href=
"../../database-access/" class=
"md-nav__link">
278 <li class=
"md-nav__item">
279 <a href=
"../../exceptions/" class=
"md-nav__link">
293 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
296 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" checked
>
298 <label class=
"md-nav__link" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
302 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
303 <label class=
"md-nav__title" for=
"__nav_2_5">
304 <span class=
"md-nav__icon md-icon"></span>
307 <ul class=
"md-nav__list" data-md-scrollfix
>
314 <li class=
"md-nav__item md-nav__item--nested">
317 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
319 <label class=
"md-nav__link" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
323 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
324 <label class=
"md-nav__title" for=
"__nav_2_5_1">
325 <span class=
"md-nav__icon md-icon"></span>
328 <ul class=
"md-nav__list" data-md-scrollfix
>
334 <li class=
"md-nav__item">
335 <a href=
"../caches/" class=
"md-nav__link">
346 <li class=
"md-nav__item">
347 <a href=
"../caches_persistent-caches/" class=
"md-nav__link">
358 <li class=
"md-nav__item">
359 <a href=
"../caches_runtime-caches/" class=
"md-nav__link">
378 <li class=
"md-nav__item md-nav__item--active">
380 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
385 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
387 <span class=
"md-nav__icon md-icon"></span>
390 <a href=
"./" class=
"md-nav__link md-nav__link--active">
395 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
401 <label class=
"md-nav__title" for=
"__toc">
402 <span class=
"md-nav__icon md-icon"></span>
405 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
407 <li class=
"md-nav__item">
408 <a href=
"#user-group-options" class=
"md-nav__link">
412 <nav class=
"md-nav" aria-label=
"User Group Options">
413 <ul class=
"md-nav__list">
415 <li class=
"md-nav__item">
416 <a href=
"#language-items" class=
"md-nav__link">
420 <nav class=
"md-nav" aria-label=
"Language Items">
421 <ul class=
"md-nav__list">
423 <li class=
"md-nav__item">
424 <a href=
"#user-group-options_1" class=
"md-nav__link">
452 <li class=
"md-nav__item">
453 <a href=
"../cronjobs/" class=
"md-nav__link">
464 <li class=
"md-nav__item">
465 <a href=
"../events/" class=
"md-nav__link">
477 <li class=
"md-nav__item md-nav__item--nested">
480 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
482 <label class=
"md-nav__link" for=
"__nav_2_5_5">
484 <span class=
"md-nav__icon md-icon"></span>
486 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
487 <label class=
"md-nav__title" for=
"__nav_2_5_5">
488 <span class=
"md-nav__icon md-icon"></span>
491 <ul class=
"md-nav__list" data-md-scrollfix
>
497 <li class=
"md-nav__item">
498 <a href=
"../form_builder/overview/" class=
"md-nav__link">
509 <li class=
"md-nav__item">
510 <a href=
"../form_builder/structure/" class=
"md-nav__link">
521 <li class=
"md-nav__item">
522 <a href=
"../form_builder/form_fields/" class=
"md-nav__link">
533 <li class=
"md-nav__item">
534 <a href=
"../form_builder/validation_data/" class=
"md-nav__link">
545 <li class=
"md-nav__item">
546 <a href=
"../form_builder/dependencies/" class=
"md-nav__link">
563 <li class=
"md-nav__item">
564 <a href=
"../package_installation_plugins/" class=
"md-nav__link">
565 Package Installation Plugins
575 <li class=
"md-nav__item">
576 <a href=
"../user_activity_points/" class=
"md-nav__link">
587 <li class=
"md-nav__item">
588 <a href=
"../user_notifications/" class=
"md-nav__link">
599 <li class=
"md-nav__item">
600 <a href=
"../sitemaps/" class=
"md-nav__link">
617 <li class=
"md-nav__item">
618 <a href=
"../../code-style/" class=
"md-nav__link">
629 <li class=
"md-nav__item">
630 <a href=
"../../apps/" class=
"md-nav__link">
641 <li class=
"md-nav__item">
642 <a href=
"../../gdpr/" class=
"md-nav__link">
663 <li class=
"md-nav__item md-nav__item--nested">
666 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
668 <label class=
"md-nav__link" for=
"__nav_3">
669 Languages, Templates & CSS
670 <span class=
"md-nav__icon md-icon"></span>
672 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
673 <label class=
"md-nav__title" for=
"__nav_3">
674 <span class=
"md-nav__icon md-icon"></span>
675 Languages, Templates & CSS
677 <ul class=
"md-nav__list" data-md-scrollfix
>
683 <li class=
"md-nav__item">
684 <a href=
"../../../view/languages/" class=
"md-nav__link">
695 <li class=
"md-nav__item">
696 <a href=
"../../../view/templates/" class=
"md-nav__link">
707 <li class=
"md-nav__item">
708 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
719 <li class=
"md-nav__item">
720 <a href=
"../../../view/css/" class=
"md-nav__link">
741 <li class=
"md-nav__item md-nav__item--nested">
744 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
746 <label class=
"md-nav__link" for=
"__nav_4">
747 TypeScript and JavaScript API
748 <span class=
"md-nav__icon md-icon"></span>
750 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
751 <label class=
"md-nav__title" for=
"__nav_4">
752 <span class=
"md-nav__icon md-icon"></span>
753 TypeScript and JavaScript API
755 <ul class=
"md-nav__list" data-md-scrollfix
>
761 <li class=
"md-nav__item">
762 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
773 <li class=
"md-nav__item">
774 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
786 <li class=
"md-nav__item md-nav__item--nested">
789 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
791 <label class=
"md-nav__link" for=
"__nav_4_3">
793 <span class=
"md-nav__icon md-icon"></span>
795 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
796 <label class=
"md-nav__title" for=
"__nav_4_3">
797 <span class=
"md-nav__icon md-icon"></span>
800 <ul class=
"md-nav__list" data-md-scrollfix
>
806 <li class=
"md-nav__item">
807 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
818 <li class=
"md-nav__item">
819 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
830 <li class=
"md-nav__item">
831 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
842 <li class=
"md-nav__item">
843 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
854 <li class=
"md-nav__item">
855 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
866 <li class=
"md-nav__item">
867 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
878 <li class=
"md-nav__item">
879 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
890 <li class=
"md-nav__item">
891 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
892 Browser and Screen Sizes
902 <li class=
"md-nav__item">
903 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
920 <li class=
"md-nav__item">
921 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
932 <li class=
"md-nav__item">
933 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
944 <li class=
"md-nav__item">
945 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
966 <li class=
"md-nav__item md-nav__item--nested">
969 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
971 <label class=
"md-nav__link" for=
"__nav_5">
973 <span class=
"md-nav__icon md-icon"></span>
975 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
976 <label class=
"md-nav__title" for=
"__nav_5">
977 <span class=
"md-nav__icon md-icon"></span>
980 <ul class=
"md-nav__list" data-md-scrollfix
>
986 <li class=
"md-nav__item">
987 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
999 <li class=
"md-nav__item md-nav__item--nested">
1002 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1004 <label class=
"md-nav__link" for=
"__nav_5_2">
1006 <span class=
"md-nav__icon md-icon"></span>
1008 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1009 <label class=
"md-nav__title" for=
"__nav_5_2">
1010 <span class=
"md-nav__icon md-icon"></span>
1013 <ul class=
"md-nav__list" data-md-scrollfix
>
1019 <li class=
"md-nav__item">
1020 <a href=
"../../../package/pip/" class=
"md-nav__link">
1031 <li class=
"md-nav__item">
1032 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
1043 <li class=
"md-nav__item">
1044 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
1055 <li class=
"md-nav__item">
1056 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
1067 <li class=
"md-nav__item">
1068 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1079 <li class=
"md-nav__item">
1080 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1091 <li class=
"md-nav__item">
1092 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1103 <li class=
"md-nav__item">
1104 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1115 <li class=
"md-nav__item">
1116 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1127 <li class=
"md-nav__item">
1128 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1139 <li class=
"md-nav__item">
1140 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1151 <li class=
"md-nav__item">
1152 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1163 <li class=
"md-nav__item">
1164 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1175 <li class=
"md-nav__item">
1176 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1187 <li class=
"md-nav__item">
1188 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1199 <li class=
"md-nav__item">
1200 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1211 <li class=
"md-nav__item">
1212 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1223 <li class=
"md-nav__item">
1224 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1235 <li class=
"md-nav__item">
1236 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1237 objectTypeDefinition
1247 <li class=
"md-nav__item">
1248 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1259 <li class=
"md-nav__item">
1260 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1271 <li class=
"md-nav__item">
1272 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1283 <li class=
"md-nav__item">
1284 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1295 <li class=
"md-nav__item">
1296 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1307 <li class=
"md-nav__item">
1308 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1319 <li class=
"md-nav__item">
1320 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1331 <li class=
"md-nav__item">
1332 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1343 <li class=
"md-nav__item">
1344 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1355 <li class=
"md-nav__item">
1356 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1367 <li class=
"md-nav__item">
1368 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1379 <li class=
"md-nav__item">
1380 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1381 userNotificationEvent
1391 <li class=
"md-nav__item">
1392 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1403 <li class=
"md-nav__item">
1404 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1421 <li class=
"md-nav__item">
1422 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1443 <li class=
"md-nav__item md-nav__item--nested">
1446 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1448 <label class=
"md-nav__link" for=
"__nav_6">
1450 <span class=
"md-nav__icon md-icon"></span>
1452 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1453 <label class=
"md-nav__title" for=
"__nav_6">
1454 <span class=
"md-nav__icon md-icon"></span>
1457 <ul class=
"md-nav__list" data-md-scrollfix
>
1464 <li class=
"md-nav__item md-nav__item--nested">
1467 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1469 <label class=
"md-nav__link" for=
"__nav_6_1">
1470 Migrating from WSC
5.3
1471 <span class=
"md-nav__icon md-icon"></span>
1473 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1474 <label class=
"md-nav__title" for=
"__nav_6_1">
1475 <span class=
"md-nav__icon md-icon"></span>
1476 Migrating from WSC
5.3
1478 <ul class=
"md-nav__list" data-md-scrollfix
>
1484 <li class=
"md-nav__item">
1485 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1496 <li class=
"md-nav__item">
1497 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1498 Session Handling and Authentication
1508 <li class=
"md-nav__item">
1509 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1510 TypeScript and JavaScript
1520 <li class=
"md-nav__item">
1521 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1532 <li class=
"md-nav__item">
1533 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1534 Third Party Libraries
1551 <li class=
"md-nav__item md-nav__item--nested">
1554 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1556 <label class=
"md-nav__link" for=
"__nav_6_2">
1557 Migrating from WSC
5.2
1558 <span class=
"md-nav__icon md-icon"></span>
1560 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1561 <label class=
"md-nav__title" for=
"__nav_6_2">
1562 <span class=
"md-nav__icon md-icon"></span>
1563 Migrating from WSC
5.2
1565 <ul class=
"md-nav__list" data-md-scrollfix
>
1571 <li class=
"md-nav__item">
1572 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1583 <li class=
"md-nav__item">
1584 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1585 Templates and Languages
1595 <li class=
"md-nav__item">
1596 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1597 Third Party Libraries
1614 <li class=
"md-nav__item md-nav__item--nested">
1617 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1619 <label class=
"md-nav__link" for=
"__nav_6_3">
1620 Migrating from WSC
3.1
1621 <span class=
"md-nav__icon md-icon"></span>
1623 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1624 <label class=
"md-nav__title" for=
"__nav_6_3">
1625 <span class=
"md-nav__icon md-icon"></span>
1626 Migrating from WSC
3.1
1628 <ul class=
"md-nav__list" data-md-scrollfix
>
1634 <li class=
"md-nav__item">
1635 <a href=
"../../../migration/wsc31/php/" 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_4" type=
"checkbox" id=
"__nav_6_4" >
1658 <label class=
"md-nav__link" for=
"__nav_6_4">
1659 Migrating from WSC
3.0
1660 <span class=
"md-nav__icon md-icon"></span>
1662 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1663 <label class=
"md-nav__title" for=
"__nav_6_4">
1664 <span class=
"md-nav__icon md-icon"></span>
1665 Migrating from WSC
3.0
1667 <ul class=
"md-nav__list" data-md-scrollfix
>
1673 <li class=
"md-nav__item">
1674 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1685 <li class=
"md-nav__item">
1686 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1697 <li class=
"md-nav__item">
1698 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1709 <li class=
"md-nav__item">
1710 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1721 <li class=
"md-nav__item">
1722 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1740 <li class=
"md-nav__item md-nav__item--nested">
1743 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1745 <label class=
"md-nav__link" for=
"__nav_6_5">
1746 Migrating from WCF
2.1
1747 <span class=
"md-nav__icon md-icon"></span>
1749 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1750 <label class=
"md-nav__title" for=
"__nav_6_5">
1751 <span class=
"md-nav__icon md-icon"></span>
1752 Migrating from WCF
2.1
1754 <ul class=
"md-nav__list" data-md-scrollfix
>
1760 <li class=
"md-nav__item">
1761 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1772 <li class=
"md-nav__item">
1773 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1784 <li class=
"md-nav__item">
1785 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1796 <li class=
"md-nav__item">
1797 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1824 <li class=
"md-nav__item md-nav__item--nested">
1827 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1829 <label class=
"md-nav__link" for=
"__nav_7">
1831 <span class=
"md-nav__icon md-icon"></span>
1833 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1834 <label class=
"md-nav__title" for=
"__nav_7">
1835 <span class=
"md-nav__icon md-icon"></span>
1838 <ul class=
"md-nav__list" data-md-scrollfix
>
1845 <li class=
"md-nav__item md-nav__item--nested">
1848 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1850 <label class=
"md-nav__link" for=
"__nav_7_1">
1852 <span class=
"md-nav__icon md-icon"></span>
1854 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1855 <label class=
"md-nav__title" for=
"__nav_7_1">
1856 <span class=
"md-nav__icon md-icon"></span>
1859 <ul class=
"md-nav__list" data-md-scrollfix
>
1865 <li class=
"md-nav__item">
1866 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1877 <li class=
"md-nav__item">
1878 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1889 <li class=
"md-nav__item">
1890 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1901 <li class=
"md-nav__item">
1902 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1929 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1930 <div class=
"md-sidebar__scrollwrap">
1931 <div class=
"md-sidebar__inner">
1933 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1939 <label class=
"md-nav__title" for=
"__toc">
1940 <span class=
"md-nav__icon md-icon"></span>
1943 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1945 <li class=
"md-nav__item">
1946 <a href=
"#user-group-options" class=
"md-nav__link">
1950 <nav class=
"md-nav" aria-label=
"User Group Options">
1951 <ul class=
"md-nav__list">
1953 <li class=
"md-nav__item">
1954 <a href=
"#language-items" class=
"md-nav__link">
1958 <nav class=
"md-nav" aria-label=
"Language Items">
1959 <ul class=
"md-nav__list">
1961 <li class=
"md-nav__item">
1962 <a href=
"#user-group-options_1" class=
"md-nav__link">
1986 <div class=
"md-content" data-md-component=
"content">
1987 <article class=
"md-content__inner md-typeset">
1990 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/api/comments.md" title=
"Edit this page" class=
"md-content__button md-icon">
1991 <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>
1995 <h1 id=
"comments">Comments
<a class=
"headerlink" href=
"#comments" title=
"Permanent link">#
</a></h1>
1996 <h2 id=
"user-group-options">User Group Options
<a class=
"headerlink" href=
"#user-group-options" title=
"Permanent link">#
</a></h2>
1997 <p>You need to create the following permissions:
</p>
2001 <th>user group type
</th>
2002 <th>permission type
</th>
2009 <td>creating comments
</td>
2010 <td><code>user.foo.canAddComment
</code></td>
2014 <td>editing own comments
</td>
2015 <td><code>user.foo.canEditComment
</code></td>
2019 <td>deleting own comments
</td>
2020 <td><code>user.foo.canDeleteComment
</code></td>
2024 <td>moderating comments
</td>
2025 <td><code>mod.foo.canModerateComment
</code></td>
2029 <td>editing comments
</td>
2030 <td><code>mod.foo.canEditComment
</code></td>
2034 <td>deleting comments
</td>
2035 <td><code>mod.foo.canDeleteComment
</code></td>
2039 <p>Within their respective user group option category, the options should be listed in the same order as in the table above.
</p>
2040 <h3 id=
"language-items">Language Items
<a class=
"headerlink" href=
"#language-items" title=
"Permanent link">#
</a></h3>
2041 <h4 id=
"user-group-options_1">User Group Options
<a class=
"headerlink" href=
"#user-group-options_1" title=
"Permanent link">#
</a></h4>
2042 <p>The language items for the comment-related user group options generally have the same values:
</p>
2044 <li><code>wcf.acp.group.option.user.foo.canAddComment
</code></li>
2046 <p>German:
<code>Kann Kommentare erstellen
</code></p>
2047 <p>English:
<code>Can create comments
</code></p>
2049 <li><code>wcf.acp.group.option.user.foo.canEditComment
</code></li>
2051 <p>German:
<code>Kann eigene Kommentare bearbeiten
</code></p>
2052 <p>English:
<code>Can edit their comments
</code></p>
2054 <li><code>wcf.acp.group.option.user.foo.canDeleteComment
</code></li>
2056 <p>German:
<code>Kann eigene Kommentare löschen
</code></p>
2057 <p>English:
<code>Can delete their comments
</code></p>
2059 <li><code>wcf.acp.group.option.mod.foo.canModerateComment
</code></li>
2061 <p>German:
<code>Kann Kommentare moderieren
</code></p>
2062 <p>English:
<code>Can moderate comments
</code></p>
2064 <li><code>wcf.acp.group.option.mod.foo.canEditComment
</code></li>
2066 <p>German:
<code>Kann Kommentare bearbeiten
</code></p>
2067 <p>English:
<code>Can edit comments
</code></p>
2069 <li><code>wcf.acp.group.option.mod.foo.canDeleteComment
</code></li>
2071 <p>German:
<code>Kann Kommentare löschen
</code></p>
2072 <p>English:
<code>Can delete comments
</code></p>
2078 <div class=
"md-source-date">
2081 Last update:
2021-
01-
08
2100 <footer class=
"md-footer">
2102 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2104 <a href=
"../caches_runtime-caches/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2105 <div class=
"md-footer__button md-icon">
2106 <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>
2108 <div class=
"md-footer__title">
2109 <div class=
"md-ellipsis">
2110 <span class=
"md-footer__direction">
2119 <a href=
"../cronjobs/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2120 <div class=
"md-footer__title">
2121 <div class=
"md-ellipsis">
2122 <span class=
"md-footer__direction">
2128 <div class=
"md-footer__button md-icon">
2129 <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>
2135 <div class=
"md-footer-meta md-typeset">
2136 <div class=
"md-footer-meta__inner md-grid">
2137 <div class=
"md-footer-copyright">
2139 <div class=
"md-footer-copyright__highlight">
2140 Copyright ©
2020 WoltLab GmbH
2144 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2149 <div class=
"md-footer-copyright">
2150 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2151 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2158 <div class=
"md-dialog" data-md-component=
"dialog">
2159 <div class=
"md-dialog__inner md-typeset"></div>
2161 <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>
2164 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>