3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
11 <link rel=
"canonical" href=
"https://docs.woltlab.com/6.0/package/pip/object-type-definition/">
14 <link rel=
"prev" href=
"../object-type/">
17 <link rel=
"next" href=
"../option/">
19 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
20 <meta name=
"generator" content=
"mkdocs-1.5.1, mkdocs-material-9.1.21">
24 <title>objectTypeDefinition - WoltLab Suite Documentation
</title>
28 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.eebd395e.min.css">
31 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ecc896b0.min.css">
41 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
43 <script>__md_scope=new URL(
"../../..",location),__md_hash=e=
>[...e].reduce((e,_)=
>(e<
<5)-e+_.charCodeAt(
0),
0),__md_get=(e,_=localStorage,t=__md_scope)=
>JSON.parse(_.getItem(t.pathname+
"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=
>{try{t.setItem(a.pathname+
"."+e,JSON.stringify(_))}catch(e){}}
</script>
58 <body dir=
"ltr" data-md-color-scheme=
"default" data-md-color-primary=
"teal" data-md-color-accent=
"indigo">
62 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
63 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
64 <label class=
"md-overlay" for=
"__drawer"></label>
65 <div data-md-component=
"skip">
68 <a href=
"#object-type-definition-package-installation-plugin" class=
"md-skip">
73 <div data-md-component=
"announce">
75 <aside class=
"md-banner">
76 <div class=
"md-banner__inner md-grid md-typeset">
79 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
87 <div data-md-color-scheme=
"default" data-md-component=
"outdated" hidden
>
96 <header class=
"md-header md-header--shadow" data-md-component=
"header">
97 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
98 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
100 <img src=
"../../../assets/logo.png" alt=
"logo">
103 <label class=
"md-header__button md-icon" for=
"__drawer">
104 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
106 <div class=
"md-header__title" data-md-component=
"header-title">
107 <div class=
"md-header__ellipsis">
108 <div class=
"md-header__topic">
109 <span class=
"md-ellipsis">
110 WoltLab Suite Documentation
113 <div class=
"md-header__topic" data-md-component=
"header-topic">
114 <span class=
"md-ellipsis">
127 <label class=
"md-header__button md-icon" for=
"__search">
128 <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>
130 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
131 <label class=
"md-search__overlay" for=
"__search"></label>
132 <div class=
"md-search__inner" role=
"search">
133 <form class=
"md-search__form" name=
"search">
134 <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" required
>
135 <label class=
"md-search__icon md-icon" for=
"__search">
136 <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>
137 <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>
139 <nav class=
"md-search__options" aria-label=
"Search">
141 <button type=
"reset" class=
"md-search__icon md-icon" title=
"Clear" aria-label=
"Clear" tabindex=
"-1">
142 <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>
147 <div class=
"md-search__output">
148 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
149 <div class=
"md-search-result" data-md-component=
"search-result">
150 <div class=
"md-search-result__meta">
153 <ol class=
"md-search-result__list" role=
"presentation"></ol>
161 <div class=
"md-header__source">
162 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
163 <div class=
"md-source__icon md-icon">
165 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
167 <div class=
"md-source__repository">
177 <div class=
"md-container" data-md-component=
"container">
184 <main class=
"md-main" data-md-component=
"main">
185 <div class=
"md-main__inner md-grid">
189 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
190 <div class=
"md-sidebar__scrollwrap">
191 <div class=
"md-sidebar__inner">
195 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
196 <label class=
"md-nav__title" for=
"__drawer">
197 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
199 <img src=
"../../../assets/logo.png" alt=
"logo">
202 WoltLab Suite Documentation
205 <div class=
"md-nav__source">
206 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
207 <div class=
"md-source__icon md-icon">
209 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
211 <div class=
"md-source__repository">
217 <ul class=
"md-nav__list" data-md-scrollfix
>
226 <li class=
"md-nav__item">
227 <a href=
"../../../getting-started/" class=
"md-nav__link">
242 <li class=
"md-nav__item md-nav__item--nested">
247 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2" >
251 <label class=
"md-nav__link" for=
"__nav_2" id=
"__nav_2_label" tabindex=
"0">
253 <span class=
"md-nav__icon md-icon"></span>
256 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_2_label" aria-expanded=
"false">
257 <label class=
"md-nav__title" for=
"__nav_2">
258 <span class=
"md-nav__icon md-icon"></span>
261 <ul class=
"md-nav__list" data-md-scrollfix
>
268 <li class=
"md-nav__item">
269 <a href=
"../../../php/pages/" class=
"md-nav__link">
282 <li class=
"md-nav__item">
283 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
296 <li class=
"md-nav__item">
297 <a href=
"../../../php/database-access/" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
325 <li class=
"md-nav__item md-nav__item--nested">
330 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5" >
334 <label class=
"md-nav__link" for=
"__nav_2_5" id=
"__nav_2_5_label" tabindex=
"0">
336 <span class=
"md-nav__icon md-icon"></span>
339 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_2_5_label" aria-expanded=
"false">
340 <label class=
"md-nav__title" for=
"__nav_2_5">
341 <span class=
"md-nav__icon md-icon"></span>
344 <ul class=
"md-nav__list" data-md-scrollfix
>
352 <li class=
"md-nav__item md-nav__item--nested">
357 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5_1" >
361 <label class=
"md-nav__link" for=
"__nav_2_5_1" id=
"__nav_2_5_1_label" tabindex=
"0">
363 <span class=
"md-nav__icon md-icon"></span>
366 <nav class=
"md-nav" data-md-level=
"3" aria-labelledby=
"__nav_2_5_1_label" aria-expanded=
"false">
367 <label class=
"md-nav__title" for=
"__nav_2_5_1">
368 <span class=
"md-nav__icon md-icon"></span>
371 <ul class=
"md-nav__list" data-md-scrollfix
>
378 <li class=
"md-nav__item">
379 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
392 <li class=
"md-nav__item">
393 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
406 <li class=
"md-nav__item">
407 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
427 <li class=
"md-nav__item">
428 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
455 <li class=
"md-nav__item">
456 <a href=
"../../../php/api/events/" class=
"md-nav__link">
470 <li class=
"md-nav__item md-nav__item--nested">
475 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_2_5_5" >
479 <label class=
"md-nav__link" for=
"__nav_2_5_5" id=
"__nav_2_5_5_label" tabindex=
"0">
481 <span class=
"md-nav__icon md-icon"></span>
484 <nav class=
"md-nav" data-md-level=
"3" aria-labelledby=
"__nav_2_5_5_label" aria-expanded=
"false">
485 <label class=
"md-nav__title" for=
"__nav_2_5_5">
486 <span class=
"md-nav__icon md-icon"></span>
489 <ul class=
"md-nav__list" data-md-scrollfix
>
496 <li class=
"md-nav__item">
497 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
510 <li class=
"md-nav__item">
511 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
524 <li class=
"md-nav__item">
525 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
538 <li class=
"md-nav__item">
539 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
552 <li class=
"md-nav__item">
553 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
575 Package Installation Plugins
587 <li class=
"md-nav__item">
588 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
601 <li class=
"md-nav__item">
602 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
615 <li class=
"md-nav__item">
616 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
636 <li class=
"md-nav__item">
637 <a href=
"../../../php/code-style/" class=
"md-nav__link">
650 <li class=
"md-nav__item">
651 <a href=
"../../../php/apps/" class=
"md-nav__link">
664 <li class=
"md-nav__item">
665 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
687 <li class=
"md-nav__item md-nav__item--nested">
692 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_3" >
696 <label class=
"md-nav__link" for=
"__nav_3" id=
"__nav_3_label" tabindex=
"0">
697 Languages, Templates & CSS
698 <span class=
"md-nav__icon md-icon"></span>
701 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_3_label" aria-expanded=
"false">
702 <label class=
"md-nav__title" for=
"__nav_3">
703 <span class=
"md-nav__icon md-icon"></span>
704 Languages, Templates & CSS
706 <ul class=
"md-nav__list" data-md-scrollfix
>
713 <li class=
"md-nav__item">
714 <a href=
"../../../view/languages/" class=
"md-nav__link">
727 <li class=
"md-nav__item">
728 <a href=
"../../../view/templates/" class=
"md-nav__link">
741 <li class=
"md-nav__item">
742 <a href=
"../../../view/template-modifiers/" class=
"md-nav__link">
755 <li class=
"md-nav__item">
756 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
769 <li class=
"md-nav__item">
770 <a href=
"../../../view/css/" class=
"md-nav__link">
792 <li class=
"md-nav__item md-nav__item--nested">
797 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4" >
801 <label class=
"md-nav__link" for=
"__nav_4" id=
"__nav_4_label" tabindex=
"0">
802 TypeScript and JavaScript API
803 <span class=
"md-nav__icon md-icon"></span>
806 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_4_label" aria-expanded=
"false">
807 <label class=
"md-nav__title" for=
"__nav_4">
808 <span class=
"md-nav__icon md-icon"></span>
809 TypeScript and JavaScript API
811 <ul class=
"md-nav__list" data-md-scrollfix
>
818 <li class=
"md-nav__item">
819 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
832 <li class=
"md-nav__item">
833 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
847 <li class=
"md-nav__item md-nav__item--nested">
852 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4_3" >
856 <label class=
"md-nav__link" for=
"__nav_4_3" id=
"__nav_4_3_label" tabindex=
"0">
858 <span class=
"md-nav__icon md-icon"></span>
861 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_4_3_label" aria-expanded=
"false">
862 <label class=
"md-nav__title" for=
"__nav_4_3">
863 <span class=
"md-nav__icon md-icon"></span>
866 <ul class=
"md-nav__list" data-md-scrollfix
>
873 <li class=
"md-nav__item">
874 <a href=
"../../../javascript/components_ckeditor5/" class=
"md-nav__link">
887 <li class=
"md-nav__item">
888 <a href=
"../../../javascript/components_confirmation/" class=
"md-nav__link">
901 <li class=
"md-nav__item">
902 <a href=
"../../../javascript/components_dialog/" class=
"md-nav__link">
915 <li class=
"md-nav__item">
916 <a href=
"../../../javascript/components_google_maps/" class=
"md-nav__link">
929 <li class=
"md-nav__item">
930 <a href=
"../../../javascript/components_pagination/" class=
"md-nav__link">
951 <li class=
"md-nav__item md-nav__item--nested">
956 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4_4" >
960 <label class=
"md-nav__link" for=
"__nav_4_4" id=
"__nav_4_4_label" tabindex=
"0">
962 <span class=
"md-nav__icon md-icon"></span>
965 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_4_4_label" aria-expanded=
"false">
966 <label class=
"md-nav__title" for=
"__nav_4_4">
967 <span class=
"md-nav__icon md-icon"></span>
970 <ul class=
"md-nav__list" data-md-scrollfix
>
977 <li class=
"md-nav__item">
978 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
991 <li class=
"md-nav__item">
992 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
1005 <li class=
"md-nav__item">
1006 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
1019 <li class=
"md-nav__item">
1020 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
1033 <li class=
"md-nav__item">
1034 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
1047 <li class=
"md-nav__item">
1048 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
1061 <li class=
"md-nav__item">
1062 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
1063 Browser and Screen Sizes
1075 <li class=
"md-nav__item">
1076 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
1096 <li class=
"md-nav__item">
1097 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
1110 <li class=
"md-nav__item">
1111 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
1135 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1140 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5" checked
>
1144 <label class=
"md-nav__link" for=
"__nav_5" id=
"__nav_5_label" tabindex=
"0">
1146 <span class=
"md-nav__icon md-icon"></span>
1149 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_5_label" aria-expanded=
"true">
1150 <label class=
"md-nav__title" for=
"__nav_5">
1151 <span class=
"md-nav__icon md-icon"></span>
1154 <ul class=
"md-nav__list" data-md-scrollfix
>
1161 <li class=
"md-nav__item">
1162 <a href=
"../../package-xml/" class=
"md-nav__link">
1178 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1183 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5_2" checked
>
1187 <label class=
"md-nav__link" for=
"__nav_5_2" id=
"__nav_5_2_label" tabindex=
"0">
1189 <span class=
"md-nav__icon md-icon"></span>
1192 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_5_2_label" aria-expanded=
"true">
1193 <label class=
"md-nav__title" for=
"__nav_5_2">
1194 <span class=
"md-nav__icon md-icon"></span>
1197 <ul class=
"md-nav__list" data-md-scrollfix
>
1204 <li class=
"md-nav__item">
1205 <a href=
"../" class=
"md-nav__link">
1218 <li class=
"md-nav__item">
1219 <a href=
"../acl-option/" class=
"md-nav__link">
1232 <li class=
"md-nav__item">
1233 <a href=
"../acp-menu/" class=
"md-nav__link">
1246 <li class=
"md-nav__item">
1247 <a href=
"../acp-search-provider/" class=
"md-nav__link">
1260 <li class=
"md-nav__item">
1261 <a href=
"../acp-template/" class=
"md-nav__link">
1274 <li class=
"md-nav__item">
1275 <a href=
"../acp-template-delete/" class=
"md-nav__link">
1288 <li class=
"md-nav__item">
1289 <a href=
"../bbcode/" class=
"md-nav__link">
1302 <li class=
"md-nav__item">
1303 <a href=
"../box/" class=
"md-nav__link">
1316 <li class=
"md-nav__item">
1317 <a href=
"../clipboard-action/" class=
"md-nav__link">
1330 <li class=
"md-nav__item">
1331 <a href=
"../core-object/" class=
"md-nav__link">
1344 <li class=
"md-nav__item">
1345 <a href=
"../cronjob/" class=
"md-nav__link">
1358 <li class=
"md-nav__item">
1359 <a href=
"../database/" class=
"md-nav__link">
1372 <li class=
"md-nav__item">
1373 <a href=
"../event-listener/" class=
"md-nav__link">
1386 <li class=
"md-nav__item">
1387 <a href=
"../file/" class=
"md-nav__link">
1400 <li class=
"md-nav__item">
1401 <a href=
"../file-delete/" class=
"md-nav__link">
1414 <li class=
"md-nav__item">
1415 <a href=
"../language/" class=
"md-nav__link">
1428 <li class=
"md-nav__item">
1429 <a href=
"../media-provider/" class=
"md-nav__link">
1442 <li class=
"md-nav__item">
1443 <a href=
"../menu/" class=
"md-nav__link">
1456 <li class=
"md-nav__item">
1457 <a href=
"../menu-item/" class=
"md-nav__link">
1470 <li class=
"md-nav__item">
1471 <a href=
"../object-type/" class=
"md-nav__link">
1486 <li class=
"md-nav__item md-nav__item--active">
1488 <input class=
"md-nav__toggle md-toggle" type=
"checkbox" id=
"__toc">
1494 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1495 objectTypeDefinition
1496 <span class=
"md-nav__icon md-icon"></span>
1499 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1500 objectTypeDefinition
1505 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1512 <label class=
"md-nav__title" for=
"__toc">
1513 <span class=
"md-nav__icon md-icon"></span>
1516 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1518 <li class=
"md-nav__item">
1519 <a href=
"#components" class=
"md-nav__link">
1523 <nav class=
"md-nav" aria-label=
"Components">
1524 <ul class=
"md-nav__list">
1526 <li class=
"md-nav__item">
1527 <a href=
"#interfacename" class=
"md-nav__link">
1528 <interfacename
>
1538 <li class=
"md-nav__item">
1539 <a href=
"#example" class=
"md-nav__link">
1559 <li class=
"md-nav__item">
1560 <a href=
"../option/" class=
"md-nav__link">
1573 <li class=
"md-nav__item">
1574 <a href=
"../page/" class=
"md-nav__link">
1587 <li class=
"md-nav__item">
1588 <a href=
"../pip/" class=
"md-nav__link">
1601 <li class=
"md-nav__item">
1602 <a href=
"../script/" class=
"md-nav__link">
1615 <li class=
"md-nav__item">
1616 <a href=
"../smiley/" class=
"md-nav__link">
1629 <li class=
"md-nav__item">
1630 <a href=
"../sql/" class=
"md-nav__link">
1643 <li class=
"md-nav__item">
1644 <a href=
"../style/" class=
"md-nav__link">
1657 <li class=
"md-nav__item">
1658 <a href=
"../template/" class=
"md-nav__link">
1671 <li class=
"md-nav__item">
1672 <a href=
"../template-delete/" class=
"md-nav__link">
1685 <li class=
"md-nav__item">
1686 <a href=
"../template-listener/" class=
"md-nav__link">
1699 <li class=
"md-nav__item">
1700 <a href=
"../user-group-option/" class=
"md-nav__link">
1713 <li class=
"md-nav__item">
1714 <a href=
"../user-menu/" class=
"md-nav__link">
1727 <li class=
"md-nav__item">
1728 <a href=
"../user-notification-event/" class=
"md-nav__link">
1729 userNotificationEvent
1741 <li class=
"md-nav__item">
1742 <a href=
"../user-option/" class=
"md-nav__link">
1755 <li class=
"md-nav__item">
1756 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1776 <li class=
"md-nav__item">
1777 <a href=
"../../database-php-api/" class=
"md-nav__link">
1799 <li class=
"md-nav__item md-nav__item--nested">
1804 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6" >
1808 <label class=
"md-nav__link" for=
"__nav_6" id=
"__nav_6_label" tabindex=
"0">
1810 <span class=
"md-nav__icon md-icon"></span>
1813 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_6_label" aria-expanded=
"false">
1814 <label class=
"md-nav__title" for=
"__nav_6">
1815 <span class=
"md-nav__icon md-icon"></span>
1818 <ul class=
"md-nav__list" data-md-scrollfix
>
1826 <li class=
"md-nav__item md-nav__item--nested">
1831 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_1" >
1835 <label class=
"md-nav__link" for=
"__nav_6_1" id=
"__nav_6_1_label" tabindex=
"0">
1836 From WoltLab Suite
5.5
1837 <span class=
"md-nav__icon md-icon"></span>
1840 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_1_label" aria-expanded=
"false">
1841 <label class=
"md-nav__title" for=
"__nav_6_1">
1842 <span class=
"md-nav__icon md-icon"></span>
1843 From WoltLab Suite
5.5
1845 <ul class=
"md-nav__list" data-md-scrollfix
>
1852 <li class=
"md-nav__item">
1853 <a href=
"../../../migration/wsc55/php/" class=
"md-nav__link">
1866 <li class=
"md-nav__item">
1867 <a href=
"../../../migration/wsc55/javascript/" class=
"md-nav__link">
1868 TypeScript and JavaScript
1880 <li class=
"md-nav__item">
1881 <a href=
"../../../migration/wsc55/templates/" class=
"md-nav__link">
1894 <li class=
"md-nav__item">
1895 <a href=
"../../../migration/wsc55/icons/" class=
"md-nav__link">
1908 <li class=
"md-nav__item">
1909 <a href=
"../../../migration/wsc55/dialogs/" class=
"md-nav__link">
1922 <li class=
"md-nav__item">
1923 <a href=
"../../../migration/wsc55/libraries/" class=
"md-nav__link">
1924 Third Party Libraries
1936 <li class=
"md-nav__item">
1937 <a href=
"../../../migration/wsc55/deprecations_removals/" class=
"md-nav__link">
1938 Deprecations and Removals
1958 <li class=
"md-nav__item md-nav__item--nested">
1963 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_2" >
1967 <label class=
"md-nav__link" for=
"__nav_6_2" id=
"__nav_6_2_label" tabindex=
"0">
1968 From WoltLab Suite
5.4
1969 <span class=
"md-nav__icon md-icon"></span>
1972 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_2_label" aria-expanded=
"false">
1973 <label class=
"md-nav__title" for=
"__nav_6_2">
1974 <span class=
"md-nav__icon md-icon"></span>
1975 From WoltLab Suite
5.4
1977 <ul class=
"md-nav__list" data-md-scrollfix
>
1984 <li class=
"md-nav__item">
1985 <a href=
"../../../migration/wsc54/php/" class=
"md-nav__link">
1998 <li class=
"md-nav__item">
1999 <a href=
"../../../migration/wsc54/javascript/" class=
"md-nav__link">
2000 TypeScript and JavaScript
2012 <li class=
"md-nav__item">
2013 <a href=
"../../../migration/wsc54/templates/" class=
"md-nav__link">
2026 <li class=
"md-nav__item">
2027 <a href=
"../../../migration/wsc54/libraries/" class=
"md-nav__link">
2028 Third Party Libraries
2040 <li class=
"md-nav__item">
2041 <a href=
"../../../migration/wsc54/deprecations_removals/" class=
"md-nav__link">
2042 Deprecations and Removals
2062 <li class=
"md-nav__item md-nav__item--nested">
2067 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_3" >
2071 <label class=
"md-nav__link" for=
"__nav_6_3" id=
"__nav_6_3_label" tabindex=
"0">
2072 From WoltLab Suite
5.3
2073 <span class=
"md-nav__icon md-icon"></span>
2076 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_3_label" aria-expanded=
"false">
2077 <label class=
"md-nav__title" for=
"__nav_6_3">
2078 <span class=
"md-nav__icon md-icon"></span>
2079 From WoltLab Suite
5.3
2081 <ul class=
"md-nav__list" data-md-scrollfix
>
2088 <li class=
"md-nav__item">
2089 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
2102 <li class=
"md-nav__item">
2103 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
2104 Session Handling and Authentication
2116 <li class=
"md-nav__item">
2117 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
2118 TypeScript and JavaScript
2130 <li class=
"md-nav__item">
2131 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
2144 <li class=
"md-nav__item">
2145 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
2146 Third Party Libraries
2166 <li class=
"md-nav__item md-nav__item--nested">
2171 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_4" >
2175 <label class=
"md-nav__link" for=
"__nav_6_4" id=
"__nav_6_4_label" tabindex=
"0">
2176 From WoltLab Suite
5.2
2177 <span class=
"md-nav__icon md-icon"></span>
2180 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_4_label" aria-expanded=
"false">
2181 <label class=
"md-nav__title" for=
"__nav_6_4">
2182 <span class=
"md-nav__icon md-icon"></span>
2183 From WoltLab Suite
5.2
2185 <ul class=
"md-nav__list" data-md-scrollfix
>
2192 <li class=
"md-nav__item">
2193 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
2206 <li class=
"md-nav__item">
2207 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
2208 Templates and Languages
2220 <li class=
"md-nav__item">
2221 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
2222 Third Party Libraries
2242 <li class=
"md-nav__item md-nav__item--nested">
2247 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_5" >
2251 <label class=
"md-nav__link" for=
"__nav_6_5" id=
"__nav_6_5_label" tabindex=
"0">
2252 From WoltLab Suite
3.1
2253 <span class=
"md-nav__icon md-icon"></span>
2256 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_5_label" aria-expanded=
"false">
2257 <label class=
"md-nav__title" for=
"__nav_6_5">
2258 <span class=
"md-nav__icon md-icon"></span>
2259 From WoltLab Suite
3.1
2261 <ul class=
"md-nav__list" data-md-scrollfix
>
2268 <li class=
"md-nav__item">
2269 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
2290 <li class=
"md-nav__item md-nav__item--nested">
2295 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_6" >
2299 <label class=
"md-nav__link" for=
"__nav_6_6" id=
"__nav_6_6_label" tabindex=
"0">
2300 From WoltLab Suite
3.0
2301 <span class=
"md-nav__icon md-icon"></span>
2304 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_6_label" aria-expanded=
"false">
2305 <label class=
"md-nav__title" for=
"__nav_6_6">
2306 <span class=
"md-nav__icon md-icon"></span>
2307 From WoltLab Suite
3.0
2309 <ul class=
"md-nav__list" data-md-scrollfix
>
2316 <li class=
"md-nav__item">
2317 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
2330 <li class=
"md-nav__item">
2331 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
2344 <li class=
"md-nav__item">
2345 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
2358 <li class=
"md-nav__item">
2359 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
2372 <li class=
"md-nav__item">
2373 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
2394 <li class=
"md-nav__item md-nav__item--nested">
2399 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_7" >
2403 <label class=
"md-nav__link" for=
"__nav_6_7" id=
"__nav_6_7_label" tabindex=
"0">
2405 <span class=
"md-nav__icon md-icon"></span>
2408 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_7_label" aria-expanded=
"false">
2409 <label class=
"md-nav__title" for=
"__nav_6_7">
2410 <span class=
"md-nav__icon md-icon"></span>
2413 <ul class=
"md-nav__list" data-md-scrollfix
>
2420 <li class=
"md-nav__item">
2421 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
2434 <li class=
"md-nav__item">
2435 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
2448 <li class=
"md-nav__item">
2449 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
2462 <li class=
"md-nav__item">
2463 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
2492 <li class=
"md-nav__item md-nav__item--nested">
2497 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7" >
2501 <label class=
"md-nav__link" for=
"__nav_7" id=
"__nav_7_label" tabindex=
"0">
2503 <span class=
"md-nav__icon md-icon"></span>
2506 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_7_label" aria-expanded=
"false">
2507 <label class=
"md-nav__title" for=
"__nav_7">
2508 <span class=
"md-nav__icon md-icon"></span>
2511 <ul class=
"md-nav__list" data-md-scrollfix
>
2519 <li class=
"md-nav__item md-nav__item--nested">
2524 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7_1" >
2528 <label class=
"md-nav__link" for=
"__nav_7_1" id=
"__nav_7_1_label" tabindex=
"0">
2530 <span class=
"md-nav__icon md-icon"></span>
2533 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_7_1_label" aria-expanded=
"false">
2534 <label class=
"md-nav__title" for=
"__nav_7_1">
2535 <span class=
"md-nav__icon md-icon"></span>
2538 <ul class=
"md-nav__list" data-md-scrollfix
>
2545 <li class=
"md-nav__item">
2546 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
2559 <li class=
"md-nav__item">
2560 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
2573 <li class=
"md-nav__item">
2574 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
2587 <li class=
"md-nav__item">
2588 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
2601 <li class=
"md-nav__item">
2602 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
2615 <li class=
"md-nav__item">
2616 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
2629 <li class=
"md-nav__item">
2630 <a href=
"../../../tutorial/series/part_6/" class=
"md-nav__link">
2659 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2660 <div class=
"md-sidebar__scrollwrap">
2661 <div class=
"md-sidebar__inner">
2664 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2671 <label class=
"md-nav__title" for=
"__toc">
2672 <span class=
"md-nav__icon md-icon"></span>
2675 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2677 <li class=
"md-nav__item">
2678 <a href=
"#components" class=
"md-nav__link">
2682 <nav class=
"md-nav" aria-label=
"Components">
2683 <ul class=
"md-nav__list">
2685 <li class=
"md-nav__item">
2686 <a href=
"#interfacename" class=
"md-nav__link">
2687 <interfacename
>
2697 <li class=
"md-nav__item">
2698 <a href=
"#example" class=
"md-nav__link">
2713 <div class=
"md-content" data-md-component=
"content">
2714 <article class=
"md-content__inner md-typeset">
2722 <h1 id=
"object-type-definition-package-installation-plugin">Object Type Definition Package Installation Plugin
<a class=
"headerlink" href=
"#object-type-definition-package-installation-plugin" title=
"Permanent link">#
</a></h1>
2723 <p>Registers an object type definition.
2724 An object type definition is a blueprint for a certain behaviour that is particularized by
<a href=
"../object-type/">objectTypes
</a>.
2725 As an example: Tags can be attached to different types of content (such as forum posts or gallery images).
2726 The bulk of the work is implemented in a generalized fashion, with all the tags stored in a single database table.
2727 Certain things, such as permission checking, need to be particularized for the specific type of content, though.
2728 Thus tags (or rather “taggable content”) are registered as an object type definition.
2729 Posts are then registered as an object type, implementing the “taggable content” behaviour.
</p>
2730 <p>Other types of object type definitions include attachments, likes, polls, subscriptions, or even the category system.
</p>
2731 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
2732 <p>Each item is described as a
<code><definition
></code> element with the mandatory child
<code><name
></code> that should follow the naming pattern
<code><packageIdentifier
>.
<definition
></code>, e.g.
<code>com.woltlab.wcf.example
</code>.
</p>
2733 <h3 id=
"interfacename"><code><interfacename
></code><a class=
"headerlink" href=
"#interfacename" title=
"Permanent link">#
</a></h3>
2734 <p><span class=
"label label-info">Optional
</span></p>
2735 <p>The name of the PHP interface
<a href=
"../object-type/">objectTypes
</a> have to implement.
</p>
2736 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
2737 <div class=
"highlight"><table class=
"highlighttable"><tr><th colspan=
"2" class=
"filename"><span class=
"filename">objectTypeDefinition.xml
<a class=
"codeBoxTitleGitHubLink" href=
"https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/package/pip/objectTypeDefinition.xml" title=
"View on GitHub"><span class=
"twemoji"><svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2738 <span class=
"normal">2</span>
2739 <span class=
"normal">3</span>
2740 <span class=
"normal">4</span>
2741 <span class=
"normal">5</span>
2742 <span class=
"normal">6</span>
2743 <span class=
"normal">7</span>
2744 <span class=
"normal">8</span>
2745 <span class=
"normal">9</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
2746 <span class=
"nt"><data
</span><span class=
"w"> </span><span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span><span class=
"w"> </span><span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span><span class=
"w"> </span><span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/
2019/objectTypeDefinition.xsd
"</span><span class=
"nt">></span>
2747 <span class=
"w"> </span><span class=
"nt"><import
></span>
2748 <span class=
"w"> </span><span class=
"nt"><definition
></span>
2749 <span class=
"w"> </span><span class=
"nt"><name
></span>com.woltlab.wcf.example
<span class=
"nt"></name
></span>
2750 <span class=
"w"> </span><span class=
"nt"><interfacename
></span>wcf\system\example\IExampleObjectType
<span class=
"nt"></interfacename
></span>
2751 <span class=
"w"> </span><span class=
"nt"></definition
></span>
2752 <span class=
"w"> </span><span class=
"nt"></import
></span>
2753 <span class=
"nt"></data
></span>
2754 </code></pre></div></td></tr></table></div>
2757 <div class=
"md-source-file">
2779 <footer class=
"md-footer">
2781 <div class=
"md-footer-meta md-typeset">
2782 <div class=
"md-footer-meta__inner md-grid">
2783 <div class=
"md-copyright">
2785 <div class=
"md-copyright__highlight">
2786 Copyright ©
2020 WoltLab GmbH
2791 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2797 <div class=
"md-copyright">
2798 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2799 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2807 <div class=
"md-dialog" data-md-component=
"dialog">
2808 <div class=
"md-dialog__inner md-typeset"></div>
2811 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [
"navigation.tracking"],
"search":
"../../../assets/javascripts/workers/search.74e28a9f.min.js",
"translations": {
"clipboard.copied":
"Copied to clipboard",
"clipboard.copy":
"Copy to clipboard",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.placeholder":
"Type to start searching",
"search.result.term.missing":
"Missing",
"select.version":
"Select version"},
"version": {
"provider":
"mike"}}
</script>
2814 <script src=
"../../../assets/javascripts/bundle.220ee61c.min.js"></script>