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>User Activity Points - 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=
"#user-activity-points" 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">
222 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
225 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" checked
>
227 <label class=
"md-nav__link" for=
"__nav_2">
229 <span class=
"md-nav__icon md-icon"></span>
231 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
232 <label class=
"md-nav__title" for=
"__nav_2">
233 <span class=
"md-nav__icon md-icon"></span>
236 <ul class=
"md-nav__list" data-md-scrollfix
>
242 <li class=
"md-nav__item">
243 <a href=
"../../pages/" class=
"md-nav__link">
254 <li class=
"md-nav__item">
255 <a href=
"../../database-objects/" class=
"md-nav__link">
266 <li class=
"md-nav__item">
267 <a href=
"../../database-access/" class=
"md-nav__link">
278 <li class=
"md-nav__item">
279 <a href=
"../../exceptions/" class=
"md-nav__link">
293 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
296 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" checked
>
298 <label class=
"md-nav__link" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
302 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
303 <label class=
"md-nav__title" for=
"__nav_2_5">
304 <span class=
"md-nav__icon md-icon"></span>
307 <ul class=
"md-nav__list" data-md-scrollfix
>
314 <li class=
"md-nav__item md-nav__item--nested">
317 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
319 <label class=
"md-nav__link" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
323 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
324 <label class=
"md-nav__title" for=
"__nav_2_5_1">
325 <span class=
"md-nav__icon md-icon"></span>
328 <ul class=
"md-nav__list" data-md-scrollfix
>
334 <li class=
"md-nav__item">
335 <a href=
"../caches/" class=
"md-nav__link">
346 <li class=
"md-nav__item">
347 <a href=
"../caches_persistent-caches/" class=
"md-nav__link">
358 <li class=
"md-nav__item">
359 <a href=
"../caches_runtime-caches/" class=
"md-nav__link">
376 <li class=
"md-nav__item">
377 <a href=
"../comments/" class=
"md-nav__link">
388 <li class=
"md-nav__item">
389 <a href=
"../cronjobs/" class=
"md-nav__link">
400 <li class=
"md-nav__item">
401 <a href=
"../events/" class=
"md-nav__link">
413 <li class=
"md-nav__item md-nav__item--nested">
416 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
418 <label class=
"md-nav__link" for=
"__nav_2_5_5">
420 <span class=
"md-nav__icon md-icon"></span>
422 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
423 <label class=
"md-nav__title" for=
"__nav_2_5_5">
424 <span class=
"md-nav__icon md-icon"></span>
427 <ul class=
"md-nav__list" data-md-scrollfix
>
433 <li class=
"md-nav__item">
434 <a href=
"../form_builder/overview/" class=
"md-nav__link">
445 <li class=
"md-nav__item">
446 <a href=
"../form_builder/structure/" class=
"md-nav__link">
457 <li class=
"md-nav__item">
458 <a href=
"../form_builder/form_fields/" class=
"md-nav__link">
469 <li class=
"md-nav__item">
470 <a href=
"../form_builder/validation_data/" class=
"md-nav__link">
481 <li class=
"md-nav__item">
482 <a href=
"../form_builder/dependencies/" class=
"md-nav__link">
499 <li class=
"md-nav__item">
500 <a href=
"../package_installation_plugins/" class=
"md-nav__link">
501 Package Installation Plugins
513 <li class=
"md-nav__item md-nav__item--active">
515 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
520 <a href=
"./" class=
"md-nav__link md-nav__link--active">
532 <li class=
"md-nav__item">
533 <a href=
"../user_notifications/" class=
"md-nav__link">
544 <li class=
"md-nav__item">
545 <a href=
"../sitemaps/" class=
"md-nav__link">
562 <li class=
"md-nav__item">
563 <a href=
"../../code-style/" class=
"md-nav__link">
574 <li class=
"md-nav__item">
575 <a href=
"../../apps/" class=
"md-nav__link">
586 <li class=
"md-nav__item">
587 <a href=
"../../gdpr/" class=
"md-nav__link">
608 <li class=
"md-nav__item md-nav__item--nested">
611 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
613 <label class=
"md-nav__link" for=
"__nav_3">
614 Languages, Templates & CSS
615 <span class=
"md-nav__icon md-icon"></span>
617 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
618 <label class=
"md-nav__title" for=
"__nav_3">
619 <span class=
"md-nav__icon md-icon"></span>
620 Languages, Templates & CSS
622 <ul class=
"md-nav__list" data-md-scrollfix
>
628 <li class=
"md-nav__item">
629 <a href=
"../../../view/languages/" class=
"md-nav__link">
640 <li class=
"md-nav__item">
641 <a href=
"../../../view/templates/" class=
"md-nav__link">
652 <li class=
"md-nav__item">
653 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
664 <li class=
"md-nav__item">
665 <a href=
"../../../view/css/" class=
"md-nav__link">
686 <li class=
"md-nav__item md-nav__item--nested">
689 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
691 <label class=
"md-nav__link" for=
"__nav_4">
692 TypeScript and JavaScript API
693 <span class=
"md-nav__icon md-icon"></span>
695 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
696 <label class=
"md-nav__title" for=
"__nav_4">
697 <span class=
"md-nav__icon md-icon"></span>
698 TypeScript and JavaScript API
700 <ul class=
"md-nav__list" data-md-scrollfix
>
706 <li class=
"md-nav__item">
707 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
718 <li class=
"md-nav__item">
719 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
731 <li class=
"md-nav__item md-nav__item--nested">
734 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
736 <label class=
"md-nav__link" for=
"__nav_4_3">
738 <span class=
"md-nav__icon md-icon"></span>
740 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
741 <label class=
"md-nav__title" for=
"__nav_4_3">
742 <span class=
"md-nav__icon md-icon"></span>
745 <ul class=
"md-nav__list" data-md-scrollfix
>
751 <li class=
"md-nav__item">
752 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
763 <li class=
"md-nav__item">
764 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
775 <li class=
"md-nav__item">
776 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
787 <li class=
"md-nav__item">
788 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
799 <li class=
"md-nav__item">
800 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
811 <li class=
"md-nav__item">
812 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
823 <li class=
"md-nav__item">
824 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
835 <li class=
"md-nav__item">
836 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
837 Browser and Screen Sizes
847 <li class=
"md-nav__item">
848 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
865 <li class=
"md-nav__item">
866 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
877 <li class=
"md-nav__item">
878 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
889 <li class=
"md-nav__item">
890 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
911 <li class=
"md-nav__item md-nav__item--nested">
914 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
916 <label class=
"md-nav__link" for=
"__nav_5">
918 <span class=
"md-nav__icon md-icon"></span>
920 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
921 <label class=
"md-nav__title" for=
"__nav_5">
922 <span class=
"md-nav__icon md-icon"></span>
925 <ul class=
"md-nav__list" data-md-scrollfix
>
931 <li class=
"md-nav__item">
932 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
944 <li class=
"md-nav__item md-nav__item--nested">
947 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
949 <label class=
"md-nav__link" for=
"__nav_5_2">
951 <span class=
"md-nav__icon md-icon"></span>
953 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
954 <label class=
"md-nav__title" for=
"__nav_5_2">
955 <span class=
"md-nav__icon md-icon"></span>
958 <ul class=
"md-nav__list" data-md-scrollfix
>
964 <li class=
"md-nav__item">
965 <a href=
"../../../package/pip/" class=
"md-nav__link">
976 <li class=
"md-nav__item">
977 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
988 <li class=
"md-nav__item">
989 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
1000 <li class=
"md-nav__item">
1001 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
1012 <li class=
"md-nav__item">
1013 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1024 <li class=
"md-nav__item">
1025 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1036 <li class=
"md-nav__item">
1037 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1048 <li class=
"md-nav__item">
1049 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1060 <li class=
"md-nav__item">
1061 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1072 <li class=
"md-nav__item">
1073 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1084 <li class=
"md-nav__item">
1085 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1096 <li class=
"md-nav__item">
1097 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1108 <li class=
"md-nav__item">
1109 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1120 <li class=
"md-nav__item">
1121 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1132 <li class=
"md-nav__item">
1133 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1144 <li class=
"md-nav__item">
1145 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1156 <li class=
"md-nav__item">
1157 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1168 <li class=
"md-nav__item">
1169 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1180 <li class=
"md-nav__item">
1181 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1182 objectTypeDefinition
1192 <li class=
"md-nav__item">
1193 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1216 <li class=
"md-nav__item">
1217 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1228 <li class=
"md-nav__item">
1229 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1240 <li class=
"md-nav__item">
1241 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1252 <li class=
"md-nav__item">
1253 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1264 <li class=
"md-nav__item">
1265 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1276 <li class=
"md-nav__item">
1277 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1288 <li class=
"md-nav__item">
1289 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1300 <li class=
"md-nav__item">
1301 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1312 <li class=
"md-nav__item">
1313 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1324 <li class=
"md-nav__item">
1325 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1326 userNotificationEvent
1336 <li class=
"md-nav__item">
1337 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1348 <li class=
"md-nav__item">
1349 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1366 <li class=
"md-nav__item">
1367 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1388 <li class=
"md-nav__item md-nav__item--nested">
1391 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1393 <label class=
"md-nav__link" for=
"__nav_6">
1395 <span class=
"md-nav__icon md-icon"></span>
1397 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1398 <label class=
"md-nav__title" for=
"__nav_6">
1399 <span class=
"md-nav__icon md-icon"></span>
1402 <ul class=
"md-nav__list" data-md-scrollfix
>
1409 <li class=
"md-nav__item md-nav__item--nested">
1412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1414 <label class=
"md-nav__link" for=
"__nav_6_1">
1415 Migrating from WSC
5.3
1416 <span class=
"md-nav__icon md-icon"></span>
1418 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1419 <label class=
"md-nav__title" for=
"__nav_6_1">
1420 <span class=
"md-nav__icon md-icon"></span>
1421 Migrating from WSC
5.3
1423 <ul class=
"md-nav__list" data-md-scrollfix
>
1429 <li class=
"md-nav__item">
1430 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1441 <li class=
"md-nav__item">
1442 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1443 Session Handling and Authentication
1453 <li class=
"md-nav__item">
1454 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1455 TypeScript and JavaScript
1465 <li class=
"md-nav__item">
1466 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1477 <li class=
"md-nav__item">
1478 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1479 Third Party Libraries
1496 <li class=
"md-nav__item md-nav__item--nested">
1499 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1501 <label class=
"md-nav__link" for=
"__nav_6_2">
1502 Migrating from WSC
5.2
1503 <span class=
"md-nav__icon md-icon"></span>
1505 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1506 <label class=
"md-nav__title" for=
"__nav_6_2">
1507 <span class=
"md-nav__icon md-icon"></span>
1508 Migrating from WSC
5.2
1510 <ul class=
"md-nav__list" data-md-scrollfix
>
1516 <li class=
"md-nav__item">
1517 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1528 <li class=
"md-nav__item">
1529 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1530 Templates and Languages
1540 <li class=
"md-nav__item">
1541 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1542 Third Party Libraries
1559 <li class=
"md-nav__item md-nav__item--nested">
1562 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1564 <label class=
"md-nav__link" for=
"__nav_6_3">
1565 Migrating from WSC
3.1
1566 <span class=
"md-nav__icon md-icon"></span>
1568 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1569 <label class=
"md-nav__title" for=
"__nav_6_3">
1570 <span class=
"md-nav__icon md-icon"></span>
1571 Migrating from WSC
3.1
1573 <ul class=
"md-nav__list" data-md-scrollfix
>
1579 <li class=
"md-nav__item">
1580 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1598 <li class=
"md-nav__item md-nav__item--nested">
1601 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1603 <label class=
"md-nav__link" for=
"__nav_6_4">
1604 Migrating from WSC
3.0
1605 <span class=
"md-nav__icon md-icon"></span>
1607 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1608 <label class=
"md-nav__title" for=
"__nav_6_4">
1609 <span class=
"md-nav__icon md-icon"></span>
1610 Migrating from WSC
3.0
1612 <ul class=
"md-nav__list" data-md-scrollfix
>
1618 <li class=
"md-nav__item">
1619 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1630 <li class=
"md-nav__item">
1631 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1642 <li class=
"md-nav__item">
1643 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1654 <li class=
"md-nav__item">
1655 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1666 <li class=
"md-nav__item">
1667 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1685 <li class=
"md-nav__item md-nav__item--nested">
1688 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1690 <label class=
"md-nav__link" for=
"__nav_6_5">
1691 Migrating from WCF
2.1
1692 <span class=
"md-nav__icon md-icon"></span>
1694 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1695 <label class=
"md-nav__title" for=
"__nav_6_5">
1696 <span class=
"md-nav__icon md-icon"></span>
1697 Migrating from WCF
2.1
1699 <ul class=
"md-nav__list" data-md-scrollfix
>
1705 <li class=
"md-nav__item">
1706 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1717 <li class=
"md-nav__item">
1718 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1729 <li class=
"md-nav__item">
1730 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1741 <li class=
"md-nav__item">
1742 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1769 <li class=
"md-nav__item md-nav__item--nested">
1772 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1774 <label class=
"md-nav__link" for=
"__nav_7">
1776 <span class=
"md-nav__icon md-icon"></span>
1778 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1779 <label class=
"md-nav__title" for=
"__nav_7">
1780 <span class=
"md-nav__icon md-icon"></span>
1783 <ul class=
"md-nav__list" data-md-scrollfix
>
1790 <li class=
"md-nav__item md-nav__item--nested">
1793 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1795 <label class=
"md-nav__link" for=
"__nav_7_1">
1797 <span class=
"md-nav__icon md-icon"></span>
1799 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1800 <label class=
"md-nav__title" for=
"__nav_7_1">
1801 <span class=
"md-nav__icon md-icon"></span>
1804 <ul class=
"md-nav__list" data-md-scrollfix
>
1810 <li class=
"md-nav__item">
1811 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1822 <li class=
"md-nav__item">
1823 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1834 <li class=
"md-nav__item">
1835 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1846 <li class=
"md-nav__item">
1847 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1874 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1875 <div class=
"md-sidebar__scrollwrap">
1876 <div class=
"md-sidebar__inner">
1878 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1890 <div class=
"md-content" data-md-component=
"content">
1891 <article class=
"md-content__inner md-typeset">
1894 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/api/user_activity_points.md" title=
"Edit this page" class=
"md-content__button md-icon">
1895 <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>
1899 <h1 id=
"user-activity-points">User Activity Points
<a class=
"headerlink" href=
"#user-activity-points" title=
"Permanent link">#
</a></h1>
1900 <p>Users get activity points whenever they create content to award them for their contribution.
1901 Activity points are used to determine the rank of a user and can also be used for user conditions, for example for automatic user group assignments.
</p>
1902 <p>To integrate activity points into your package, you have to register an object type for the defintion
<code>com.woltlab.wcf.user.activityPointEvent
</code> and specify a default number of points:
</p>
1903 <div class=
"highlight"><pre><span></span><code><span class=
"nt"><type
></span>
1904 <span class=
"nt"><name
></span>com.example.foo.activityPointEvent.bar
<span class=
"nt"></name
></span>
1905 <span class=
"nt"><definitionname
></span>com.woltlab.wcf.user.activityPointEvent
<span class=
"nt"></definitionname
></span>
1906 <span class=
"nt"><points
></span>10<span class=
"nt"></points
></span>
1907 <span class=
"nt"></type
></span>
1909 <p>The number of points awarded for this type of activity point event can be changed by the administrator in the admin control panel.
1910 For this form and the user activity point list shown in the frontend, you have to provide the language item
</p>
1911 <div class=
"highlight"><pre><span></span><code>wcf.user.activityPoint.objectType.com.example.foo.activityPointEvent.bar
1913 <p>that contains the name of the content for which the activity points are awarded.
</p>
1914 <p>If a relevant object is created, you have to use
<code>UserActivityPointHandler::fireEvent()
</code> which expects the name of the activity point event object type, the id of the object for which the points are awarded (though the object id is not used at the moment) and the user who gets the points:
</p>
1915 <div class=
"highlight"><pre><span></span><code><span class=
"nx">UserActivityPointHandler
</span><span class=
"o">::
</span><span class=
"na">getInstance
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">fireEvent
</span><span class=
"p">(
</span>
1916 <span class=
"s1">'com.example.foo.activityPointEvent.bar
'</span><span class=
"p">,
</span>
1917 <span class=
"nv">$bar
</span><span class=
"o">-
></span><span class=
"na">barID
</span><span class=
"p">,
</span>
1918 <span class=
"nv">$bar
</span><span class=
"o">-
></span><span class=
"na">userID
</span>
1919 <span class=
"p">);
</span>
1921 <p>To remove activity points once objects are deleted, you have to use
<code>UserActivityPointHandler::removeEvents()
</code> which also expects the name of the activity point event object type and additionally an array mapping the id of the user whose activity points will be reduced to the number of objects that are removed for the relevant user:
</p>
1922 <div class=
"highlight"><pre><span></span><code><span class=
"nx">UserActivityPointHandler
</span><span class=
"o">::
</span><span class=
"na">getInstance
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">removeEvents
</span><span class=
"p">(
</span>
1923 <span class=
"s1">'com.example.foo.activityPointEvent.bar
'</span><span class=
"p">,
</span>
1924 <span class=
"p">[
</span>
1925 <span class=
"mi">1</span> <span class=
"o">=
></span> <span class=
"mi">1</span><span class=
"p">,
</span> <span class=
"c1">// remove points for one object for user with id `
1`
</span>
1926 <span class=
"mi">4</span> <span class=
"o">=
></span> <span class=
"mi">2</span> <span class=
"c1">// remove points for two objects for user with id `
4`
</span>
1927 <span class=
"p">]
</span>
1928 <span class=
"p">);
</span>
1935 <div class=
"md-source-date">
1938 Last update:
2021-
01-
08
1957 <footer class=
"md-footer">
1959 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
1961 <a href=
"../package_installation_plugins/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
1962 <div class=
"md-footer__button md-icon">
1963 <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>
1965 <div class=
"md-footer__title">
1966 <div class=
"md-ellipsis">
1967 <span class=
"md-footer__direction">
1970 Package Installation Plugins
1976 <a href=
"../user_notifications/" class=
"md-footer__link md-footer__link--next" rel=
"next">
1977 <div class=
"md-footer__title">
1978 <div class=
"md-ellipsis">
1979 <span class=
"md-footer__direction">
1985 <div class=
"md-footer__button md-icon">
1986 <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>
1992 <div class=
"md-footer-meta md-typeset">
1993 <div class=
"md-footer-meta__inner md-grid">
1994 <div class=
"md-footer-copyright">
1996 <div class=
"md-footer-copyright__highlight">
1997 Copyright ©
2020 WoltLab GmbH
2001 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2006 <div class=
"md-footer-copyright">
2007 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2008 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2015 <div class=
"md-dialog" data-md-component=
"dialog">
2016 <div class=
"md-dialog__inner md-typeset"></div>
2018 <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>
2021 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>