Deployed 506b5bb to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / latest / php / api / comments / index.html
1
2 <!doctype html>
3 <html lang="en" class="no-js">
4 <head>
5
6 <meta charset="utf-8">
7 <meta name="viewport" content="width=device-width,initial-scale=1">
8
9
10
11
12 <link rel="shortcut icon" href="../../../assets/default.favicon.ico">
13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.5">
14
15
16
17 <title>Comments - WoltLab Suite Documentation</title>
18
19
20
21 <link rel="stylesheet" href="../../../assets/stylesheets/main.77f3fd56.min.css">
22
23
24 <link rel="stylesheet" href="../../../assets/stylesheets/palette.7fa14f5b.min.css">
25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
34
35
36
37 <link rel="stylesheet" href="../../../stylesheets/extra.css">
38
39
40
41
42
43 </head>
44
45
46
47
48
49
50
51 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
52
53
54
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">
59
60
61 <a href="#comments" class="md-skip">
62 Skip to content
63 </a>
64
65 </div>
66 <div data-md-component="announce">
67
68 <aside class="md-announce">
69 <div class="md-announce__inner md-grid md-typeset">
70
71 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
72
73 </div>
74 </aside>
75
76 </div>
77
78
79
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">
83
84 <img src="../../../assets/logo.png" alt="logo">
85
86 </a>
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>
89 </label>
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
95 </span>
96 </div>
97 <div class="md-header__topic" data-md-component="header-topic">
98 <span class="md-ellipsis">
99
100 Comments
101
102 </span>
103 </div>
104 </div>
105 </div>
106 <div class="md-header__options">
107
108 </div>
109
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>
112 </label>
113
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>
122 </label>
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>
125 </button>
126 </form>
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">
131 Initializing search
132 </div>
133 <ol class="md-search-result__list"></ol>
134 </div>
135 </div>
136 </div>
137 </div>
138 </div>
139
140
141 </nav>
142 </header>
143
144 <div class="md-container" data-md-component="container">
145
146
147
148
149 <main class="md-main" data-md-component="main">
150 <div class="md-main__inner md-grid">
151
152
153
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">
157
158
159
160
161
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">
165
166 <img src="../../../assets/logo.png" alt="logo">
167
168 </a>
169 WoltLab Suite Documentation
170 </label>
171
172 <ul class="md-nav__list" data-md-scrollfix>
173
174
175
176
177
178
179
180
181 <li class="md-nav__item">
182 <a href="../../../getting-started/" class="md-nav__link">
183 Getting Started
184 </a>
185 </li>
186
187
188
189
190
191
192
193
194
195
196
197
198
199 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
200
201
202 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
203
204 <label class="md-nav__link" for="__nav_2">
205 PHP API
206 <span class="md-nav__icon md-icon"></span>
207 </label>
208 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
209 <label class="md-nav__title" for="__nav_2">
210 <span class="md-nav__icon md-icon"></span>
211 PHP API
212 </label>
213 <ul class="md-nav__list" data-md-scrollfix>
214
215
216
217
218
219 <li class="md-nav__item">
220 <a href="../../pages/" class="md-nav__link">
221 Pages
222 </a>
223 </li>
224
225
226
227
228
229
230
231 <li class="md-nav__item">
232 <a href="../../database-objects/" class="md-nav__link">
233 Database Objects
234 </a>
235 </li>
236
237
238
239
240
241
242
243 <li class="md-nav__item">
244 <a href="../../database-access/" class="md-nav__link">
245 Database Access
246 </a>
247 </li>
248
249
250
251
252
253
254
255 <li class="md-nav__item">
256 <a href="../../exceptions/" class="md-nav__link">
257 Exceptions
258 </a>
259 </li>
260
261
262
263
264
265
266
267
268
269
270 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
271
272
273 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" checked>
274
275 <label class="md-nav__link" for="__nav_2_5">
276 API
277 <span class="md-nav__icon md-icon"></span>
278 </label>
279 <nav class="md-nav" aria-label="API" data-md-level="2">
280 <label class="md-nav__title" for="__nav_2_5">
281 <span class="md-nav__icon md-icon"></span>
282 API
283 </label>
284 <ul class="md-nav__list" data-md-scrollfix>
285
286
287
288
289
290 <li class="md-nav__item">
291 <a href="../caches/" class="md-nav__link">
292 Caches
293 </a>
294 </li>
295
296
297
298
299
300
301
302
303
304 <li class="md-nav__item md-nav__item--active">
305
306 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
307
308
309
310
311 <label class="md-nav__link md-nav__link--active" for="__toc">
312 Comments
313 <span class="md-nav__icon md-icon"></span>
314 </label>
315
316 <a href="./" class="md-nav__link md-nav__link--active">
317 Comments
318 </a>
319
320
321 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
322
323
324
325
326
327 <label class="md-nav__title" for="__toc">
328 <span class="md-nav__icon md-icon"></span>
329 Table of contents
330 </label>
331 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
332
333 <li class="md-nav__item">
334 <a href="#user-group-options" class="md-nav__link">
335 User Group Options
336 </a>
337
338 <nav class="md-nav" aria-label="User Group Options">
339 <ul class="md-nav__list">
340
341 <li class="md-nav__item">
342 <a href="#language-items" class="md-nav__link">
343 Language Items
344 </a>
345
346 <nav class="md-nav" aria-label="Language Items">
347 <ul class="md-nav__list">
348
349 <li class="md-nav__item">
350 <a href="#user-group-options_1" class="md-nav__link">
351 User Group Options
352 </a>
353
354 </li>
355
356 </ul>
357 </nav>
358
359 </li>
360
361 </ul>
362 </nav>
363
364 </li>
365
366 </ul>
367
368 </nav>
369
370 </li>
371
372
373
374
375
376
377
378 <li class="md-nav__item">
379 <a href="../cronjobs/" class="md-nav__link">
380 Cronjobs
381 </a>
382 </li>
383
384
385
386
387
388
389
390 <li class="md-nav__item">
391 <a href="../events/" class="md-nav__link">
392 Events
393 </a>
394 </li>
395
396
397
398
399
400
401
402
403 <li class="md-nav__item md-nav__item--nested">
404
405
406 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
407
408 <label class="md-nav__link" for="__nav_2_5_5">
409 Form Builder
410 <span class="md-nav__icon md-icon"></span>
411 </label>
412 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
413 <label class="md-nav__title" for="__nav_2_5_5">
414 <span class="md-nav__icon md-icon"></span>
415 Form Builder
416 </label>
417 <ul class="md-nav__list" data-md-scrollfix>
418
419
420
421
422
423 <li class="md-nav__item">
424 <a href="../form_builder/overview/" class="md-nav__link">
425 Overview
426 </a>
427 </li>
428
429
430
431
432
433
434
435 <li class="md-nav__item">
436 <a href="../form_builder/structure/" class="md-nav__link">
437 Structure
438 </a>
439 </li>
440
441
442
443
444
445
446
447 <li class="md-nav__item">
448 <a href="../form_builder/form_fields/" class="md-nav__link">
449 Fields
450 </a>
451 </li>
452
453
454
455
456
457
458
459 <li class="md-nav__item">
460 <a href="../form_builder/validation_data/" class="md-nav__link">
461 Validation and Data
462 </a>
463 </li>
464
465
466
467
468
469
470
471 <li class="md-nav__item">
472 <a href="../form_builder/dependencies/" class="md-nav__link">
473 Dependencies
474 </a>
475 </li>
476
477
478
479 </ul>
480 </nav>
481 </li>
482
483
484
485
486
487
488
489 <li class="md-nav__item">
490 <a href="../package_installation_plugins/" class="md-nav__link">
491 Package Installation Plugins
492 </a>
493 </li>
494
495
496
497
498
499
500
501 <li class="md-nav__item">
502 <a href="../user_activity_points/" class="md-nav__link">
503 User Activity Points
504 </a>
505 </li>
506
507
508
509
510
511
512
513 <li class="md-nav__item">
514 <a href="../user_notifications/" class="md-nav__link">
515 User Notifications
516 </a>
517 </li>
518
519
520
521
522
523
524
525 <li class="md-nav__item">
526 <a href="../sitemaps/" class="md-nav__link">
527 Sitemaps
528 </a>
529 </li>
530
531
532
533 </ul>
534 </nav>
535 </li>
536
537
538
539
540
541
542
543 <li class="md-nav__item">
544 <a href="../../code-style/" class="md-nav__link">
545 Code Style
546 </a>
547 </li>
548
549
550
551
552
553
554
555 <li class="md-nav__item">
556 <a href="../../apps/" class="md-nav__link">
557 Apps
558 </a>
559 </li>
560
561
562
563
564
565
566
567 <li class="md-nav__item">
568 <a href="../../gdpr/" class="md-nav__link">
569 GDPR
570 </a>
571 </li>
572
573
574
575 </ul>
576 </nav>
577 </li>
578
579
580
581
582
583
584
585
586
587
588
589 <li class="md-nav__item md-nav__item--nested">
590
591
592 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
593
594 <label class="md-nav__link" for="__nav_3">
595 Languages, Templates & CSS
596 <span class="md-nav__icon md-icon"></span>
597 </label>
598 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
599 <label class="md-nav__title" for="__nav_3">
600 <span class="md-nav__icon md-icon"></span>
601 Languages, Templates & CSS
602 </label>
603 <ul class="md-nav__list" data-md-scrollfix>
604
605
606
607
608
609 <li class="md-nav__item">
610 <a href="../../../view/languages/" class="md-nav__link">
611 Languages
612 </a>
613 </li>
614
615
616
617
618
619
620
621 <li class="md-nav__item">
622 <a href="../../../view/templates/" class="md-nav__link">
623 Templates
624 </a>
625 </li>
626
627
628
629
630
631
632
633 <li class="md-nav__item">
634 <a href="../../../view/css/" class="md-nav__link">
635 CSS
636 </a>
637 </li>
638
639
640
641 </ul>
642 </nav>
643 </li>
644
645
646
647
648
649
650
651
652
653
654
655 <li class="md-nav__item md-nav__item--nested">
656
657
658 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
659
660 <label class="md-nav__link" for="__nav_4">
661 JavaScript API
662 <span class="md-nav__icon md-icon"></span>
663 </label>
664 <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
665 <label class="md-nav__title" for="__nav_4">
666 <span class="md-nav__icon md-icon"></span>
667 JavaScript API
668 </label>
669 <ul class="md-nav__list" data-md-scrollfix>
670
671
672
673
674
675 <li class="md-nav__item">
676 <a href="../../../javascript/general-usage/" class="md-nav__link">
677 General Usage
678 </a>
679 </li>
680
681
682
683
684
685
686
687
688 <li class="md-nav__item md-nav__item--nested">
689
690
691 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
692
693 <label class="md-nav__link" for="__nav_4_2">
694 New API
695 <span class="md-nav__icon md-icon"></span>
696 </label>
697 <nav class="md-nav" aria-label="New API" data-md-level="2">
698 <label class="md-nav__title" for="__nav_4_2">
699 <span class="md-nav__icon md-icon"></span>
700 New API
701 </label>
702 <ul class="md-nav__list" data-md-scrollfix>
703
704
705
706
707
708 <li class="md-nav__item">
709 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
710 Writing a module
711 </a>
712 </li>
713
714
715
716
717
718
719
720 <li class="md-nav__item">
721 <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
722 Data Structures
723 </a>
724 </li>
725
726
727
728
729
730
731
732 <li class="md-nav__item">
733 <a href="../../../javascript/new-api_core/" class="md-nav__link">
734 Core Functions
735 </a>
736 </li>
737
738
739
740
741
742
743
744 <li class="md-nav__item">
745 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
746 DOM
747 </a>
748 </li>
749
750
751
752
753
754
755
756 <li class="md-nav__item">
757 <a href="../../../javascript/new-api_events/" class="md-nav__link">
758 Event Handling
759 </a>
760 </li>
761
762
763
764
765
766
767
768 <li class="md-nav__item">
769 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
770 Ajax
771 </a>
772 </li>
773
774
775
776
777
778
779
780 <li class="md-nav__item">
781 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
782 Dialogs
783 </a>
784 </li>
785
786
787
788
789
790
791
792 <li class="md-nav__item">
793 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
794 Browser and Screen Sizes
795 </a>
796 </li>
797
798
799
800
801
802
803
804 <li class="md-nav__item">
805 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
806 User Interface
807 </a>
808 </li>
809
810
811
812 </ul>
813 </nav>
814 </li>
815
816
817
818
819
820
821
822 <li class="md-nav__item">
823 <a href="../../../javascript/legacy-api/" class="md-nav__link">
824 Legacy API
825 </a>
826 </li>
827
828
829
830
831
832
833
834 <li class="md-nav__item">
835 <a href="../../../javascript/helper-functions/" class="md-nav__link">
836 Helper Functions
837 </a>
838 </li>
839
840
841
842
843
844
845
846 <li class="md-nav__item">
847 <a href="../../../javascript/code-snippets/" class="md-nav__link">
848 Code Snippets
849 </a>
850 </li>
851
852
853
854 </ul>
855 </nav>
856 </li>
857
858
859
860
861
862
863
864
865
866
867
868 <li class="md-nav__item md-nav__item--nested">
869
870
871 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
872
873 <label class="md-nav__link" for="__nav_5">
874 Package Components
875 <span class="md-nav__icon md-icon"></span>
876 </label>
877 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
878 <label class="md-nav__title" for="__nav_5">
879 <span class="md-nav__icon md-icon"></span>
880 Package Components
881 </label>
882 <ul class="md-nav__list" data-md-scrollfix>
883
884
885
886
887
888 <li class="md-nav__item">
889 <a href="../../../package/package-xml/" class="md-nav__link">
890 package.xml
891 </a>
892 </li>
893
894
895
896
897
898
899
900
901 <li class="md-nav__item md-nav__item--nested">
902
903
904 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
905
906 <label class="md-nav__link" for="__nav_5_2">
907 PIPs
908 <span class="md-nav__icon md-icon"></span>
909 </label>
910 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
911 <label class="md-nav__title" for="__nav_5_2">
912 <span class="md-nav__icon md-icon"></span>
913 PIPs
914 </label>
915 <ul class="md-nav__list" data-md-scrollfix>
916
917
918
919
920
921 <li class="md-nav__item">
922 <a href="../../../package/pip/" class="md-nav__link">
923 Overview
924 </a>
925 </li>
926
927
928
929
930
931
932
933 <li class="md-nav__item">
934 <a href="../../../package/pip/acl-option/" class="md-nav__link">
935 aclOption
936 </a>
937 </li>
938
939
940
941
942
943
944
945 <li class="md-nav__item">
946 <a href="../../../package/pip/acp-menu/" class="md-nav__link">
947 acpMenu
948 </a>
949 </li>
950
951
952
953
954
955
956
957 <li class="md-nav__item">
958 <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
959 acpSearchProvider
960 </a>
961 </li>
962
963
964
965
966
967
968
969 <li class="md-nav__item">
970 <a href="../../../package/pip/acp-template/" class="md-nav__link">
971 acpTemplate
972 </a>
973 </li>
974
975
976
977
978
979
980
981 <li class="md-nav__item">
982 <a href="../../../package/pip/bbcode/" class="md-nav__link">
983 bbcode
984 </a>
985 </li>
986
987
988
989
990
991
992
993 <li class="md-nav__item">
994 <a href="../../../package/pip/box/" class="md-nav__link">
995 box
996 </a>
997 </li>
998
999
1000
1001
1002
1003
1004
1005 <li class="md-nav__item">
1006 <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1007 clipboardAction
1008 </a>
1009 </li>
1010
1011
1012
1013
1014
1015
1016
1017 <li class="md-nav__item">
1018 <a href="../../../package/pip/core-object/" class="md-nav__link">
1019 coreObject
1020 </a>
1021 </li>
1022
1023
1024
1025
1026
1027
1028
1029 <li class="md-nav__item">
1030 <a href="../../../package/pip/cronjob/" class="md-nav__link">
1031 cronjob
1032 </a>
1033 </li>
1034
1035
1036
1037
1038
1039
1040
1041 <li class="md-nav__item">
1042 <a href="../../../package/pip/event-listener/" class="md-nav__link">
1043 eventListener
1044 </a>
1045 </li>
1046
1047
1048
1049
1050
1051
1052
1053 <li class="md-nav__item">
1054 <a href="../../../package/pip/file/" class="md-nav__link">
1055 file
1056 </a>
1057 </li>
1058
1059
1060
1061
1062
1063
1064
1065 <li class="md-nav__item">
1066 <a href="../../../package/pip/language/" class="md-nav__link">
1067 language
1068 </a>
1069 </li>
1070
1071
1072
1073
1074
1075
1076
1077 <li class="md-nav__item">
1078 <a href="../../../package/pip/media-provider/" class="md-nav__link">
1079 mediaProvider
1080 </a>
1081 </li>
1082
1083
1084
1085
1086
1087
1088
1089 <li class="md-nav__item">
1090 <a href="../../../package/pip/menu/" class="md-nav__link">
1091 menu
1092 </a>
1093 </li>
1094
1095
1096
1097
1098
1099
1100
1101 <li class="md-nav__item">
1102 <a href="../../../package/pip/menu-item/" class="md-nav__link">
1103 menuItem
1104 </a>
1105 </li>
1106
1107
1108
1109
1110
1111
1112
1113 <li class="md-nav__item">
1114 <a href="../../../package/pip/object-type/" class="md-nav__link">
1115 objectType
1116 </a>
1117 </li>
1118
1119
1120
1121
1122
1123
1124
1125 <li class="md-nav__item">
1126 <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1127 objectTypeDefinition
1128 </a>
1129 </li>
1130
1131
1132
1133
1134
1135
1136
1137 <li class="md-nav__item">
1138 <a href="../../../package/pip/option/" class="md-nav__link">
1139 option
1140 </a>
1141 </li>
1142
1143
1144
1145
1146
1147
1148
1149 <li class="md-nav__item">
1150 <a href="../../../package/pip/page/" class="md-nav__link">
1151 page
1152 </a>
1153 </li>
1154
1155
1156
1157
1158
1159
1160
1161 <li class="md-nav__item">
1162 <a href="../../../package/pip/pip/" class="md-nav__link">
1163 pip
1164 </a>
1165 </li>
1166
1167
1168
1169
1170
1171
1172
1173 <li class="md-nav__item">
1174 <a href="../../../package/pip/script/" class="md-nav__link">
1175 script
1176 </a>
1177 </li>
1178
1179
1180
1181
1182
1183
1184
1185 <li class="md-nav__item">
1186 <a href="../../../package/pip/smiley/" class="md-nav__link">
1187 smiley
1188 </a>
1189 </li>
1190
1191
1192
1193
1194
1195
1196
1197 <li class="md-nav__item">
1198 <a href="../../../package/pip/sql/" class="md-nav__link">
1199 sql
1200 </a>
1201 </li>
1202
1203
1204
1205
1206
1207
1208
1209 <li class="md-nav__item">
1210 <a href="../../../package/pip/style/" class="md-nav__link">
1211 style
1212 </a>
1213 </li>
1214
1215
1216
1217
1218
1219
1220
1221 <li class="md-nav__item">
1222 <a href="../../../package/pip/template/" class="md-nav__link">
1223 template
1224 </a>
1225 </li>
1226
1227
1228
1229
1230
1231
1232
1233 <li class="md-nav__item">
1234 <a href="../../../package/pip/template-listener/" class="md-nav__link">
1235 templateListener
1236 </a>
1237 </li>
1238
1239
1240
1241
1242
1243
1244
1245 <li class="md-nav__item">
1246 <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1247 userGroupOption
1248 </a>
1249 </li>
1250
1251
1252
1253
1254
1255
1256
1257 <li class="md-nav__item">
1258 <a href="../../../package/pip/user-menu/" class="md-nav__link">
1259 userMenu
1260 </a>
1261 </li>
1262
1263
1264
1265
1266
1267
1268
1269 <li class="md-nav__item">
1270 <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1271 userNotificationEvent
1272 </a>
1273 </li>
1274
1275
1276
1277
1278
1279
1280
1281 <li class="md-nav__item">
1282 <a href="../../../package/pip/user-option/" class="md-nav__link">
1283 userOption
1284 </a>
1285 </li>
1286
1287
1288
1289
1290
1291
1292
1293 <li class="md-nav__item">
1294 <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1295 userProfileMenu
1296 </a>
1297 </li>
1298
1299
1300
1301 </ul>
1302 </nav>
1303 </li>
1304
1305
1306
1307
1308
1309
1310
1311 <li class="md-nav__item">
1312 <a href="../../../package/database-php-api/" class="md-nav__link">
1313 Database PHP API
1314 </a>
1315 </li>
1316
1317
1318
1319 </ul>
1320 </nav>
1321 </li>
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333 <li class="md-nav__item md-nav__item--nested">
1334
1335
1336 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1337
1338 <label class="md-nav__link" for="__nav_6">
1339 Migration
1340 <span class="md-nav__icon md-icon"></span>
1341 </label>
1342 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1343 <label class="md-nav__title" for="__nav_6">
1344 <span class="md-nav__icon md-icon"></span>
1345 Migration
1346 </label>
1347 <ul class="md-nav__list" data-md-scrollfix>
1348
1349
1350
1351
1352
1353
1354 <li class="md-nav__item md-nav__item--nested">
1355
1356
1357 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1358
1359 <label class="md-nav__link" for="__nav_6_1">
1360 Migrating from WSC 5.3
1361 <span class="md-nav__icon md-icon"></span>
1362 </label>
1363 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1364 <label class="md-nav__title" for="__nav_6_1">
1365 <span class="md-nav__icon md-icon"></span>
1366 Migrating from WSC 5.3
1367 </label>
1368 <ul class="md-nav__list" data-md-scrollfix>
1369
1370
1371
1372
1373
1374 <li class="md-nav__item">
1375 <a href="../../../migration/wsc53/php/" class="md-nav__link">
1376 PHP API
1377 </a>
1378 </li>
1379
1380
1381
1382
1383
1384
1385
1386 <li class="md-nav__item">
1387 <a href="../../../migration/wsc53/session/" class="md-nav__link">
1388 Session Handling and Authentication
1389 </a>
1390 </li>
1391
1392
1393
1394
1395
1396
1397
1398 <li class="md-nav__item">
1399 <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1400 JavaScript
1401 </a>
1402 </li>
1403
1404
1405
1406
1407
1408
1409
1410 <li class="md-nav__item">
1411 <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1412 Templates
1413 </a>
1414 </li>
1415
1416
1417
1418
1419
1420
1421
1422 <li class="md-nav__item">
1423 <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1424 Third Party Libraries
1425 </a>
1426 </li>
1427
1428
1429
1430 </ul>
1431 </nav>
1432 </li>
1433
1434
1435
1436
1437
1438
1439
1440
1441 <li class="md-nav__item md-nav__item--nested">
1442
1443
1444 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1445
1446 <label class="md-nav__link" for="__nav_6_2">
1447 Migrating from WSC 5.2
1448 <span class="md-nav__icon md-icon"></span>
1449 </label>
1450 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1451 <label class="md-nav__title" for="__nav_6_2">
1452 <span class="md-nav__icon md-icon"></span>
1453 Migrating from WSC 5.2
1454 </label>
1455 <ul class="md-nav__list" data-md-scrollfix>
1456
1457
1458
1459
1460
1461 <li class="md-nav__item">
1462 <a href="../../../migration/wsc52/php/" class="md-nav__link">
1463 PHP API
1464 </a>
1465 </li>
1466
1467
1468
1469
1470
1471
1472
1473 <li class="md-nav__item">
1474 <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1475 Templates and Languages
1476 </a>
1477 </li>
1478
1479
1480
1481
1482
1483
1484
1485 <li class="md-nav__item">
1486 <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1487 Third Party Libraries
1488 </a>
1489 </li>
1490
1491
1492
1493 </ul>
1494 </nav>
1495 </li>
1496
1497
1498
1499
1500
1501
1502
1503
1504 <li class="md-nav__item md-nav__item--nested">
1505
1506
1507 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1508
1509 <label class="md-nav__link" for="__nav_6_3">
1510 Migrating from WSC 3.1
1511 <span class="md-nav__icon md-icon"></span>
1512 </label>
1513 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1514 <label class="md-nav__title" for="__nav_6_3">
1515 <span class="md-nav__icon md-icon"></span>
1516 Migrating from WSC 3.1
1517 </label>
1518 <ul class="md-nav__list" data-md-scrollfix>
1519
1520
1521
1522
1523
1524 <li class="md-nav__item">
1525 <a href="../../../migration/wsc31/php/" class="md-nav__link">
1526 PHP API
1527 </a>
1528 </li>
1529
1530
1531
1532 </ul>
1533 </nav>
1534 </li>
1535
1536
1537
1538
1539
1540
1541
1542
1543 <li class="md-nav__item md-nav__item--nested">
1544
1545
1546 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1547
1548 <label class="md-nav__link" for="__nav_6_4">
1549 Migrating from WSC 3.0
1550 <span class="md-nav__icon md-icon"></span>
1551 </label>
1552 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1553 <label class="md-nav__title" for="__nav_6_4">
1554 <span class="md-nav__icon md-icon"></span>
1555 Migrating from WSC 3.0
1556 </label>
1557 <ul class="md-nav__list" data-md-scrollfix>
1558
1559
1560
1561
1562
1563 <li class="md-nav__item">
1564 <a href="../../../migration/wsc30/php/" class="md-nav__link">
1565 PHP API
1566 </a>
1567 </li>
1568
1569
1570
1571
1572
1573
1574
1575 <li class="md-nav__item">
1576 <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1577 JavaScript API
1578 </a>
1579 </li>
1580
1581
1582
1583
1584
1585
1586
1587 <li class="md-nav__item">
1588 <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1589 Templates
1590 </a>
1591 </li>
1592
1593
1594
1595
1596
1597
1598
1599 <li class="md-nav__item">
1600 <a href="../../../migration/wsc30/css/" class="md-nav__link">
1601 CSS
1602 </a>
1603 </li>
1604
1605
1606
1607
1608
1609
1610
1611 <li class="md-nav__item">
1612 <a href="../../../migration/wsc30/package/" class="md-nav__link">
1613 Package Components
1614 </a>
1615 </li>
1616
1617
1618
1619 </ul>
1620 </nav>
1621 </li>
1622
1623
1624
1625
1626
1627
1628
1629
1630 <li class="md-nav__item md-nav__item--nested">
1631
1632
1633 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1634
1635 <label class="md-nav__link" for="__nav_6_5">
1636 Migrating from WCF 2.1
1637 <span class="md-nav__icon md-icon"></span>
1638 </label>
1639 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1640 <label class="md-nav__title" for="__nav_6_5">
1641 <span class="md-nav__icon md-icon"></span>
1642 Migrating from WCF 2.1
1643 </label>
1644 <ul class="md-nav__list" data-md-scrollfix>
1645
1646
1647
1648
1649
1650 <li class="md-nav__item">
1651 <a href="../../../migration/wcf21/php/" class="md-nav__link">
1652 PHP API
1653 </a>
1654 </li>
1655
1656
1657
1658
1659
1660
1661
1662 <li class="md-nav__item">
1663 <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1664 Templates
1665 </a>
1666 </li>
1667
1668
1669
1670
1671
1672
1673
1674 <li class="md-nav__item">
1675 <a href="../../../migration/wcf21/css/" class="md-nav__link">
1676 CSS
1677 </a>
1678 </li>
1679
1680
1681
1682
1683
1684
1685
1686 <li class="md-nav__item">
1687 <a href="../../../migration/wcf21/package/" class="md-nav__link">
1688 Package Components
1689 </a>
1690 </li>
1691
1692
1693
1694 </ul>
1695 </nav>
1696 </li>
1697
1698
1699
1700 </ul>
1701 </nav>
1702 </li>
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714 <li class="md-nav__item md-nav__item--nested">
1715
1716
1717 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1718
1719 <label class="md-nav__link" for="__nav_7">
1720 Tutorials
1721 <span class="md-nav__icon md-icon"></span>
1722 </label>
1723 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1724 <label class="md-nav__title" for="__nav_7">
1725 <span class="md-nav__icon md-icon"></span>
1726 Tutorials
1727 </label>
1728 <ul class="md-nav__list" data-md-scrollfix>
1729
1730
1731
1732
1733
1734
1735 <li class="md-nav__item md-nav__item--nested">
1736
1737
1738 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1739
1740 <label class="md-nav__link" for="__nav_7_1">
1741 Tutorial Series
1742 <span class="md-nav__icon md-icon"></span>
1743 </label>
1744 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1745 <label class="md-nav__title" for="__nav_7_1">
1746 <span class="md-nav__icon md-icon"></span>
1747 Tutorial Series
1748 </label>
1749 <ul class="md-nav__list" data-md-scrollfix>
1750
1751
1752
1753
1754
1755 <li class="md-nav__item">
1756 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1757 Overview
1758 </a>
1759 </li>
1760
1761
1762
1763
1764
1765
1766
1767 <li class="md-nav__item">
1768 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1769 Part 1
1770 </a>
1771 </li>
1772
1773
1774
1775
1776
1777
1778
1779 <li class="md-nav__item">
1780 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1781 Part 2
1782 </a>
1783 </li>
1784
1785
1786
1787
1788
1789
1790
1791 <li class="md-nav__item">
1792 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1793 Part 3
1794 </a>
1795 </li>
1796
1797
1798
1799 </ul>
1800 </nav>
1801 </li>
1802
1803
1804
1805 </ul>
1806 </nav>
1807 </li>
1808
1809
1810
1811 </ul>
1812 </nav>
1813 </div>
1814 </div>
1815 </div>
1816
1817
1818
1819 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1820 <div class="md-sidebar__scrollwrap">
1821 <div class="md-sidebar__inner">
1822
1823 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1824
1825
1826
1827
1828
1829 <label class="md-nav__title" for="__toc">
1830 <span class="md-nav__icon md-icon"></span>
1831 Table of contents
1832 </label>
1833 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1834
1835 <li class="md-nav__item">
1836 <a href="#user-group-options" class="md-nav__link">
1837 User Group Options
1838 </a>
1839
1840 <nav class="md-nav" aria-label="User Group Options">
1841 <ul class="md-nav__list">
1842
1843 <li class="md-nav__item">
1844 <a href="#language-items" class="md-nav__link">
1845 Language Items
1846 </a>
1847
1848 <nav class="md-nav" aria-label="Language Items">
1849 <ul class="md-nav__list">
1850
1851 <li class="md-nav__item">
1852 <a href="#user-group-options_1" class="md-nav__link">
1853 User Group Options
1854 </a>
1855
1856 </li>
1857
1858 </ul>
1859 </nav>
1860
1861 </li>
1862
1863 </ul>
1864 </nav>
1865
1866 </li>
1867
1868 </ul>
1869
1870 </nav>
1871 </div>
1872 </div>
1873 </div>
1874
1875
1876 <div class="md-content" data-md-component="content">
1877 <article class="md-content__inner md-typeset">
1878
1879
1880
1881 <h1 id="comments">Comments<a class="headerlink" href="#comments" title="Permanent link">#</a></h1>
1882 <h2 id="user-group-options">User Group Options<a class="headerlink" href="#user-group-options" title="Permanent link">#</a></h2>
1883 <p>You need to create the following permissions:</p>
1884 <table>
1885 <thead>
1886 <tr>
1887 <th>user group type</th>
1888 <th>permission type</th>
1889 <th>naming</th>
1890 </tr>
1891 </thead>
1892 <tbody>
1893 <tr>
1894 <td>user</td>
1895 <td>creating comments</td>
1896 <td><code>user.foo.canAddComment</code></td>
1897 </tr>
1898 <tr>
1899 <td>user</td>
1900 <td>editing own comments</td>
1901 <td><code>user.foo.canEditComment</code></td>
1902 </tr>
1903 <tr>
1904 <td>user</td>
1905 <td>deleting own comments</td>
1906 <td><code>user.foo.canDeleteComment</code></td>
1907 </tr>
1908 <tr>
1909 <td>moderator</td>
1910 <td>moderating comments</td>
1911 <td><code>mod.foo.canModerateComment</code></td>
1912 </tr>
1913 <tr>
1914 <td>moderator</td>
1915 <td>editing comments</td>
1916 <td><code>mod.foo.canEditComment</code></td>
1917 </tr>
1918 <tr>
1919 <td>moderator</td>
1920 <td>deleting comments</td>
1921 <td><code>mod.foo.canDeleteComment</code></td>
1922 </tr>
1923 </tbody>
1924 </table>
1925 <p>Within their respective user group option category, the options should be listed in the same order as in the table above.</p>
1926 <h3 id="language-items">Language Items<a class="headerlink" href="#language-items" title="Permanent link">#</a></h3>
1927 <h4 id="user-group-options_1">User Group Options<a class="headerlink" href="#user-group-options_1" title="Permanent link">#</a></h4>
1928 <p>The language items for the comment-related user group options generally have the same values:</p>
1929 <ul>
1930 <li><code>wcf.acp.group.option.user.foo.canAddComment</code></li>
1931 </ul>
1932 <p>German: <code>Kann Kommentare erstellen</code></p>
1933 <p>English: <code>Can create comments</code></p>
1934 <ul>
1935 <li><code>wcf.acp.group.option.user.foo.canEditComment</code></li>
1936 </ul>
1937 <p>German: <code>Kann eigene Kommentare bearbeiten</code></p>
1938 <p>English: <code>Can edit their comments</code></p>
1939 <ul>
1940 <li><code>wcf.acp.group.option.user.foo.canDeleteComment</code></li>
1941 </ul>
1942 <p>German: <code>Kann eigene Kommentare löschen</code></p>
1943 <p>English: <code>Can delete their comments</code></p>
1944 <ul>
1945 <li><code>wcf.acp.group.option.mod.foo.canModerateComment</code></li>
1946 </ul>
1947 <p>German: <code>Kann Kommentare moderieren</code></p>
1948 <p>English: <code>Can moderate comments</code></p>
1949 <ul>
1950 <li><code>wcf.acp.group.option.mod.foo.canEditComment</code></li>
1951 </ul>
1952 <p>German: <code>Kann Kommentare bearbeiten</code></p>
1953 <p>English: <code>Can edit comments</code></p>
1954 <ul>
1955 <li><code>wcf.acp.group.option.mod.foo.canDeleteComment</code></li>
1956 </ul>
1957 <p>German: <code>Kann Kommentare löschen</code></p>
1958 <p>English: <code>Can delete comments</code></p>
1959
1960
1961
1962
1963
1964
1965
1966 </article>
1967 </div>
1968 </div>
1969 </main>
1970
1971
1972 <footer class="md-footer">
1973
1974 <nav class="md-footer__inner md-grid" aria-label="Footer">
1975
1976 <a href="../caches/" class="md-footer__link md-footer__link--prev" rel="prev">
1977 <div class="md-footer__button md-icon">
1978 <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>
1979 </div>
1980 <div class="md-footer__title">
1981 <div class="md-ellipsis">
1982 <span class="md-footer__direction">
1983 Previous
1984 </span>
1985 Caches
1986 </div>
1987 </div>
1988 </a>
1989
1990
1991 <a href="../cronjobs/" class="md-footer__link md-footer__link--next" rel="next">
1992 <div class="md-footer__title">
1993 <div class="md-ellipsis">
1994 <span class="md-footer__direction">
1995 Next
1996 </span>
1997 Cronjobs
1998 </div>
1999 </div>
2000 <div class="md-footer__button md-icon">
2001 <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>
2002 </div>
2003 </a>
2004
2005 </nav>
2006
2007 <div class="md-footer-meta md-typeset">
2008 <div class="md-footer-meta__inner md-grid">
2009 <div class="md-footer-copyright">
2010
2011 <div class="md-footer-copyright__highlight">
2012 Copyright © 2020 WoltLab GmbH
2013 </div>
2014
2015 Made with
2016 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2017 Material for MkDocs
2018 </a>
2019
2020 </div>
2021 <div class="md-footer-copyright">
2022 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2023 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2024 </div>
2025 </div>
2026 </div>
2027 </footer>
2028
2029 </div>
2030 <div class="md-dialog" data-md-component="dialog">
2031 <div class="md-dialog__inner md-typeset"></div>
2032 </div>
2033 <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>
2034
2035
2036 <script src="../../../assets/javascripts/bundle.5cf3e710.min.js"></script>
2037
2038
2039 </body>
2040 </html>