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>Code Snippets - 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=
"#code-snippets-javascript-api" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
84 <img src=
"../../assets/logo.png" alt=
"logo">
87 <label class=
"md-header__button md-icon" for=
"__drawer">
88 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 <div class=
"md-header__title" data-md-component=
"header-title">
91 <div class=
"md-header__ellipsis">
92 <div class=
"md-header__topic">
93 <span class=
"md-ellipsis">
94 WoltLab Suite Documentation
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
109 <label class=
"md-header__button md-icon" for=
"__search">
110 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
113 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
114 <label class=
"md-search__overlay" for=
"__search"></label>
115 <div class=
"md-search__inner" role=
"search">
116 <form class=
"md-search__form" name=
"search">
117 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
118 <label class=
"md-search__icon md-icon" for=
"__search">
119 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
120 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
122 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
123 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
126 <div class=
"md-search__output">
127 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
128 <div class=
"md-search-result" data-md-component=
"search-result">
129 <div class=
"md-search-result__meta">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
142 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
143 <div class=
"md-source__icon md-icon">
145 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
166 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
167 <div class=
"md-sidebar__scrollwrap">
168 <div class=
"md-sidebar__inner">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
184 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
185 <div class=
"md-source__icon md-icon">
187 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
229 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
230 <label class=
"md-nav__title" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
298 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
299 <label class=
"md-nav__title" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
309 <li class=
"md-nav__item">
310 <a href=
"../../php/api/caches/" class=
"md-nav__link">
321 <li class=
"md-nav__item">
322 <a href=
"../../php/api/comments/" class=
"md-nav__link">
333 <li class=
"md-nav__item">
334 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
345 <li class=
"md-nav__item">
346 <a href=
"../../php/api/events/" class=
"md-nav__link">
358 <li class=
"md-nav__item md-nav__item--nested">
361 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
363 <label class=
"md-nav__link" for=
"__nav_2_5_5">
365 <span class=
"md-nav__icon md-icon"></span>
367 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
368 <label class=
"md-nav__title" for=
"__nav_2_5_5">
369 <span class=
"md-nav__icon md-icon"></span>
372 <ul class=
"md-nav__list" data-md-scrollfix
>
378 <li class=
"md-nav__item">
379 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
390 <li class=
"md-nav__item">
391 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
402 <li class=
"md-nav__item">
403 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
414 <li class=
"md-nav__item">
415 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
426 <li class=
"md-nav__item">
427 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
444 <li class=
"md-nav__item">
445 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
446 Package Installation Plugins
456 <li class=
"md-nav__item">
457 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
468 <li class=
"md-nav__item">
469 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
480 <li class=
"md-nav__item">
481 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
498 <li class=
"md-nav__item">
499 <a href=
"../../php/code-style/" class=
"md-nav__link">
510 <li class=
"md-nav__item">
511 <a href=
"../../php/apps/" class=
"md-nav__link">
522 <li class=
"md-nav__item">
523 <a href=
"../../php/gdpr/" class=
"md-nav__link">
544 <li class=
"md-nav__item md-nav__item--nested">
547 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
549 <label class=
"md-nav__link" for=
"__nav_3">
550 Languages, Templates & CSS
551 <span class=
"md-nav__icon md-icon"></span>
553 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
554 <label class=
"md-nav__title" for=
"__nav_3">
555 <span class=
"md-nav__icon md-icon"></span>
556 Languages, Templates & CSS
558 <ul class=
"md-nav__list" data-md-scrollfix
>
564 <li class=
"md-nav__item">
565 <a href=
"../../view/languages/" class=
"md-nav__link">
576 <li class=
"md-nav__item">
577 <a href=
"../../view/templates/" class=
"md-nav__link">
588 <li class=
"md-nav__item">
589 <a href=
"../../view/css/" class=
"md-nav__link">
612 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
615 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" checked
>
617 <label class=
"md-nav__link" for=
"__nav_4">
618 TypeScript and JavaScript API
619 <span class=
"md-nav__icon md-icon"></span>
621 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
622 <label class=
"md-nav__title" for=
"__nav_4">
623 <span class=
"md-nav__icon md-icon"></span>
624 TypeScript and JavaScript API
626 <ul class=
"md-nav__list" data-md-scrollfix
>
632 <li class=
"md-nav__item">
633 <a href=
"../general-usage/" class=
"md-nav__link">
644 <li class=
"md-nav__item">
645 <a href=
"../typescript/" class=
"md-nav__link">
657 <li class=
"md-nav__item md-nav__item--nested">
660 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
662 <label class=
"md-nav__link" for=
"__nav_4_3">
664 <span class=
"md-nav__icon md-icon"></span>
666 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
667 <label class=
"md-nav__title" for=
"__nav_4_3">
668 <span class=
"md-nav__icon md-icon"></span>
671 <ul class=
"md-nav__list" data-md-scrollfix
>
677 <li class=
"md-nav__item">
678 <a href=
"../new-api_writing-a-module/" class=
"md-nav__link">
689 <li class=
"md-nav__item">
690 <a href=
"../new-api_data-structures/" class=
"md-nav__link">
701 <li class=
"md-nav__item">
702 <a href=
"../new-api_core/" class=
"md-nav__link">
713 <li class=
"md-nav__item">
714 <a href=
"../new-api_dom/" class=
"md-nav__link">
725 <li class=
"md-nav__item">
726 <a href=
"../new-api_events/" class=
"md-nav__link">
737 <li class=
"md-nav__item">
738 <a href=
"../new-api_ajax/" class=
"md-nav__link">
749 <li class=
"md-nav__item">
750 <a href=
"../new-api_dialogs/" class=
"md-nav__link">
761 <li class=
"md-nav__item">
762 <a href=
"../new-api_browser/" class=
"md-nav__link">
763 Browser and Screen Sizes
773 <li class=
"md-nav__item">
774 <a href=
"../new-api_ui/" class=
"md-nav__link">
791 <li class=
"md-nav__item">
792 <a href=
"../legacy-api/" class=
"md-nav__link">
803 <li class=
"md-nav__item">
804 <a href=
"../helper-functions/" class=
"md-nav__link">
817 <li class=
"md-nav__item md-nav__item--active">
819 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
824 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
826 <span class=
"md-nav__icon md-icon"></span>
829 <a href=
"./" class=
"md-nav__link md-nav__link--active">
834 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
840 <label class=
"md-nav__title" for=
"__toc">
841 <span class=
"md-nav__icon md-icon"></span>
844 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
846 <li class=
"md-nav__item">
847 <a href=
"#imageviewer" class=
"md-nav__link">
875 <li class=
"md-nav__item md-nav__item--nested">
878 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
880 <label class=
"md-nav__link" for=
"__nav_5">
882 <span class=
"md-nav__icon md-icon"></span>
884 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
885 <label class=
"md-nav__title" for=
"__nav_5">
886 <span class=
"md-nav__icon md-icon"></span>
889 <ul class=
"md-nav__list" data-md-scrollfix
>
895 <li class=
"md-nav__item">
896 <a href=
"../../package/package-xml/" class=
"md-nav__link">
908 <li class=
"md-nav__item md-nav__item--nested">
911 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
913 <label class=
"md-nav__link" for=
"__nav_5_2">
915 <span class=
"md-nav__icon md-icon"></span>
917 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
918 <label class=
"md-nav__title" for=
"__nav_5_2">
919 <span class=
"md-nav__icon md-icon"></span>
922 <ul class=
"md-nav__list" data-md-scrollfix
>
928 <li class=
"md-nav__item">
929 <a href=
"../../package/pip/" class=
"md-nav__link">
940 <li class=
"md-nav__item">
941 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
952 <li class=
"md-nav__item">
953 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
964 <li class=
"md-nav__item">
965 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
976 <li class=
"md-nav__item">
977 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
988 <li class=
"md-nav__item">
989 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1000 <li class=
"md-nav__item">
1001 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1012 <li class=
"md-nav__item">
1013 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1024 <li class=
"md-nav__item">
1025 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1036 <li class=
"md-nav__item">
1037 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1048 <li class=
"md-nav__item">
1049 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1060 <li class=
"md-nav__item">
1061 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1072 <li class=
"md-nav__item">
1073 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1084 <li class=
"md-nav__item">
1085 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1096 <li class=
"md-nav__item">
1097 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1108 <li class=
"md-nav__item">
1109 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1120 <li class=
"md-nav__item">
1121 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1132 <li class=
"md-nav__item">
1133 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1134 objectTypeDefinition
1144 <li class=
"md-nav__item">
1145 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1156 <li class=
"md-nav__item">
1157 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1168 <li class=
"md-nav__item">
1169 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1180 <li class=
"md-nav__item">
1181 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1192 <li class=
"md-nav__item">
1193 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1216 <li class=
"md-nav__item">
1217 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1228 <li class=
"md-nav__item">
1229 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1240 <li class=
"md-nav__item">
1241 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1252 <li class=
"md-nav__item">
1253 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1264 <li class=
"md-nav__item">
1265 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1276 <li class=
"md-nav__item">
1277 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1278 userNotificationEvent
1288 <li class=
"md-nav__item">
1289 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1300 <li class=
"md-nav__item">
1301 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1318 <li class=
"md-nav__item">
1319 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1340 <li class=
"md-nav__item md-nav__item--nested">
1343 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1345 <label class=
"md-nav__link" for=
"__nav_6">
1347 <span class=
"md-nav__icon md-icon"></span>
1349 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1350 <label class=
"md-nav__title" for=
"__nav_6">
1351 <span class=
"md-nav__icon md-icon"></span>
1354 <ul class=
"md-nav__list" data-md-scrollfix
>
1361 <li class=
"md-nav__item md-nav__item--nested">
1364 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1366 <label class=
"md-nav__link" for=
"__nav_6_1">
1367 Migrating from WSC
5.3
1368 <span class=
"md-nav__icon md-icon"></span>
1370 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1371 <label class=
"md-nav__title" for=
"__nav_6_1">
1372 <span class=
"md-nav__icon md-icon"></span>
1373 Migrating from WSC
5.3
1375 <ul class=
"md-nav__list" data-md-scrollfix
>
1381 <li class=
"md-nav__item">
1382 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1393 <li class=
"md-nav__item">
1394 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1395 Session Handling and Authentication
1405 <li class=
"md-nav__item">
1406 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1407 TypeScript and JavaScript
1417 <li class=
"md-nav__item">
1418 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1429 <li class=
"md-nav__item">
1430 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1431 Third Party Libraries
1448 <li class=
"md-nav__item md-nav__item--nested">
1451 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1453 <label class=
"md-nav__link" for=
"__nav_6_2">
1454 Migrating from WSC
5.2
1455 <span class=
"md-nav__icon md-icon"></span>
1457 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1458 <label class=
"md-nav__title" for=
"__nav_6_2">
1459 <span class=
"md-nav__icon md-icon"></span>
1460 Migrating from WSC
5.2
1462 <ul class=
"md-nav__list" data-md-scrollfix
>
1468 <li class=
"md-nav__item">
1469 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1480 <li class=
"md-nav__item">
1481 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1482 Templates and Languages
1492 <li class=
"md-nav__item">
1493 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1494 Third Party Libraries
1511 <li class=
"md-nav__item md-nav__item--nested">
1514 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1516 <label class=
"md-nav__link" for=
"__nav_6_3">
1517 Migrating from WSC
3.1
1518 <span class=
"md-nav__icon md-icon"></span>
1520 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1521 <label class=
"md-nav__title" for=
"__nav_6_3">
1522 <span class=
"md-nav__icon md-icon"></span>
1523 Migrating from WSC
3.1
1525 <ul class=
"md-nav__list" data-md-scrollfix
>
1531 <li class=
"md-nav__item">
1532 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1550 <li class=
"md-nav__item md-nav__item--nested">
1553 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1555 <label class=
"md-nav__link" for=
"__nav_6_4">
1556 Migrating from WSC
3.0
1557 <span class=
"md-nav__icon md-icon"></span>
1559 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1560 <label class=
"md-nav__title" for=
"__nav_6_4">
1561 <span class=
"md-nav__icon md-icon"></span>
1562 Migrating from WSC
3.0
1564 <ul class=
"md-nav__list" data-md-scrollfix
>
1570 <li class=
"md-nav__item">
1571 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1582 <li class=
"md-nav__item">
1583 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1594 <li class=
"md-nav__item">
1595 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1606 <li class=
"md-nav__item">
1607 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1618 <li class=
"md-nav__item">
1619 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1637 <li class=
"md-nav__item md-nav__item--nested">
1640 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1642 <label class=
"md-nav__link" for=
"__nav_6_5">
1643 Migrating from WCF
2.1
1644 <span class=
"md-nav__icon md-icon"></span>
1646 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1647 <label class=
"md-nav__title" for=
"__nav_6_5">
1648 <span class=
"md-nav__icon md-icon"></span>
1649 Migrating from WCF
2.1
1651 <ul class=
"md-nav__list" data-md-scrollfix
>
1657 <li class=
"md-nav__item">
1658 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1669 <li class=
"md-nav__item">
1670 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1681 <li class=
"md-nav__item">
1682 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1693 <li class=
"md-nav__item">
1694 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1721 <li class=
"md-nav__item md-nav__item--nested">
1724 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1726 <label class=
"md-nav__link" for=
"__nav_7">
1728 <span class=
"md-nav__icon md-icon"></span>
1730 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1731 <label class=
"md-nav__title" for=
"__nav_7">
1732 <span class=
"md-nav__icon md-icon"></span>
1735 <ul class=
"md-nav__list" data-md-scrollfix
>
1742 <li class=
"md-nav__item md-nav__item--nested">
1745 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1747 <label class=
"md-nav__link" for=
"__nav_7_1">
1749 <span class=
"md-nav__icon md-icon"></span>
1751 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1752 <label class=
"md-nav__title" for=
"__nav_7_1">
1753 <span class=
"md-nav__icon md-icon"></span>
1756 <ul class=
"md-nav__list" data-md-scrollfix
>
1762 <li class=
"md-nav__item">
1763 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1774 <li class=
"md-nav__item">
1775 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1786 <li class=
"md-nav__item">
1787 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1798 <li class=
"md-nav__item">
1799 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1826 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1827 <div class=
"md-sidebar__scrollwrap">
1828 <div class=
"md-sidebar__inner">
1830 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1836 <label class=
"md-nav__title" for=
"__toc">
1837 <span class=
"md-nav__icon md-icon"></span>
1840 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1842 <li class=
"md-nav__item">
1843 <a href=
"#imageviewer" class=
"md-nav__link">
1857 <div class=
"md-content" data-md-component=
"content">
1858 <article class=
"md-content__inner md-typeset">
1861 <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">
1862 <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>
1866 <h1 id=
"code-snippets-javascript-api">Code Snippets - JavaScript API
<a class=
"headerlink" href=
"#code-snippets-javascript-api" title=
"Permanent link">#
</a></h1>
1867 <p>This is a list of code snippets that do not fit into any of the other articles
1868 and merely describe how to achieve something very specific, rather than explaining
1869 the inner workings of a function.
</p>
1870 <h2 id=
"imageviewer">ImageViewer
<a class=
"headerlink" href=
"#imageviewer" title=
"Permanent link">#
</a></h2>
1871 <p>The ImageViewer is available on all frontend pages by default, you can easily
1872 add images to the viewer by wrapping the thumbnails with a link with the CSS
1873 class
<code>jsImageViewer
</code> that points to the full version.
</p>
1874 <div class=
"highlight"><pre><span></span><code><span class=
"p"><</span><span class=
"nt">a
</span> <span class=
"na">href
</span><span class=
"o">=
</span><span class=
"s">"http://example.com/full.jpg
"</span> <span class=
"na">class
</span><span class=
"o">=
</span><span class=
"s">"jsImageViewer
"</span><span class=
"p">></span>
1875 <span class=
"p"><</span><span class=
"nt">img
</span> <span class=
"na">src
</span><span class=
"o">=
</span><span class=
"s">"http://example.com/thumbnail.jpg
"</span><span class=
"p">></span>
1876 <span class=
"p"></
</span><span class=
"nt">a
</span><span class=
"p">></span>
1883 <div class=
"md-source-date">
1886 Last update:
2021-
01-
08
1905 <footer class=
"md-footer">
1907 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
1909 <a href=
"../helper-functions/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
1910 <div class=
"md-footer__button md-icon">
1911 <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>
1913 <div class=
"md-footer__title">
1914 <div class=
"md-ellipsis">
1915 <span class=
"md-footer__direction">
1924 <a href=
"../../package/package-xml/" class=
"md-footer__link md-footer__link--next" rel=
"next">
1925 <div class=
"md-footer__title">
1926 <div class=
"md-ellipsis">
1927 <span class=
"md-footer__direction">
1933 <div class=
"md-footer__button md-icon">
1934 <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>
1940 <div class=
"md-footer-meta md-typeset">
1941 <div class=
"md-footer-meta__inner md-grid">
1942 <div class=
"md-footer-copyright">
1944 <div class=
"md-footer-copyright__highlight">
1945 Copyright ©
2020 WoltLab GmbH
1949 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
1954 <div class=
"md-footer-copyright">
1955 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
1956 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
1963 <div class=
"md-dialog" data-md-component=
"dialog">
1964 <div class=
"md-dialog__inner md-typeset"></div>
1966 <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>
1969 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>