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