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>coreObject - 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-object-package-installation-plugin" 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">
610 <li class=
"md-nav__item md-nav__item--nested">
613 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
615 <label class=
"md-nav__link" for=
"__nav_4">
617 <span class=
"md-nav__icon md-icon"></span>
619 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
620 <label class=
"md-nav__title" for=
"__nav_4">
621 <span class=
"md-nav__icon md-icon"></span>
624 <ul class=
"md-nav__list" data-md-scrollfix
>
630 <li class=
"md-nav__item">
631 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
643 <li class=
"md-nav__item md-nav__item--nested">
646 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
648 <label class=
"md-nav__link" for=
"__nav_4_2">
650 <span class=
"md-nav__icon md-icon"></span>
652 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
653 <label class=
"md-nav__title" for=
"__nav_4_2">
654 <span class=
"md-nav__icon md-icon"></span>
657 <ul class=
"md-nav__list" data-md-scrollfix
>
663 <li class=
"md-nav__item">
664 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
675 <li class=
"md-nav__item">
676 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
687 <li class=
"md-nav__item">
688 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
699 <li class=
"md-nav__item">
700 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
711 <li class=
"md-nav__item">
712 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
723 <li class=
"md-nav__item">
724 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
735 <li class=
"md-nav__item">
736 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
747 <li class=
"md-nav__item">
748 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
749 Browser and Screen Sizes
759 <li class=
"md-nav__item">
760 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
777 <li class=
"md-nav__item">
778 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
789 <li class=
"md-nav__item">
790 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
801 <li class=
"md-nav__item">
802 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
825 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
828 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
830 <label class=
"md-nav__link" for=
"__nav_5">
832 <span class=
"md-nav__icon md-icon"></span>
834 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
835 <label class=
"md-nav__title" for=
"__nav_5">
836 <span class=
"md-nav__icon md-icon"></span>
839 <ul class=
"md-nav__list" data-md-scrollfix
>
845 <li class=
"md-nav__item">
846 <a href=
"../../package-xml/" class=
"md-nav__link">
860 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
863 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
865 <label class=
"md-nav__link" for=
"__nav_5_2">
867 <span class=
"md-nav__icon md-icon"></span>
869 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
870 <label class=
"md-nav__title" for=
"__nav_5_2">
871 <span class=
"md-nav__icon md-icon"></span>
874 <ul class=
"md-nav__list" data-md-scrollfix
>
880 <li class=
"md-nav__item">
881 <a href=
"../" class=
"md-nav__link">
892 <li class=
"md-nav__item">
893 <a href=
"../acl-option/" class=
"md-nav__link">
904 <li class=
"md-nav__item">
905 <a href=
"../acp-menu/" class=
"md-nav__link">
916 <li class=
"md-nav__item">
917 <a href=
"../acp-search-provider/" class=
"md-nav__link">
928 <li class=
"md-nav__item">
929 <a href=
"../acp-template/" class=
"md-nav__link">
940 <li class=
"md-nav__item">
941 <a href=
"../bbcode/" class=
"md-nav__link">
952 <li class=
"md-nav__item">
953 <a href=
"../box/" class=
"md-nav__link">
964 <li class=
"md-nav__item">
965 <a href=
"../clipboard-action/" class=
"md-nav__link">
978 <li class=
"md-nav__item md-nav__item--active">
980 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
985 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
987 <span class=
"md-nav__icon md-icon"></span>
990 <a href=
"./" class=
"md-nav__link md-nav__link--active">
995 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1001 <label class=
"md-nav__title" for=
"__toc">
1002 <span class=
"md-nav__icon md-icon"></span>
1005 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1007 <li class=
"md-nav__item">
1008 <a href=
"#components" class=
"md-nav__link">
1012 <nav class=
"md-nav" aria-label=
"Components">
1013 <ul class=
"md-nav__list">
1015 <li class=
"md-nav__item">
1016 <a href=
"#objectname" class=
"md-nav__link">
1027 <li class=
"md-nav__item">
1028 <a href=
"#example" class=
"md-nav__link">
1046 <li class=
"md-nav__item">
1047 <a href=
"../cronjob/" class=
"md-nav__link">
1058 <li class=
"md-nav__item">
1059 <a href=
"../event-listener/" class=
"md-nav__link">
1070 <li class=
"md-nav__item">
1071 <a href=
"../file/" class=
"md-nav__link">
1082 <li class=
"md-nav__item">
1083 <a href=
"../language/" class=
"md-nav__link">
1094 <li class=
"md-nav__item">
1095 <a href=
"../media-provider/" class=
"md-nav__link">
1106 <li class=
"md-nav__item">
1107 <a href=
"../menu/" class=
"md-nav__link">
1118 <li class=
"md-nav__item">
1119 <a href=
"../menu-item/" class=
"md-nav__link">
1130 <li class=
"md-nav__item">
1131 <a href=
"../object-type/" class=
"md-nav__link">
1142 <li class=
"md-nav__item">
1143 <a href=
"../object-type-definition/" class=
"md-nav__link">
1144 objectTypeDefinition
1154 <li class=
"md-nav__item">
1155 <a href=
"../option/" class=
"md-nav__link">
1166 <li class=
"md-nav__item">
1167 <a href=
"../page/" class=
"md-nav__link">
1178 <li class=
"md-nav__item">
1179 <a href=
"../pip/" class=
"md-nav__link">
1190 <li class=
"md-nav__item">
1191 <a href=
"../script/" class=
"md-nav__link">
1202 <li class=
"md-nav__item">
1203 <a href=
"../smiley/" class=
"md-nav__link">
1214 <li class=
"md-nav__item">
1215 <a href=
"../sql/" class=
"md-nav__link">
1226 <li class=
"md-nav__item">
1227 <a href=
"../style/" class=
"md-nav__link">
1238 <li class=
"md-nav__item">
1239 <a href=
"../template/" class=
"md-nav__link">
1250 <li class=
"md-nav__item">
1251 <a href=
"../template-listener/" class=
"md-nav__link">
1262 <li class=
"md-nav__item">
1263 <a href=
"../user-group-option/" class=
"md-nav__link">
1274 <li class=
"md-nav__item">
1275 <a href=
"../user-menu/" class=
"md-nav__link">
1286 <li class=
"md-nav__item">
1287 <a href=
"../user-notification-event/" class=
"md-nav__link">
1288 userNotificationEvent
1298 <li class=
"md-nav__item">
1299 <a href=
"../user-option/" class=
"md-nav__link">
1310 <li class=
"md-nav__item">
1311 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1328 <li class=
"md-nav__item">
1329 <a href=
"../../database-php-api/" class=
"md-nav__link">
1350 <li class=
"md-nav__item md-nav__item--nested">
1353 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1355 <label class=
"md-nav__link" for=
"__nav_6">
1357 <span class=
"md-nav__icon md-icon"></span>
1359 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1360 <label class=
"md-nav__title" for=
"__nav_6">
1361 <span class=
"md-nav__icon md-icon"></span>
1364 <ul class=
"md-nav__list" data-md-scrollfix
>
1371 <li class=
"md-nav__item md-nav__item--nested">
1374 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1376 <label class=
"md-nav__link" for=
"__nav_6_1">
1377 Migrating from WSC
5.3
1378 <span class=
"md-nav__icon md-icon"></span>
1380 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1381 <label class=
"md-nav__title" for=
"__nav_6_1">
1382 <span class=
"md-nav__icon md-icon"></span>
1383 Migrating from WSC
5.3
1385 <ul class=
"md-nav__list" data-md-scrollfix
>
1391 <li class=
"md-nav__item">
1392 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1403 <li class=
"md-nav__item">
1404 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1405 Session Handling and Authentication
1415 <li class=
"md-nav__item">
1416 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1427 <li class=
"md-nav__item">
1428 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1439 <li class=
"md-nav__item">
1440 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1441 Third Party Libraries
1458 <li class=
"md-nav__item md-nav__item--nested">
1461 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1463 <label class=
"md-nav__link" for=
"__nav_6_2">
1464 Migrating from WSC
5.2
1465 <span class=
"md-nav__icon md-icon"></span>
1467 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1468 <label class=
"md-nav__title" for=
"__nav_6_2">
1469 <span class=
"md-nav__icon md-icon"></span>
1470 Migrating from WSC
5.2
1472 <ul class=
"md-nav__list" data-md-scrollfix
>
1478 <li class=
"md-nav__item">
1479 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1490 <li class=
"md-nav__item">
1491 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1492 Templates and Languages
1502 <li class=
"md-nav__item">
1503 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1504 Third Party Libraries
1521 <li class=
"md-nav__item md-nav__item--nested">
1524 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1526 <label class=
"md-nav__link" for=
"__nav_6_3">
1527 Migrating from WSC
3.1
1528 <span class=
"md-nav__icon md-icon"></span>
1530 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1531 <label class=
"md-nav__title" for=
"__nav_6_3">
1532 <span class=
"md-nav__icon md-icon"></span>
1533 Migrating from WSC
3.1
1535 <ul class=
"md-nav__list" data-md-scrollfix
>
1541 <li class=
"md-nav__item">
1542 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1560 <li class=
"md-nav__item md-nav__item--nested">
1563 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1565 <label class=
"md-nav__link" for=
"__nav_6_4">
1566 Migrating from WSC
3.0
1567 <span class=
"md-nav__icon md-icon"></span>
1569 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1570 <label class=
"md-nav__title" for=
"__nav_6_4">
1571 <span class=
"md-nav__icon md-icon"></span>
1572 Migrating from WSC
3.0
1574 <ul class=
"md-nav__list" data-md-scrollfix
>
1580 <li class=
"md-nav__item">
1581 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1592 <li class=
"md-nav__item">
1593 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1604 <li class=
"md-nav__item">
1605 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1616 <li class=
"md-nav__item">
1617 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1628 <li class=
"md-nav__item">
1629 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1647 <li class=
"md-nav__item md-nav__item--nested">
1650 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1652 <label class=
"md-nav__link" for=
"__nav_6_5">
1653 Migrating from WCF
2.1
1654 <span class=
"md-nav__icon md-icon"></span>
1656 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1657 <label class=
"md-nav__title" for=
"__nav_6_5">
1658 <span class=
"md-nav__icon md-icon"></span>
1659 Migrating from WCF
2.1
1661 <ul class=
"md-nav__list" data-md-scrollfix
>
1667 <li class=
"md-nav__item">
1668 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1679 <li class=
"md-nav__item">
1680 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1691 <li class=
"md-nav__item">
1692 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1703 <li class=
"md-nav__item">
1704 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1731 <li class=
"md-nav__item md-nav__item--nested">
1734 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1736 <label class=
"md-nav__link" for=
"__nav_7">
1738 <span class=
"md-nav__icon md-icon"></span>
1740 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1741 <label class=
"md-nav__title" for=
"__nav_7">
1742 <span class=
"md-nav__icon md-icon"></span>
1745 <ul class=
"md-nav__list" data-md-scrollfix
>
1752 <li class=
"md-nav__item md-nav__item--nested">
1755 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1757 <label class=
"md-nav__link" for=
"__nav_7_1">
1759 <span class=
"md-nav__icon md-icon"></span>
1761 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1762 <label class=
"md-nav__title" for=
"__nav_7_1">
1763 <span class=
"md-nav__icon md-icon"></span>
1766 <ul class=
"md-nav__list" data-md-scrollfix
>
1772 <li class=
"md-nav__item">
1773 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1784 <li class=
"md-nav__item">
1785 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1796 <li class=
"md-nav__item">
1797 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1808 <li class=
"md-nav__item">
1809 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1836 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1837 <div class=
"md-sidebar__scrollwrap">
1838 <div class=
"md-sidebar__inner">
1840 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1846 <label class=
"md-nav__title" for=
"__toc">
1847 <span class=
"md-nav__icon md-icon"></span>
1850 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1852 <li class=
"md-nav__item">
1853 <a href=
"#components" class=
"md-nav__link">
1857 <nav class=
"md-nav" aria-label=
"Components">
1858 <ul class=
"md-nav__list">
1860 <li class=
"md-nav__item">
1861 <a href=
"#objectname" class=
"md-nav__link">
1872 <li class=
"md-nav__item">
1873 <a href=
"#example" class=
"md-nav__link">
1887 <div class=
"md-content" data-md-component=
"content">
1888 <article class=
"md-content__inner md-typeset">
1891 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/core-object.md" title=
"Edit this page" class=
"md-content__button md-icon">
1892 <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>
1896 <h1 id=
"core-object-package-installation-plugin">Core Object Package Installation Plugin
<a class=
"headerlink" href=
"#core-object-package-installation-plugin" title=
"Permanent link">#
</a></h1>
1897 <p>Registers
<code>wcf\system\SingletonFactory
</code> objects to be accessible in templates.
</p>
1898 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
1899 <p>Each item is described as a
<code><coreobject
></code> element with the mandatory element
<code>objectname
</code>.
</p>
1900 <h3 id=
"objectname"><code><objectname
></code><a class=
"headerlink" href=
"#objectname" title=
"Permanent link">#
</a></h3>
1901 <p>The fully qualified class name of the class.
</p>
1902 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
1903 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
1904 <span class=
"nt"><data
</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/
2019/coreObject.xsd
"</span><span class=
"nt">></span>
1905 <span class=
"nt"><import
></span>
1906 <span class=
"nt"><coreobject
></span>
1907 <span class=
"nt"><objectname
></span>wcf\system\example\ExampleHandler
<span class=
"nt"></objectname
></span>
1908 <span class=
"nt"></coreobject
></span>
1909 <span class=
"nt"></import
></span>
1910 <span class=
"nt"></data
></span>
1912 <p>This object can be accessed in templates via
<code>$__wcf-
>getExampleHandler()
</code> (in general: the method name begins with
<code>get
</code> and ends with the unqualified class name).
</p>
1918 <div class=
"md-source-date">
1921 Last update:
2021-
01-
08
1940 <footer class=
"md-footer">
1942 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
1944 <a href=
"../clipboard-action/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
1945 <div class=
"md-footer__button md-icon">
1946 <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>
1948 <div class=
"md-footer__title">
1949 <div class=
"md-ellipsis">
1950 <span class=
"md-footer__direction">
1959 <a href=
"../cronjob/" class=
"md-footer__link md-footer__link--next" rel=
"next">
1960 <div class=
"md-footer__title">
1961 <div class=
"md-ellipsis">
1962 <span class=
"md-footer__direction">
1968 <div class=
"md-footer__button md-icon">
1969 <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>
1975 <div class=
"md-footer-meta md-typeset">
1976 <div class=
"md-footer-meta__inner md-grid">
1977 <div class=
"md-footer-copyright">
1979 <div class=
"md-footer-copyright__highlight">
1980 Copyright ©
2020 WoltLab GmbH
1984 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
1989 <div class=
"md-footer-copyright">
1990 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
1991 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
1998 <div class=
"md-dialog" data-md-component=
"dialog">
1999 <div class=
"md-dialog__inner md-typeset"></div>
2001 <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>
2004 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>