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/smiley/">
14 <link rel=
"prev" href=
"../script/">
17 <link rel=
"next" href=
"../sql/">
19 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
20 <meta name=
"generator" content=
"mkdocs-1.4.3, mkdocs-material-9.1.15">
24 <title>smiley - WoltLab Suite Documentation
</title>
28 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.26e3688c.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=
"#smiley-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_confirmation/" class=
"md-nav__link">
887 <li class=
"md-nav__item">
888 <a href=
"../../../javascript/components_dialog/" class=
"md-nav__link">
901 <li class=
"md-nav__item">
902 <a href=
"../../../javascript/components_google_maps/" class=
"md-nav__link">
915 <li class=
"md-nav__item">
916 <a href=
"../../../javascript/components_pagination/" class=
"md-nav__link">
937 <li class=
"md-nav__item md-nav__item--nested">
942 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_4_4" >
946 <label class=
"md-nav__link" for=
"__nav_4_4" id=
"__nav_4_4_label" tabindex=
"0">
948 <span class=
"md-nav__icon md-icon"></span>
951 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_4_4_label" aria-expanded=
"false">
952 <label class=
"md-nav__title" for=
"__nav_4_4">
953 <span class=
"md-nav__icon md-icon"></span>
956 <ul class=
"md-nav__list" data-md-scrollfix
>
963 <li class=
"md-nav__item">
964 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
977 <li class=
"md-nav__item">
978 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
991 <li class=
"md-nav__item">
992 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
1005 <li class=
"md-nav__item">
1006 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
1019 <li class=
"md-nav__item">
1020 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
1033 <li class=
"md-nav__item">
1034 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
1047 <li class=
"md-nav__item">
1048 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
1049 Browser and Screen Sizes
1061 <li class=
"md-nav__item">
1062 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
1082 <li class=
"md-nav__item">
1083 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
1096 <li class=
"md-nav__item">
1097 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
1121 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1126 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5" checked
>
1130 <label class=
"md-nav__link" for=
"__nav_5" id=
"__nav_5_label" tabindex=
"0">
1132 <span class=
"md-nav__icon md-icon"></span>
1135 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_5_label" aria-expanded=
"true">
1136 <label class=
"md-nav__title" for=
"__nav_5">
1137 <span class=
"md-nav__icon md-icon"></span>
1140 <ul class=
"md-nav__list" data-md-scrollfix
>
1147 <li class=
"md-nav__item">
1148 <a href=
"../../package-xml/" class=
"md-nav__link">
1164 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1169 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_5_2" checked
>
1173 <label class=
"md-nav__link" for=
"__nav_5_2" id=
"__nav_5_2_label" tabindex=
"0">
1175 <span class=
"md-nav__icon md-icon"></span>
1178 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_5_2_label" aria-expanded=
"true">
1179 <label class=
"md-nav__title" for=
"__nav_5_2">
1180 <span class=
"md-nav__icon md-icon"></span>
1183 <ul class=
"md-nav__list" data-md-scrollfix
>
1190 <li class=
"md-nav__item">
1191 <a href=
"../" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../acl-option/" class=
"md-nav__link">
1218 <li class=
"md-nav__item">
1219 <a href=
"../acp-menu/" class=
"md-nav__link">
1232 <li class=
"md-nav__item">
1233 <a href=
"../acp-search-provider/" class=
"md-nav__link">
1246 <li class=
"md-nav__item">
1247 <a href=
"../acp-template/" class=
"md-nav__link">
1260 <li class=
"md-nav__item">
1261 <a href=
"../acp-template-delete/" class=
"md-nav__link">
1274 <li class=
"md-nav__item">
1275 <a href=
"../bbcode/" class=
"md-nav__link">
1288 <li class=
"md-nav__item">
1289 <a href=
"../box/" class=
"md-nav__link">
1302 <li class=
"md-nav__item">
1303 <a href=
"../clipboard-action/" class=
"md-nav__link">
1316 <li class=
"md-nav__item">
1317 <a href=
"../core-object/" class=
"md-nav__link">
1330 <li class=
"md-nav__item">
1331 <a href=
"../cronjob/" class=
"md-nav__link">
1344 <li class=
"md-nav__item">
1345 <a href=
"../database/" class=
"md-nav__link">
1358 <li class=
"md-nav__item">
1359 <a href=
"../event-listener/" class=
"md-nav__link">
1372 <li class=
"md-nav__item">
1373 <a href=
"../file/" class=
"md-nav__link">
1386 <li class=
"md-nav__item">
1387 <a href=
"../file-delete/" class=
"md-nav__link">
1400 <li class=
"md-nav__item">
1401 <a href=
"../language/" class=
"md-nav__link">
1414 <li class=
"md-nav__item">
1415 <a href=
"../media-provider/" class=
"md-nav__link">
1428 <li class=
"md-nav__item">
1429 <a href=
"../menu/" class=
"md-nav__link">
1442 <li class=
"md-nav__item">
1443 <a href=
"../menu-item/" class=
"md-nav__link">
1456 <li class=
"md-nav__item">
1457 <a href=
"../object-type/" class=
"md-nav__link">
1470 <li class=
"md-nav__item">
1471 <a href=
"../object-type-definition/" class=
"md-nav__link">
1472 objectTypeDefinition
1484 <li class=
"md-nav__item">
1485 <a href=
"../option/" class=
"md-nav__link">
1498 <li class=
"md-nav__item">
1499 <a href=
"../page/" class=
"md-nav__link">
1512 <li class=
"md-nav__item">
1513 <a href=
"../pip/" class=
"md-nav__link">
1526 <li class=
"md-nav__item">
1527 <a href=
"../script/" class=
"md-nav__link">
1542 <li class=
"md-nav__item md-nav__item--active">
1544 <input class=
"md-nav__toggle md-toggle" type=
"checkbox" id=
"__toc">
1550 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1552 <span class=
"md-nav__icon md-icon"></span>
1555 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1561 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1568 <label class=
"md-nav__title" for=
"__toc">
1569 <span class=
"md-nav__icon md-icon"></span>
1572 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1574 <li class=
"md-nav__item">
1575 <a href=
"#components" class=
"md-nav__link">
1579 <nav class=
"md-nav" aria-label=
"Components">
1580 <ul class=
"md-nav__list">
1582 <li class=
"md-nav__item">
1583 <a href=
"#title" class=
"md-nav__link">
1589 <li class=
"md-nav__item">
1590 <a href=
"#path2x" class=
"md-nav__link">
1596 <li class=
"md-nav__item">
1597 <a href=
"#aliases" class=
"md-nav__link">
1603 <li class=
"md-nav__item">
1604 <a href=
"#showorder" class=
"md-nav__link">
1615 <li class=
"md-nav__item">
1616 <a href=
"#example" class=
"md-nav__link">
1636 <li class=
"md-nav__item">
1637 <a href=
"../sql/" class=
"md-nav__link">
1650 <li class=
"md-nav__item">
1651 <a href=
"../style/" class=
"md-nav__link">
1664 <li class=
"md-nav__item">
1665 <a href=
"../template/" class=
"md-nav__link">
1678 <li class=
"md-nav__item">
1679 <a href=
"../template-delete/" class=
"md-nav__link">
1692 <li class=
"md-nav__item">
1693 <a href=
"../template-listener/" class=
"md-nav__link">
1706 <li class=
"md-nav__item">
1707 <a href=
"../user-group-option/" class=
"md-nav__link">
1720 <li class=
"md-nav__item">
1721 <a href=
"../user-menu/" class=
"md-nav__link">
1734 <li class=
"md-nav__item">
1735 <a href=
"../user-notification-event/" class=
"md-nav__link">
1736 userNotificationEvent
1748 <li class=
"md-nav__item">
1749 <a href=
"../user-option/" class=
"md-nav__link">
1762 <li class=
"md-nav__item">
1763 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1783 <li class=
"md-nav__item">
1784 <a href=
"../../database-php-api/" class=
"md-nav__link">
1806 <li class=
"md-nav__item md-nav__item--nested">
1811 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6" >
1815 <label class=
"md-nav__link" for=
"__nav_6" id=
"__nav_6_label" tabindex=
"0">
1817 <span class=
"md-nav__icon md-icon"></span>
1820 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_6_label" aria-expanded=
"false">
1821 <label class=
"md-nav__title" for=
"__nav_6">
1822 <span class=
"md-nav__icon md-icon"></span>
1825 <ul class=
"md-nav__list" data-md-scrollfix
>
1833 <li class=
"md-nav__item md-nav__item--nested">
1838 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_1" >
1842 <label class=
"md-nav__link" for=
"__nav_6_1" id=
"__nav_6_1_label" tabindex=
"0">
1843 From WoltLab Suite
5.5
1844 <span class=
"md-nav__icon md-icon"></span>
1847 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_1_label" aria-expanded=
"false">
1848 <label class=
"md-nav__title" for=
"__nav_6_1">
1849 <span class=
"md-nav__icon md-icon"></span>
1850 From WoltLab Suite
5.5
1852 <ul class=
"md-nav__list" data-md-scrollfix
>
1859 <li class=
"md-nav__item">
1860 <a href=
"../../../migration/wsc55/php/" class=
"md-nav__link">
1873 <li class=
"md-nav__item">
1874 <a href=
"../../../migration/wsc55/javascript/" class=
"md-nav__link">
1875 TypeScript and JavaScript
1887 <li class=
"md-nav__item">
1888 <a href=
"../../../migration/wsc55/templates/" class=
"md-nav__link">
1901 <li class=
"md-nav__item">
1902 <a href=
"../../../migration/wsc55/icons/" class=
"md-nav__link">
1915 <li class=
"md-nav__item">
1916 <a href=
"../../../migration/wsc55/dialogs/" class=
"md-nav__link">
1929 <li class=
"md-nav__item">
1930 <a href=
"../../../migration/wsc55/libraries/" class=
"md-nav__link">
1931 Third Party Libraries
1943 <li class=
"md-nav__item">
1944 <a href=
"../../../migration/wsc55/deprecations_removals/" class=
"md-nav__link">
1945 Deprecations and Removals
1965 <li class=
"md-nav__item md-nav__item--nested">
1970 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_2" >
1974 <label class=
"md-nav__link" for=
"__nav_6_2" id=
"__nav_6_2_label" tabindex=
"0">
1975 From WoltLab Suite
5.4
1976 <span class=
"md-nav__icon md-icon"></span>
1979 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_2_label" aria-expanded=
"false">
1980 <label class=
"md-nav__title" for=
"__nav_6_2">
1981 <span class=
"md-nav__icon md-icon"></span>
1982 From WoltLab Suite
5.4
1984 <ul class=
"md-nav__list" data-md-scrollfix
>
1991 <li class=
"md-nav__item">
1992 <a href=
"../../../migration/wsc54/php/" class=
"md-nav__link">
2005 <li class=
"md-nav__item">
2006 <a href=
"../../../migration/wsc54/javascript/" class=
"md-nav__link">
2007 TypeScript and JavaScript
2019 <li class=
"md-nav__item">
2020 <a href=
"../../../migration/wsc54/templates/" class=
"md-nav__link">
2033 <li class=
"md-nav__item">
2034 <a href=
"../../../migration/wsc54/libraries/" class=
"md-nav__link">
2035 Third Party Libraries
2047 <li class=
"md-nav__item">
2048 <a href=
"../../../migration/wsc54/deprecations_removals/" class=
"md-nav__link">
2049 Deprecations and Removals
2069 <li class=
"md-nav__item md-nav__item--nested">
2074 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_3" >
2078 <label class=
"md-nav__link" for=
"__nav_6_3" id=
"__nav_6_3_label" tabindex=
"0">
2079 From WoltLab Suite
5.3
2080 <span class=
"md-nav__icon md-icon"></span>
2083 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_3_label" aria-expanded=
"false">
2084 <label class=
"md-nav__title" for=
"__nav_6_3">
2085 <span class=
"md-nav__icon md-icon"></span>
2086 From WoltLab Suite
5.3
2088 <ul class=
"md-nav__list" data-md-scrollfix
>
2095 <li class=
"md-nav__item">
2096 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
2109 <li class=
"md-nav__item">
2110 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
2111 Session Handling and Authentication
2123 <li class=
"md-nav__item">
2124 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
2125 TypeScript and JavaScript
2137 <li class=
"md-nav__item">
2138 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
2151 <li class=
"md-nav__item">
2152 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
2153 Third Party Libraries
2173 <li class=
"md-nav__item md-nav__item--nested">
2178 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_4" >
2182 <label class=
"md-nav__link" for=
"__nav_6_4" id=
"__nav_6_4_label" tabindex=
"0">
2183 From WoltLab Suite
5.2
2184 <span class=
"md-nav__icon md-icon"></span>
2187 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_4_label" aria-expanded=
"false">
2188 <label class=
"md-nav__title" for=
"__nav_6_4">
2189 <span class=
"md-nav__icon md-icon"></span>
2190 From WoltLab Suite
5.2
2192 <ul class=
"md-nav__list" data-md-scrollfix
>
2199 <li class=
"md-nav__item">
2200 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
2213 <li class=
"md-nav__item">
2214 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
2215 Templates and Languages
2227 <li class=
"md-nav__item">
2228 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
2229 Third Party Libraries
2249 <li class=
"md-nav__item md-nav__item--nested">
2254 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_5" >
2258 <label class=
"md-nav__link" for=
"__nav_6_5" id=
"__nav_6_5_label" tabindex=
"0">
2259 From WoltLab Suite
3.1
2260 <span class=
"md-nav__icon md-icon"></span>
2263 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_5_label" aria-expanded=
"false">
2264 <label class=
"md-nav__title" for=
"__nav_6_5">
2265 <span class=
"md-nav__icon md-icon"></span>
2266 From WoltLab Suite
3.1
2268 <ul class=
"md-nav__list" data-md-scrollfix
>
2275 <li class=
"md-nav__item">
2276 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
2297 <li class=
"md-nav__item md-nav__item--nested">
2302 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_6" >
2306 <label class=
"md-nav__link" for=
"__nav_6_6" id=
"__nav_6_6_label" tabindex=
"0">
2307 From WoltLab Suite
3.0
2308 <span class=
"md-nav__icon md-icon"></span>
2311 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_6_label" aria-expanded=
"false">
2312 <label class=
"md-nav__title" for=
"__nav_6_6">
2313 <span class=
"md-nav__icon md-icon"></span>
2314 From WoltLab Suite
3.0
2316 <ul class=
"md-nav__list" data-md-scrollfix
>
2323 <li class=
"md-nav__item">
2324 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
2337 <li class=
"md-nav__item">
2338 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
2351 <li class=
"md-nav__item">
2352 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
2365 <li class=
"md-nav__item">
2366 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
2379 <li class=
"md-nav__item">
2380 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
2401 <li class=
"md-nav__item md-nav__item--nested">
2406 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_6_7" >
2410 <label class=
"md-nav__link" for=
"__nav_6_7" id=
"__nav_6_7_label" tabindex=
"0">
2412 <span class=
"md-nav__icon md-icon"></span>
2415 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_6_7_label" aria-expanded=
"false">
2416 <label class=
"md-nav__title" for=
"__nav_6_7">
2417 <span class=
"md-nav__icon md-icon"></span>
2420 <ul class=
"md-nav__list" data-md-scrollfix
>
2427 <li class=
"md-nav__item">
2428 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
2441 <li class=
"md-nav__item">
2442 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
2455 <li class=
"md-nav__item">
2456 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
2469 <li class=
"md-nav__item">
2470 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
2499 <li class=
"md-nav__item md-nav__item--nested">
2504 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7" >
2508 <label class=
"md-nav__link" for=
"__nav_7" id=
"__nav_7_label" tabindex=
"0">
2510 <span class=
"md-nav__icon md-icon"></span>
2513 <nav class=
"md-nav" data-md-level=
"1" aria-labelledby=
"__nav_7_label" aria-expanded=
"false">
2514 <label class=
"md-nav__title" for=
"__nav_7">
2515 <span class=
"md-nav__icon md-icon"></span>
2518 <ul class=
"md-nav__list" data-md-scrollfix
>
2526 <li class=
"md-nav__item md-nav__item--nested">
2531 <input class=
"md-nav__toggle md-toggle " type=
"checkbox" id=
"__nav_7_1" >
2535 <label class=
"md-nav__link" for=
"__nav_7_1" id=
"__nav_7_1_label" tabindex=
"0">
2537 <span class=
"md-nav__icon md-icon"></span>
2540 <nav class=
"md-nav" data-md-level=
"2" aria-labelledby=
"__nav_7_1_label" aria-expanded=
"false">
2541 <label class=
"md-nav__title" for=
"__nav_7_1">
2542 <span class=
"md-nav__icon md-icon"></span>
2545 <ul class=
"md-nav__list" data-md-scrollfix
>
2552 <li class=
"md-nav__item">
2553 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
2566 <li class=
"md-nav__item">
2567 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
2580 <li class=
"md-nav__item">
2581 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
2594 <li class=
"md-nav__item">
2595 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
2608 <li class=
"md-nav__item">
2609 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
2622 <li class=
"md-nav__item">
2623 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
2636 <li class=
"md-nav__item">
2637 <a href=
"../../../tutorial/series/part_6/" class=
"md-nav__link">
2666 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2667 <div class=
"md-sidebar__scrollwrap">
2668 <div class=
"md-sidebar__inner">
2671 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2678 <label class=
"md-nav__title" for=
"__toc">
2679 <span class=
"md-nav__icon md-icon"></span>
2682 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2684 <li class=
"md-nav__item">
2685 <a href=
"#components" class=
"md-nav__link">
2689 <nav class=
"md-nav" aria-label=
"Components">
2690 <ul class=
"md-nav__list">
2692 <li class=
"md-nav__item">
2693 <a href=
"#title" class=
"md-nav__link">
2699 <li class=
"md-nav__item">
2700 <a href=
"#path2x" class=
"md-nav__link">
2706 <li class=
"md-nav__item">
2707 <a href=
"#aliases" class=
"md-nav__link">
2713 <li class=
"md-nav__item">
2714 <a href=
"#showorder" class=
"md-nav__link">
2725 <li class=
"md-nav__item">
2726 <a href=
"#example" class=
"md-nav__link">
2741 <div class=
"md-content" data-md-component=
"content">
2742 <article class=
"md-content__inner md-typeset">
2750 <h1 id=
"smiley-package-installation-plugin">Smiley Package Installation Plugin
<a class=
"headerlink" href=
"#smiley-package-installation-plugin" title=
"Permanent link">#
</a></h1>
2751 <p>Installs new smileys.
</p>
2752 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
2753 <p>Each smiley is described as an
<code><smiley
></code> element with the mandatory attribute
<code>name
</code>.
</p>
2754 <h3 id=
"title"><code><title
></code><a class=
"headerlink" href=
"#title" title=
"Permanent link">#
</a></h3>
2755 <p>Short human readable description of the smiley.
</p>
2756 <h3 id=
"path2x"><code><path(
2x)?
></code><a class=
"headerlink" href=
"#path2x" title=
"Permanent link">#
</a></h3>
2757 <div class=
"admonition warning">
2758 <p class=
"admonition-title">The files must be installed using the
<a href=
"../file/">file
</a> PIP.
</p>
2760 <p>File path relative to the root of WoltLab Suite Core.
2761 <code>path2x
</code> is optional and being used for High-DPI screens.
</p>
2762 <h3 id=
"aliases"><code><aliases
></code><a class=
"headerlink" href=
"#aliases" title=
"Permanent link">#
</a></h3>
2763 <p><span class=
"label label-info">Optional
</span></p>
2764 <p>List of smiley aliases.
2765 Aliases must be separated by a line feed character (
<code>\n
</code>, U+
000A).
</p>
2766 <h3 id=
"showorder"><code><showorder
></code><a class=
"headerlink" href=
"#showorder" title=
"Permanent link">#
</a></h3>
2767 <p><span class=
"label label-info">Optional
</span></p>
2768 <p>Determines at which position of the smiley list the smiley is shown.
</p>
2769 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
2770 <div class=
"highlight"><table class=
"highlighttable"><tr><th colspan=
"2" class=
"filename"><span class=
"filename">smiley.xml
<a class=
"codeBoxTitleGitHubLink" href=
"https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/package/pip/smiley.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>
2771 <span class=
"normal"> 2</span>
2772 <span class=
"normal"> 3</span>
2773 <span class=
"normal"> 4</span>
2774 <span class=
"normal"> 5</span>
2775 <span class=
"normal"> 6</span>
2776 <span class=
"normal"> 7</span>
2777 <span class=
"normal"> 8</span>
2778 <span class=
"normal"> 9</span>
2779 <span class=
"normal">10</span>
2780 <span class=
"normal">11</span>
2781 <span class=
"normal">12</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
2782 <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/smiley.xsd
"</span><span class=
"nt">></span>
2783 <span class=
"w"> </span><span class=
"nt"><import
></span>
2784 <span class=
"w"> </span><span class=
"nt"><smiley
</span><span class=
"w"> </span><span class=
"na">name=
</span><span class=
"s">":example:
"</span><span class=
"nt">></span>
2785 <span class=
"w"> </span><span class=
"nt"><title
></span>example
<span class=
"nt"></title
></span>
2786 <span class=
"w"> </span><span class=
"nt"><path
></span>images/smilies/example.png
<span class=
"nt"></path
></span>
2787 <span class=
"w"> </span><span class=
"nt"><path2x
></span>images/smilies/example@
2x.png
<span class=
"nt"></path2x
></span>
2788 <span class=
"w"> </span><span class=
"nt"><aliases
></span><span class=
"cp"><![CDATA[:alias:
</span>
2789 <span class=
"cp">:more_aliases:]]
></span><span class=
"nt"></aliases
></span>
2790 <span class=
"w"> </span><span class=
"nt"></smiley
></span>
2791 <span class=
"w"> </span><span class=
"nt"></import
></span>
2792 <span class=
"nt"></data
></span>
2793 </code></pre></div></td></tr></table></div>
2796 <div class=
"md-source-file">
2818 <footer class=
"md-footer">
2820 <div class=
"md-footer-meta md-typeset">
2821 <div class=
"md-footer-meta__inner md-grid">
2822 <div class=
"md-copyright">
2824 <div class=
"md-copyright__highlight">
2825 Copyright ©
2020 WoltLab GmbH
2830 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2836 <div class=
"md-copyright">
2837 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2838 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2846 <div class=
"md-dialog" data-md-component=
"dialog">
2847 <div class=
"md-dialog__inner md-typeset"></div>
2850 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [
"navigation.tracking"],
"search":
"../../../assets/javascripts/workers/search.208ed371.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>
2853 <script src=
"../../../assets/javascripts/bundle.b4d07000.min.js"></script>