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>Core Functions - 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=
"#core-modules-and-functions-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
>
310 <li class=
"md-nav__item md-nav__item--nested">
313 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
315 <label class=
"md-nav__link" for=
"__nav_2_5_1">
317 <span class=
"md-nav__icon md-icon"></span>
319 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
320 <label class=
"md-nav__title" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
324 <ul class=
"md-nav__list" data-md-scrollfix
>
330 <li class=
"md-nav__item">
331 <a href=
"../../php/api/caches/" class=
"md-nav__link">
342 <li class=
"md-nav__item">
343 <a href=
"../../php/api/caches_persistent-caches/" class=
"md-nav__link">
354 <li class=
"md-nav__item">
355 <a href=
"../../php/api/caches_runtime-caches/" class=
"md-nav__link">
372 <li class=
"md-nav__item">
373 <a href=
"../../php/api/comments/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../php/api/events/" class=
"md-nav__link">
409 <li class=
"md-nav__item md-nav__item--nested">
412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
414 <label class=
"md-nav__link" for=
"__nav_2_5_5">
416 <span class=
"md-nav__icon md-icon"></span>
418 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
419 <label class=
"md-nav__title" for=
"__nav_2_5_5">
420 <span class=
"md-nav__icon md-icon"></span>
423 <ul class=
"md-nav__list" data-md-scrollfix
>
429 <li class=
"md-nav__item">
430 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
453 <li class=
"md-nav__item">
454 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
465 <li class=
"md-nav__item">
466 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
495 <li class=
"md-nav__item">
496 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
497 Package Installation Plugins
507 <li class=
"md-nav__item">
508 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
549 <li class=
"md-nav__item">
550 <a href=
"../../php/code-style/" class=
"md-nav__link">
561 <li class=
"md-nav__item">
562 <a href=
"../../php/apps/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../php/gdpr/" class=
"md-nav__link">
595 <li class=
"md-nav__item md-nav__item--nested">
598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
600 <label class=
"md-nav__link" for=
"__nav_3">
601 Languages, Templates & CSS
602 <span class=
"md-nav__icon md-icon"></span>
604 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
605 <label class=
"md-nav__title" for=
"__nav_3">
606 <span class=
"md-nav__icon md-icon"></span>
607 Languages, Templates & CSS
609 <ul class=
"md-nav__list" data-md-scrollfix
>
615 <li class=
"md-nav__item">
616 <a href=
"../../view/languages/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../../view/templates/" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"../../view/template-plugins/" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"../../view/css/" class=
"md-nav__link">
675 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
678 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" checked
>
680 <label class=
"md-nav__link" for=
"__nav_4">
681 TypeScript and JavaScript API
682 <span class=
"md-nav__icon md-icon"></span>
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
689 <ul class=
"md-nav__list" data-md-scrollfix
>
695 <li class=
"md-nav__item">
696 <a href=
"../general-usage/" class=
"md-nav__link">
707 <li class=
"md-nav__item">
708 <a href=
"../typescript/" class=
"md-nav__link">
722 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
725 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" checked
>
727 <label class=
"md-nav__link" for=
"__nav_4_3">
729 <span class=
"md-nav__icon md-icon"></span>
731 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
732 <label class=
"md-nav__title" for=
"__nav_4_3">
733 <span class=
"md-nav__icon md-icon"></span>
736 <ul class=
"md-nav__list" data-md-scrollfix
>
742 <li class=
"md-nav__item">
743 <a href=
"../new-api_writing-a-module/" class=
"md-nav__link">
754 <li class=
"md-nav__item">
755 <a href=
"../new-api_data-structures/" class=
"md-nav__link">
768 <li class=
"md-nav__item md-nav__item--active">
770 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
775 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
777 <span class=
"md-nav__icon md-icon"></span>
780 <a href=
"./" class=
"md-nav__link md-nav__link--active">
785 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
791 <label class=
"md-nav__title" for=
"__toc">
792 <span class=
"md-nav__icon md-icon"></span>
795 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
797 <li class=
"md-nav__item">
798 <a href=
"#core" class=
"md-nav__link">
802 <nav class=
"md-nav" aria-label=
"Core">
803 <ul class=
"md-nav__list">
805 <li class=
"md-nav__item">
806 <a href=
"#cloneobject-object-object" class=
"md-nav__link">
807 clone(object: Object): Object
812 <li class=
"md-nav__item">
813 <a href=
"#extendbase-object-merge-object-object" class=
"md-nav__link">
814 extend(base: Object, ...merge: Object[]): Object
819 <li class=
"md-nav__item">
820 <a href=
"#inheritbase-object-target-object-merge-object" class=
"md-nav__link">
821 inherit(base: Object, target: Object, merge?: Object)
826 <li class=
"md-nav__item">
827 <a href=
"#isplainobjectobject-object-boolean" class=
"md-nav__link">
828 isPlainObject(object: Object): boolean
833 <li class=
"md-nav__item">
834 <a href=
"#triggereventelement-element-eventname-string" class=
"md-nav__link">
835 triggerEvent(element: Element, eventName: string)
845 <li class=
"md-nav__item">
846 <a href=
"#language" class=
"md-nav__link">
850 <nav class=
"md-nav" aria-label=
"Language">
851 <ul class=
"md-nav__list">
853 <li class=
"md-nav__item">
854 <a href=
"#addkey-string-value-string" class=
"md-nav__link">
855 add(key: string, value: string)
860 <li class=
"md-nav__item">
861 <a href=
"#addobjectobject-object" class=
"md-nav__link">
862 addObject(object: Object)
867 <li class=
"md-nav__item">
868 <a href=
"#getkey-string-parameters-object-string" class=
"md-nav__link">
869 get(key: string, parameters?: Object): string
879 <li class=
"md-nav__item">
880 <a href=
"#stringutil" class=
"md-nav__link">
884 <nav class=
"md-nav" aria-label=
"StringUtil">
885 <ul class=
"md-nav__list">
887 <li class=
"md-nav__item">
888 <a href=
"#escapehtmlstr-string-string" class=
"md-nav__link">
889 escapeHTML(str: string): string
894 <li class=
"md-nav__item">
895 <a href=
"#escaperegexpstr-string-string" class=
"md-nav__link">
896 escapeRegExp(str: string): string
901 <li class=
"md-nav__item">
902 <a href=
"#lcfirststr-string-string" class=
"md-nav__link">
903 lcfirst(str: string): string
908 <li class=
"md-nav__item">
909 <a href=
"#ucfirststr-string-string" class=
"md-nav__link">
910 ucfirst(str: string): string
915 <li class=
"md-nav__item">
916 <a href=
"#unescapehtmlstr-string-string" class=
"md-nav__link">
917 unescapeHTML(str: string): string
939 <li class=
"md-nav__item">
940 <a href=
"../new-api_dom/" class=
"md-nav__link">
951 <li class=
"md-nav__item">
952 <a href=
"../new-api_events/" class=
"md-nav__link">
963 <li class=
"md-nav__item">
964 <a href=
"../new-api_ajax/" class=
"md-nav__link">
975 <li class=
"md-nav__item">
976 <a href=
"../new-api_dialogs/" class=
"md-nav__link">
987 <li class=
"md-nav__item">
988 <a href=
"../new-api_browser/" class=
"md-nav__link">
989 Browser and Screen Sizes
999 <li class=
"md-nav__item">
1000 <a href=
"../new-api_ui/" class=
"md-nav__link">
1017 <li class=
"md-nav__item">
1018 <a href=
"../legacy-api/" class=
"md-nav__link">
1029 <li class=
"md-nav__item">
1030 <a href=
"../helper-functions/" class=
"md-nav__link">
1041 <li class=
"md-nav__item">
1042 <a href=
"../code-snippets/" class=
"md-nav__link">
1063 <li class=
"md-nav__item md-nav__item--nested">
1066 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1068 <label class=
"md-nav__link" for=
"__nav_5">
1070 <span class=
"md-nav__icon md-icon"></span>
1072 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1073 <label class=
"md-nav__title" for=
"__nav_5">
1074 <span class=
"md-nav__icon md-icon"></span>
1077 <ul class=
"md-nav__list" data-md-scrollfix
>
1083 <li class=
"md-nav__item">
1084 <a href=
"../../package/package-xml/" class=
"md-nav__link">
1096 <li class=
"md-nav__item md-nav__item--nested">
1099 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1101 <label class=
"md-nav__link" for=
"__nav_5_2">
1103 <span class=
"md-nav__icon md-icon"></span>
1105 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1106 <label class=
"md-nav__title" for=
"__nav_5_2">
1107 <span class=
"md-nav__icon md-icon"></span>
1110 <ul class=
"md-nav__list" data-md-scrollfix
>
1116 <li class=
"md-nav__item">
1117 <a href=
"../../package/pip/" class=
"md-nav__link">
1128 <li class=
"md-nav__item">
1129 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1140 <li class=
"md-nav__item">
1141 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1152 <li class=
"md-nav__item">
1153 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1164 <li class=
"md-nav__item">
1165 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1176 <li class=
"md-nav__item">
1177 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1188 <li class=
"md-nav__item">
1189 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1200 <li class=
"md-nav__item">
1201 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1212 <li class=
"md-nav__item">
1213 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1224 <li class=
"md-nav__item">
1225 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1236 <li class=
"md-nav__item">
1237 <a href=
"../../package/pip/database/" class=
"md-nav__link">
1248 <li class=
"md-nav__item">
1249 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1260 <li class=
"md-nav__item">
1261 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1272 <li class=
"md-nav__item">
1273 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1284 <li class=
"md-nav__item">
1285 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1296 <li class=
"md-nav__item">
1297 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1308 <li class=
"md-nav__item">
1309 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1320 <li class=
"md-nav__item">
1321 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1332 <li class=
"md-nav__item">
1333 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1334 objectTypeDefinition
1344 <li class=
"md-nav__item">
1345 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1356 <li class=
"md-nav__item">
1357 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1368 <li class=
"md-nav__item">
1369 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1380 <li class=
"md-nav__item">
1381 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1392 <li class=
"md-nav__item">
1393 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1404 <li class=
"md-nav__item">
1405 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1416 <li class=
"md-nav__item">
1417 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1428 <li class=
"md-nav__item">
1429 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1440 <li class=
"md-nav__item">
1441 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1452 <li class=
"md-nav__item">
1453 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1464 <li class=
"md-nav__item">
1465 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1476 <li class=
"md-nav__item">
1477 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1478 userNotificationEvent
1488 <li class=
"md-nav__item">
1489 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1500 <li class=
"md-nav__item">
1501 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1518 <li class=
"md-nav__item">
1519 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1540 <li class=
"md-nav__item md-nav__item--nested">
1543 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1545 <label class=
"md-nav__link" for=
"__nav_6">
1547 <span class=
"md-nav__icon md-icon"></span>
1549 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1550 <label class=
"md-nav__title" for=
"__nav_6">
1551 <span class=
"md-nav__icon md-icon"></span>
1554 <ul class=
"md-nav__list" data-md-scrollfix
>
1561 <li class=
"md-nav__item md-nav__item--nested">
1564 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1566 <label class=
"md-nav__link" for=
"__nav_6_1">
1567 Migrating from WSC
5.3
1568 <span class=
"md-nav__icon md-icon"></span>
1570 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1571 <label class=
"md-nav__title" for=
"__nav_6_1">
1572 <span class=
"md-nav__icon md-icon"></span>
1573 Migrating from WSC
5.3
1575 <ul class=
"md-nav__list" data-md-scrollfix
>
1581 <li class=
"md-nav__item">
1582 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1593 <li class=
"md-nav__item">
1594 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1595 Session Handling and Authentication
1605 <li class=
"md-nav__item">
1606 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1607 TypeScript and JavaScript
1617 <li class=
"md-nav__item">
1618 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1629 <li class=
"md-nav__item">
1630 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1631 Third Party Libraries
1648 <li class=
"md-nav__item md-nav__item--nested">
1651 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1653 <label class=
"md-nav__link" for=
"__nav_6_2">
1654 Migrating from WSC
5.2
1655 <span class=
"md-nav__icon md-icon"></span>
1657 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1658 <label class=
"md-nav__title" for=
"__nav_6_2">
1659 <span class=
"md-nav__icon md-icon"></span>
1660 Migrating from WSC
5.2
1662 <ul class=
"md-nav__list" data-md-scrollfix
>
1668 <li class=
"md-nav__item">
1669 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1680 <li class=
"md-nav__item">
1681 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1682 Templates and Languages
1692 <li class=
"md-nav__item">
1693 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1694 Third Party Libraries
1711 <li class=
"md-nav__item md-nav__item--nested">
1714 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1716 <label class=
"md-nav__link" for=
"__nav_6_3">
1717 Migrating from WSC
3.1
1718 <span class=
"md-nav__icon md-icon"></span>
1720 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1721 <label class=
"md-nav__title" for=
"__nav_6_3">
1722 <span class=
"md-nav__icon md-icon"></span>
1723 Migrating from WSC
3.1
1725 <ul class=
"md-nav__list" data-md-scrollfix
>
1731 <li class=
"md-nav__item">
1732 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1750 <li class=
"md-nav__item md-nav__item--nested">
1753 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1755 <label class=
"md-nav__link" for=
"__nav_6_4">
1756 Migrating from WSC
3.0
1757 <span class=
"md-nav__icon md-icon"></span>
1759 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1760 <label class=
"md-nav__title" for=
"__nav_6_4">
1761 <span class=
"md-nav__icon md-icon"></span>
1762 Migrating from WSC
3.0
1764 <ul class=
"md-nav__list" data-md-scrollfix
>
1770 <li class=
"md-nav__item">
1771 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1782 <li class=
"md-nav__item">
1783 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1794 <li class=
"md-nav__item">
1795 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1806 <li class=
"md-nav__item">
1807 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1818 <li class=
"md-nav__item">
1819 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1837 <li class=
"md-nav__item md-nav__item--nested">
1840 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1842 <label class=
"md-nav__link" for=
"__nav_6_5">
1843 Migrating from WCF
2.1
1844 <span class=
"md-nav__icon md-icon"></span>
1846 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1847 <label class=
"md-nav__title" for=
"__nav_6_5">
1848 <span class=
"md-nav__icon md-icon"></span>
1849 Migrating from WCF
2.1
1851 <ul class=
"md-nav__list" data-md-scrollfix
>
1857 <li class=
"md-nav__item">
1858 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1869 <li class=
"md-nav__item">
1870 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1881 <li class=
"md-nav__item">
1882 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1893 <li class=
"md-nav__item">
1894 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1921 <li class=
"md-nav__item md-nav__item--nested">
1924 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1926 <label class=
"md-nav__link" for=
"__nav_7">
1928 <span class=
"md-nav__icon md-icon"></span>
1930 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1931 <label class=
"md-nav__title" for=
"__nav_7">
1932 <span class=
"md-nav__icon md-icon"></span>
1935 <ul class=
"md-nav__list" data-md-scrollfix
>
1942 <li class=
"md-nav__item md-nav__item--nested">
1945 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1947 <label class=
"md-nav__link" for=
"__nav_7_1">
1949 <span class=
"md-nav__icon md-icon"></span>
1951 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1952 <label class=
"md-nav__title" for=
"__nav_7_1">
1953 <span class=
"md-nav__icon md-icon"></span>
1956 <ul class=
"md-nav__list" data-md-scrollfix
>
1962 <li class=
"md-nav__item">
1963 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1974 <li class=
"md-nav__item">
1975 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1986 <li class=
"md-nav__item">
1987 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1998 <li class=
"md-nav__item">
1999 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
2026 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2027 <div class=
"md-sidebar__scrollwrap">
2028 <div class=
"md-sidebar__inner">
2030 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2036 <label class=
"md-nav__title" for=
"__toc">
2037 <span class=
"md-nav__icon md-icon"></span>
2040 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2042 <li class=
"md-nav__item">
2043 <a href=
"#core" class=
"md-nav__link">
2047 <nav class=
"md-nav" aria-label=
"Core">
2048 <ul class=
"md-nav__list">
2050 <li class=
"md-nav__item">
2051 <a href=
"#cloneobject-object-object" class=
"md-nav__link">
2052 clone(object: Object): Object
2057 <li class=
"md-nav__item">
2058 <a href=
"#extendbase-object-merge-object-object" class=
"md-nav__link">
2059 extend(base: Object, ...merge: Object[]): Object
2064 <li class=
"md-nav__item">
2065 <a href=
"#inheritbase-object-target-object-merge-object" class=
"md-nav__link">
2066 inherit(base: Object, target: Object, merge?: Object)
2071 <li class=
"md-nav__item">
2072 <a href=
"#isplainobjectobject-object-boolean" class=
"md-nav__link">
2073 isPlainObject(object: Object): boolean
2078 <li class=
"md-nav__item">
2079 <a href=
"#triggereventelement-element-eventname-string" class=
"md-nav__link">
2080 triggerEvent(element: Element, eventName: string)
2090 <li class=
"md-nav__item">
2091 <a href=
"#language" class=
"md-nav__link">
2095 <nav class=
"md-nav" aria-label=
"Language">
2096 <ul class=
"md-nav__list">
2098 <li class=
"md-nav__item">
2099 <a href=
"#addkey-string-value-string" class=
"md-nav__link">
2100 add(key: string, value: string)
2105 <li class=
"md-nav__item">
2106 <a href=
"#addobjectobject-object" class=
"md-nav__link">
2107 addObject(object: Object)
2112 <li class=
"md-nav__item">
2113 <a href=
"#getkey-string-parameters-object-string" class=
"md-nav__link">
2114 get(key: string, parameters?: Object): string
2124 <li class=
"md-nav__item">
2125 <a href=
"#stringutil" class=
"md-nav__link">
2129 <nav class=
"md-nav" aria-label=
"StringUtil">
2130 <ul class=
"md-nav__list">
2132 <li class=
"md-nav__item">
2133 <a href=
"#escapehtmlstr-string-string" class=
"md-nav__link">
2134 escapeHTML(str: string): string
2139 <li class=
"md-nav__item">
2140 <a href=
"#escaperegexpstr-string-string" class=
"md-nav__link">
2141 escapeRegExp(str: string): string
2146 <li class=
"md-nav__item">
2147 <a href=
"#lcfirststr-string-string" class=
"md-nav__link">
2148 lcfirst(str: string): string
2153 <li class=
"md-nav__item">
2154 <a href=
"#ucfirststr-string-string" class=
"md-nav__link">
2155 ucfirst(str: string): string
2160 <li class=
"md-nav__item">
2161 <a href=
"#unescapehtmlstr-string-string" class=
"md-nav__link">
2162 unescapeHTML(str: string): string
2180 <div class=
"md-content" data-md-component=
"content">
2181 <article class=
"md-content__inner md-typeset">
2184 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/javascript/new-api_core.md" title=
"Edit this page" class=
"md-content__button md-icon">
2185 <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>
2189 <h1 id=
"core-modules-and-functions-javascript-api">Core Modules and Functions - JavaScript API
<a class=
"headerlink" href=
"#core-modules-and-functions-javascript-api" title=
"Permanent link">#
</a></h1>
2190 <p>A brief overview of common methods that may be useful when writing any module.
</p>
2191 <h2 id=
"core"><code>Core
</code><a class=
"headerlink" href=
"#core" title=
"Permanent link">#
</a></h2>
2192 <h3 id=
"cloneobject-object-object"><code>clone(object: Object): Object
</code><a class=
"headerlink" href=
"#cloneobject-object-object" title=
"Permanent link">#
</a></h3>
2193 <p>Creates a deep-clone of the provided object by value, removing any references on
2194 the original element, including arrays. However, this does not clone references
2195 to non-plain objects, these instances will be copied by reference.
</p>
2196 <div class=
"highlight"><pre><span></span><code><span class=
"nx">require
</span><span class=
"p">([
</span><span class=
"s2">"Core
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Core
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2197 <span class=
"kd">var
</span> <span class=
"nx">obj1
</span> <span class=
"o">=
</span> <span class=
"p">{
</span> <span class=
"nx">a
</span><span class=
"o">:
</span> <span class=
"mf">1</span> <span class=
"p">};
</span>
2198 <span class=
"kd">var
</span> <span class=
"nx">obj2
</span> <span class=
"o">=
</span> <span class=
"nx">Core
</span><span class=
"p">.
</span><span class=
"nx">clone
</span><span class=
"p">(
</span><span class=
"nx">obj1
</span><span class=
"p">);
</span>
2200 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span><span class=
"p">(
</span><span class=
"nx">obj1
</span> <span class=
"o">===
</span> <span class=
"nx">obj2
</span><span class=
"p">);
</span> <span class=
"c1">// output: false
</span>
2201 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span><span class=
"p">(
</span><span class=
"nx">obj2
</span><span class=
"p">.
</span><span class=
"nx">hasOwnProperty
</span><span class=
"p">(
</span><span class=
"s2">"a
"</span><span class=
"p">)
</span> <span class=
"o">&&</span> <span class=
"nx">obj2
</span><span class=
"p">.
</span><span class=
"nx">a
</span> <span class=
"o">===
</span> <span class=
"mf">1</span><span class=
"p">);
</span> <span class=
"c1">// output: true
</span>
2202 <span class=
"p">});
</span>
2204 <h3 id=
"extendbase-object-merge-object-object"><code>extend(base: Object, ...merge: Object[]): Object
</code><a class=
"headerlink" href=
"#extendbase-object-merge-object-object" title=
"Permanent link">#
</a></h3>
2205 <p>Accepts an infinite amount of plain objects as parameters, values will be copied
2206 from the
2nd...nth object into the first object. The first parameter will be
2207 cloned and the resulting object is returned.
</p>
2208 <div class=
"highlight"><pre><span></span><code><span class=
"nx">require
</span><span class=
"p">([
</span><span class=
"s2">"Core
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Core
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2209 <span class=
"kd">var
</span> <span class=
"nx">obj1
</span> <span class=
"o">=
</span> <span class=
"p">{
</span> <span class=
"nx">a
</span><span class=
"o">:
</span> <span class=
"mf">2</span> <span class=
"p">};
</span>
2210 <span class=
"kd">var
</span> <span class=
"nx">obj2
</span> <span class=
"o">=
</span> <span class=
"p">{
</span> <span class=
"nx">a
</span><span class=
"o">:
</span> <span class=
"mf">1</span><span class=
"p">,
</span> <span class=
"nx">b
</span><span class=
"o">:
</span> <span class=
"mf">2</span> <span class=
"p">};
</span>
2211 <span class=
"kd">var
</span> <span class=
"nx">obj
</span> <span class=
"o">=
</span> <span class=
"nx">Core
</span><span class=
"p">.
</span><span class=
"nx">extend
</span><span class=
"p">({
</span>
2212 <span class=
"nx">b
</span><span class=
"o">:
</span> <span class=
"mf">1</span>
2213 <span class=
"p">},
</span> <span class=
"nx">obj1
</span><span class=
"p">,
</span> <span class=
"nx">obj2
</span><span class=
"p">);
</span>
2215 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span><span class=
"p">(
</span><span class=
"nx">obj
</span><span class=
"p">.
</span><span class=
"nx">b
</span> <span class=
"o">===
</span> <span class=
"mf">2</span><span class=
"p">);
</span> <span class=
"c1">// output: true
</span>
2216 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span><span class=
"p">(
</span><span class=
"nx">obj
</span><span class=
"p">.
</span><span class=
"nx">hasOwnProperty
</span><span class=
"p">(
</span><span class=
"s2">"a
"</span><span class=
"p">)
</span> <span class=
"o">&&</span> <span class=
"nx">obj
</span><span class=
"p">.
</span><span class=
"nx">a
</span> <span class=
"o">===
</span> <span class=
"mf">2</span><span class=
"p">);
</span> <span class=
"c1">// output: false
</span>
2217 <span class=
"p">});
</span>
2219 <h3 id=
"inheritbase-object-target-object-merge-object"><code>inherit(base: Object, target: Object, merge?: Object)
</code><a class=
"headerlink" href=
"#inheritbase-object-target-object-merge-object" title=
"Permanent link">#
</a></h3>
2220 <p>Derives the second object's prototype from the first object, afterwards the
2221 derived class will pass the
<code>instanceof
</code> check against the original class.
</p>
2222 <div class=
"highlight"><pre><span></span><code><span class=
"c1">// App.js
</span>
2223 <span class=
"nb">window
</span><span class=
"p">.
</span><span class=
"nx">App
</span> <span class=
"o">=
</span> <span class=
"p">{};
</span>
2224 <span class=
"nx">App
</span><span class=
"p">.
</span><span class=
"nx">Foo
</span> <span class=
"o">=
</span> <span class=
"nx">Class
</span><span class=
"p">.
</span><span class=
"nx">extend
</span><span class=
"p">({
</span>
2225 <span class=
"nx">bar
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2226 <span class=
"p">});
</span>
2227 <span class=
"nx">App
</span><span class=
"p">.
</span><span class=
"nx">Baz
</span> <span class=
"o">=
</span> <span class=
"nx">App
</span><span class=
"p">.
</span><span class=
"nx">Foo
</span><span class=
"p">.
</span><span class=
"nx">extend
</span><span class=
"p">({
</span>
2228 <span class=
"nx">makeSnafucated
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2229 <span class=
"p">});
</span>
2231 <span class=
"c1">// --- NEW API ---
</span>
2233 <span class=
"c1">// App/Foo.js
</span>
2234 <span class=
"nx">define
</span><span class=
"p">([],
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2235 <span class=
"s2">"use strict
"</span><span class=
"p">;
</span>
2237 <span class=
"kd">function
</span> <span class=
"nx">Foo
</span><span class=
"p">()
</span> <span class=
"p">{};
</span>
2238 <span class=
"nx">Foo
</span><span class=
"p">.
</span><span class=
"nx">prototype
</span> <span class=
"o">=
</span> <span class=
"p">{
</span>
2239 <span class=
"nx">bar
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2240 <span class=
"p">};
</span>
2242 <span class=
"k">return
</span> <span class=
"nx">Foo
</span><span class=
"p">;
</span>
2243 <span class=
"p">});
</span>
2245 <span class=
"c1">// App/Baz.js
</span>
2246 <span class=
"nx">define
</span><span class=
"p">([
</span><span class=
"s2">"Core
"</span><span class=
"p">,
</span> <span class=
"s2">"./Foo
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Core
</span><span class=
"p">,
</span> <span class=
"nx">Foo
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2247 <span class=
"s2">"use strict
"</span><span class=
"p">;
</span>
2249 <span class=
"kd">function
</span> <span class=
"nx">Baz
</span><span class=
"p">()
</span> <span class=
"p">{};
</span>
2250 <span class=
"nx">Core
</span><span class=
"p">.
</span><span class=
"nx">inherit
</span><span class=
"p">(
</span><span class=
"nx">Baz
</span><span class=
"p">,
</span> <span class=
"nx">Foo
</span><span class=
"p">,
</span> <span class=
"p">{
</span>
2251 <span class=
"nx">makeSnafucated
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2252 <span class=
"p">});
</span>
2254 <span class=
"k">return
</span> <span class=
"nx">Baz
</span><span class=
"p">;
</span>
2255 <span class=
"p">});
</span>
2257 <h3 id=
"isplainobjectobject-object-boolean"><code>isPlainObject(object: Object): boolean
</code><a class=
"headerlink" href=
"#isplainobjectobject-object-boolean" title=
"Permanent link">#
</a></h3>
2258 <p>Verifies if an object is a plain JavaScript object and not an object instance.
</p>
2259 <div class=
"highlight"><pre><span></span><code><span class=
"nx">require
</span><span class=
"p">([
</span><span class=
"s2">"Core
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Core
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2260 <span class=
"kd">function
</span> <span class=
"nx">Foo
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2261 <span class=
"nx">Foo
</span><span class=
"p">.
</span><span class=
"nx">prototype
</span> <span class=
"o">=
</span> <span class=
"p">{
</span>
2262 <span class=
"nx">hello
</span><span class=
"o">:
</span> <span class=
"s2">"world
"</span><span class=
"p">;
</span>
2263 <span class=
"p">};
</span>
2265 <span class=
"kd">var
</span> <span class=
"nx">obj1
</span> <span class=
"o">=
</span> <span class=
"p">{
</span> <span class=
"nx">hello
</span><span class=
"o">:
</span> <span class=
"s2">"world
"</span> <span class=
"p">};
</span>
2266 <span class=
"kd">var
</span> <span class=
"nx">obj2
</span> <span class=
"o">=
</span> <span class=
"k">new
</span> <span class=
"nx">Foo
</span><span class=
"p">();
</span>
2268 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span><span class=
"p">(
</span><span class=
"nx">Core
</span><span class=
"p">.
</span><span class=
"nx">isPlainObject
</span><span class=
"p">(
</span><span class=
"nx">obj1
</span><span class=
"p">));
</span> <span class=
"c1">// output: true
</span>
2269 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span><span class=
"p">(
</span><span class=
"nx">obj1
</span><span class=
"p">.
</span><span class=
"nx">hello
</span> <span class=
"o">===
</span> <span class=
"nx">obj2
</span><span class=
"p">.
</span><span class=
"nx">hello
</span><span class=
"p">);
</span> <span class=
"c1">// output: true
</span>
2270 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span><span class=
"p">(
</span><span class=
"nx">Core
</span><span class=
"p">.
</span><span class=
"nx">isPlainObject
</span><span class=
"p">(
</span><span class=
"nx">obj2
</span><span class=
"p">));
</span> <span class=
"c1">// output: false
</span>
2271 <span class=
"p">});
</span>
2273 <h3 id=
"triggereventelement-element-eventname-string"><code>triggerEvent(element: Element, eventName: string)
</code><a class=
"headerlink" href=
"#triggereventelement-element-eventname-string" title=
"Permanent link">#
</a></h3>
2274 <p>Creates and dispatches a synthetic JavaScript event on an element.
</p>
2275 <div class=
"highlight"><pre><span></span><code><span class=
"nx">require
</span><span class=
"p">([
</span><span class=
"s2">"Core
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Core
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2276 <span class=
"kd">var
</span> <span class=
"nx">element
</span> <span class=
"o">=
</span> <span class=
"nx">elBySel
</span><span class=
"p">(
</span><span class=
"s2">".some-element
"</span><span class=
"p">);
</span>
2277 <span class=
"nx">Core
</span><span class=
"p">.
</span><span class=
"nx">triggerEvent
</span><span class=
"p">(
</span><span class=
"nx">element
</span><span class=
"p">,
</span> <span class=
"s2">"click
"</span><span class=
"p">);
</span>
2278 <span class=
"p">});
</span>
2280 <h2 id=
"language"><code>Language
</code><a class=
"headerlink" href=
"#language" title=
"Permanent link">#
</a></h2>
2281 <h3 id=
"addkey-string-value-string"><code>add(key: string, value: string)
</code><a class=
"headerlink" href=
"#addkey-string-value-string" title=
"Permanent link">#
</a></h3>
2282 <p>Registers a new phrase.
</p>
2283 <div class=
"highlight"><pre><span></span><code><span class=
"p"><</span><span class=
"nt">script
</span> <span class=
"na">data-relocate
</span><span class=
"o">=
</span><span class=
"s">"true
"</span><span class=
"p">></span>
2284 <span class=
"nx">require
</span><span class=
"p">([
</span><span class=
"s2">"Language
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Language
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2285 <span class=
"nx">Language
</span><span class=
"p">.
</span><span class=
"nx">add
</span><span class=
"p">(
</span><span class=
"s1">'app.foo.bar
'</span><span class=
"p">,
</span> <span class=
"s1">'{jslang}app.foo.bar{/jslang}
'</span><span class=
"p">);
</span>
2286 <span class=
"p">});
</span>
2287 <span class=
"p"></
</span><span class=
"nt">script
</span><span class=
"p">></span>
2289 <h3 id=
"addobjectobject-object"><code>addObject(object: Object)
</code><a class=
"headerlink" href=
"#addobjectobject-object" title=
"Permanent link">#
</a></h3>
2290 <p>Registers a list of phrases using a plain object.
</p>
2291 <div class=
"highlight"><pre><span></span><code><span class=
"p"><</span><span class=
"nt">script
</span> <span class=
"na">data-relocate
</span><span class=
"o">=
</span><span class=
"s">"true
"</span><span class=
"p">></span>
2292 <span class=
"nx">require
</span><span class=
"p">([
</span><span class=
"s2">"Language
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Language
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2293 <span class=
"nx">Language
</span><span class=
"p">.
</span><span class=
"nx">addObject
</span><span class=
"p">({
</span>
2294 <span class=
"s1">'app.foo.bar
'</span><span class=
"o">:
</span> <span class=
"s1">'{jslang}app.foo.bar{/jslang}
'</span>
2295 <span class=
"p">});
</span>
2296 <span class=
"p">});
</span>
2297 <span class=
"p"></
</span><span class=
"nt">script
</span><span class=
"p">></span>
2299 <h3 id=
"getkey-string-parameters-object-string"><code>get(key: string, parameters?: Object): string
</code><a class=
"headerlink" href=
"#getkey-string-parameters-object-string" title=
"Permanent link">#
</a></h3>
2300 <p>Retrieves a phrase by its key, optionally supporting basic template scripting
2301 with dynamic variables passed using the
<code>parameters
</code> object.
</p>
2302 <div class=
"highlight"><pre><span></span><code><span class=
"nx">require
</span><span class=
"p">([
</span><span class=
"s2">"Language
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Language
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2303 <span class=
"kd">var
</span> <span class=
"nx">title
</span> <span class=
"o">=
</span> <span class=
"nx">Language
</span><span class=
"p">.
</span><span class=
"nx">get
</span><span class=
"p">(
</span><span class=
"s2">"app.foo.title
"</span><span class=
"p">);
</span>
2304 <span class=
"kd">var
</span> <span class=
"nx">content
</span> <span class=
"o">=
</span> <span class=
"nx">Language
</span><span class=
"p">.
</span><span class=
"nx">get
</span><span class=
"p">(
</span><span class=
"s2">"app.foo.content
"</span><span class=
"p">,
</span> <span class=
"p">{
</span>
2305 <span class=
"nx">some
</span><span class=
"o">:
</span> <span class=
"s2">"value
"</span>
2306 <span class=
"p">});
</span>
2307 <span class=
"p">});
</span>
2309 <h2 id=
"stringutil"><code>StringUtil
</code><a class=
"headerlink" href=
"#stringutil" title=
"Permanent link">#
</a></h2>
2310 <h3 id=
"escapehtmlstr-string-string"><code>escapeHTML(str: string): string
</code><a class=
"headerlink" href=
"#escapehtmlstr-string-string" title=
"Permanent link">#
</a></h3>
2311 <p>Escapes special HTML characters by converting them into an HTML entity.
</p>
2316 <th>Replacement
</th>
2321 <td><code>&</code></td>
2322 <td><code>&amp;
</code></td>
2325 <td><code>"</code></td>
2326 <td><code>&quot;</code></td>
2329 <td><code><</code></td>
2330 <td><code>&lt;</code></td>
2333 <td><code>></code></td>
2334 <td><code>&gt;</code></td>
2338 <h3 id="escaperegexpstr-string-string
"><code>escapeRegExp(str: string): string</code><a class="headerlink
" href="#escaperegexpstr-string-string
" title="Permanent link
">#</a></h3>
2339 <p>Escapes a list of characters that have a special meaning in regular expressions
2340 and could alter the behavior when embedded into regular expressions.</p>
2341 <h3 id="lcfirststr-string-string
"><code>lcfirst(str: string): string</code><a class="headerlink
" href="#lcfirststr-string-string
" title="Permanent link
">#</a></h3>
2342 <p>Makes a string's first character lowercase.</p>
2343 <h3 id="ucfirststr-string-string
"><code>ucfirst(str: string): string</code><a class="headerlink
" href="#ucfirststr-string-string
" title="Permanent link
">#</a></h3>
2344 <p>Makes a string's first character uppercase.</p>
2345 <h3 id="unescapehtmlstr-string-string
"><code>unescapeHTML(str: string): string</code><a class="headerlink
" href="#unescapehtmlstr-string-string
" title="Permanent link
">#</a></h3>
2346 <p>Converts some HTML entities into their original character. This is the reverse
2347 function of <code>escapeHTML()</code>.</p>
2353 <div class="md-source-date
">
2356 Last update: 2021-01-08
2375 <footer class="md-footer
">
2377 <nav class="md-footer__inner md-grid
" aria-label="Footer
">
2379 <a href="../new-api_data-structures/
" class="md-footer__link md-footer__link--prev
" rel="prev
">
2380 <div class="md-footer__button md-icon
">
2381 <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>
2383 <div class="md-footer__title
">
2384 <div class="md-ellipsis
">
2385 <span class="md-footer__direction
">
2394 <a href="../new-api_dom/
" class="md-footer__link md-footer__link--next
" rel="next
">
2395 <div class="md-footer__title
">
2396 <div class="md-ellipsis
">
2397 <span class="md-footer__direction
">
2403 <div class="md-footer__button md-icon
">
2404 <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>
2410 <div class="md-footer-meta md-typeset
">
2411 <div class="md-footer-meta__inner md-grid
">
2412 <div class="md-footer-copyright
">
2414 <div class="md-footer-copyright__highlight
">
2415 Copyright © 2020 WoltLab GmbH
2419 <a href="https://squidfunk.github.io/mkdocs-material/
" target="_blank
" rel="noopener
">
2424 <div class="md-footer-copyright
">
2425 <a href="https://www.woltlab.com/legal-notice/
">Legal Notice</a>
2426 <a href="https://www.woltlab.com/privacy-policy/
">Privacy Policy</a>
2433 <div class="md-dialog
" data-md-component="dialog
">
2434 <div class="md-dialog__inner md-typeset
"></div>
2436 <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>
2439 <script src="../../assets/javascripts/bundle.d892486b.min.js
"></script>