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/php/api/user_activity_points/">
13 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
14 <meta name=
"generator" content=
"mkdocs-1.4.2, mkdocs-material-8.5.10">
18 <title>User Activity Points - WoltLab Suite Documentation
</title>
22 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.472b142f.min.css">
25 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.08040f6c.min.css">
29 <meta name=
"theme-color" content=
"#009485">
40 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
42 <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>
57 <body dir=
"ltr" data-md-color-scheme=
"default" data-md-color-primary=
"teal" data-md-color-accent=
"">
61 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
62 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
63 <label class=
"md-overlay" for=
"__drawer"></label>
64 <div data-md-component=
"skip">
67 <a href=
"#user-activity-points" class=
"md-skip">
72 <div data-md-component=
"announce">
74 <aside class=
"md-banner">
75 <div class=
"md-banner__inner md-grid md-typeset">
78 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
86 <div data-md-component=
"outdated" hidden
>
93 <header class=
"md-header" data-md-component=
"header">
94 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
95 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
97 <img src=
"../../../assets/logo.png" alt=
"logo">
100 <label class=
"md-header__button md-icon" for=
"__drawer">
101 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
103 <div class=
"md-header__title" data-md-component=
"header-title">
104 <div class=
"md-header__ellipsis">
105 <div class=
"md-header__topic">
106 <span class=
"md-ellipsis">
107 WoltLab Suite Documentation
110 <div class=
"md-header__topic" data-md-component=
"header-topic">
111 <span class=
"md-ellipsis">
122 <label class=
"md-header__button md-icon" for=
"__search">
123 <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>
125 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
126 <label class=
"md-search__overlay" for=
"__search"></label>
127 <div class=
"md-search__inner" role=
"search">
128 <form class=
"md-search__form" name=
"search">
129 <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
>
130 <label class=
"md-search__icon md-icon" for=
"__search">
131 <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>
132 <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>
134 <nav class=
"md-search__options" aria-label=
"Search">
136 <button type=
"reset" class=
"md-search__icon md-icon" title=
"Clear" aria-label=
"Clear" tabindex=
"-1">
137 <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>
142 <div class=
"md-search__output">
143 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
144 <div class=
"md-search-result" data-md-component=
"search-result">
145 <div class=
"md-search-result__meta">
148 <ol class=
"md-search-result__list"></ol>
156 <div class=
"md-header__source">
157 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
158 <div class=
"md-source__icon md-icon">
160 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.2.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 2022 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>
162 <div class=
"md-source__repository">
172 <div class=
"md-container" data-md-component=
"container">
179 <main class=
"md-main" data-md-component=
"main">
180 <div class=
"md-main__inner md-grid">
184 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
185 <div class=
"md-sidebar__scrollwrap">
186 <div class=
"md-sidebar__inner">
190 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
191 <label class=
"md-nav__title" for=
"__drawer">
192 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
194 <img src=
"../../../assets/logo.png" alt=
"logo">
197 WoltLab Suite Documentation
200 <div class=
"md-nav__source">
201 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
202 <div class=
"md-source__icon md-icon">
204 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><!--! Font Awesome Free 6.2.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 2022 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>
206 <div class=
"md-source__repository">
212 <ul class=
"md-nav__list" data-md-scrollfix
>
221 <li class=
"md-nav__item">
222 <a href=
"../../../getting-started/" class=
"md-nav__link">
239 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
242 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" checked
>
247 <label class=
"md-nav__link" for=
"__nav_2">
249 <span class=
"md-nav__icon md-icon"></span>
252 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
253 <label class=
"md-nav__title" for=
"__nav_2">
254 <span class=
"md-nav__icon md-icon"></span>
257 <ul class=
"md-nav__list" data-md-scrollfix
>
264 <li class=
"md-nav__item">
265 <a href=
"../../pages/" class=
"md-nav__link">
278 <li class=
"md-nav__item">
279 <a href=
"../../database-objects/" class=
"md-nav__link">
292 <li class=
"md-nav__item">
293 <a href=
"../../database-access/" class=
"md-nav__link">
306 <li class=
"md-nav__item">
307 <a href=
"../../exceptions/" class=
"md-nav__link">
323 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
326 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" checked
>
331 <label class=
"md-nav__link" for=
"__nav_2_5">
333 <span class=
"md-nav__icon md-icon"></span>
336 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
337 <label class=
"md-nav__title" for=
"__nav_2_5">
338 <span class=
"md-nav__icon md-icon"></span>
341 <ul class=
"md-nav__list" data-md-scrollfix
>
349 <li class=
"md-nav__item md-nav__item--nested">
352 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
357 <label class=
"md-nav__link" for=
"__nav_2_5_1">
359 <span class=
"md-nav__icon md-icon"></span>
362 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
363 <label class=
"md-nav__title" for=
"__nav_2_5_1">
364 <span class=
"md-nav__icon md-icon"></span>
367 <ul class=
"md-nav__list" data-md-scrollfix
>
374 <li class=
"md-nav__item">
375 <a href=
"../caches/" class=
"md-nav__link">
388 <li class=
"md-nav__item">
389 <a href=
"../caches_persistent-caches/" class=
"md-nav__link">
402 <li class=
"md-nav__item">
403 <a href=
"../caches_runtime-caches/" class=
"md-nav__link">
423 <li class=
"md-nav__item">
424 <a href=
"../comments/" class=
"md-nav__link">
437 <li class=
"md-nav__item">
438 <a href=
"../cronjobs/" class=
"md-nav__link">
451 <li class=
"md-nav__item">
452 <a href=
"../events/" class=
"md-nav__link">
466 <li class=
"md-nav__item md-nav__item--nested">
469 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
474 <label class=
"md-nav__link" for=
"__nav_2_5_5">
476 <span class=
"md-nav__icon md-icon"></span>
479 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
480 <label class=
"md-nav__title" for=
"__nav_2_5_5">
481 <span class=
"md-nav__icon md-icon"></span>
484 <ul class=
"md-nav__list" data-md-scrollfix
>
491 <li class=
"md-nav__item">
492 <a href=
"../form_builder/overview/" class=
"md-nav__link">
505 <li class=
"md-nav__item">
506 <a href=
"../form_builder/structure/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../form_builder/form_fields/" class=
"md-nav__link">
533 <li class=
"md-nav__item">
534 <a href=
"../form_builder/validation_data/" class=
"md-nav__link">
547 <li class=
"md-nav__item">
548 <a href=
"../form_builder/dependencies/" class=
"md-nav__link">
568 <li class=
"md-nav__item">
569 <a href=
"../package_installation_plugins/" class=
"md-nav__link">
570 Package Installation Plugins
584 <li class=
"md-nav__item md-nav__item--active">
586 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
592 <a href=
"./" class=
"md-nav__link md-nav__link--active">
606 <li class=
"md-nav__item">
607 <a href=
"../user_notifications/" class=
"md-nav__link">
620 <li class=
"md-nav__item">
621 <a href=
"../sitemaps/" class=
"md-nav__link">
641 <li class=
"md-nav__item">
642 <a href=
"../../code-style/" class=
"md-nav__link">
655 <li class=
"md-nav__item">
656 <a href=
"../../apps/" class=
"md-nav__link">
669 <li class=
"md-nav__item">
670 <a href=
"../../gdpr/" class=
"md-nav__link">
692 <li class=
"md-nav__item md-nav__item--nested">
695 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
700 <label class=
"md-nav__link" for=
"__nav_3">
701 Languages, Templates & CSS
702 <span class=
"md-nav__icon md-icon"></span>
705 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
706 <label class=
"md-nav__title" for=
"__nav_3">
707 <span class=
"md-nav__icon md-icon"></span>
708 Languages, Templates & CSS
710 <ul class=
"md-nav__list" data-md-scrollfix
>
717 <li class=
"md-nav__item">
718 <a href=
"../../../view/languages/" class=
"md-nav__link">
731 <li class=
"md-nav__item">
732 <a href=
"../../../view/templates/" class=
"md-nav__link">
745 <li class=
"md-nav__item">
746 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
759 <li class=
"md-nav__item">
760 <a href=
"../../../view/css/" class=
"md-nav__link">
782 <li class=
"md-nav__item md-nav__item--nested">
785 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
790 <label class=
"md-nav__link" for=
"__nav_4">
791 TypeScript and JavaScript API
792 <span class=
"md-nav__icon md-icon"></span>
795 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
796 <label class=
"md-nav__title" for=
"__nav_4">
797 <span class=
"md-nav__icon md-icon"></span>
798 TypeScript and JavaScript API
800 <ul class=
"md-nav__list" data-md-scrollfix
>
807 <li class=
"md-nav__item">
808 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
821 <li class=
"md-nav__item">
822 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
836 <li class=
"md-nav__item md-nav__item--nested">
839 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
844 <label class=
"md-nav__link" for=
"__nav_4_3">
846 <span class=
"md-nav__icon md-icon"></span>
849 <nav class=
"md-nav" aria-label=
"Components" data-md-level=
"2">
850 <label class=
"md-nav__title" for=
"__nav_4_3">
851 <span class=
"md-nav__icon md-icon"></span>
854 <ul class=
"md-nav__list" data-md-scrollfix
>
861 <li class=
"md-nav__item">
862 <a href=
"../../../javascript/components_confirmation/" class=
"md-nav__link">
875 <li class=
"md-nav__item">
876 <a href=
"../../../javascript/components_dialog/" class=
"md-nav__link">
897 <li class=
"md-nav__item md-nav__item--nested">
900 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_4" type=
"checkbox" id=
"__nav_4_4" >
905 <label class=
"md-nav__link" for=
"__nav_4_4">
907 <span class=
"md-nav__icon md-icon"></span>
910 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
911 <label class=
"md-nav__title" for=
"__nav_4_4">
912 <span class=
"md-nav__icon md-icon"></span>
915 <ul class=
"md-nav__list" data-md-scrollfix
>
922 <li class=
"md-nav__item">
923 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
936 <li class=
"md-nav__item">
937 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
950 <li class=
"md-nav__item">
951 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
964 <li class=
"md-nav__item">
965 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
978 <li class=
"md-nav__item">
979 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
992 <li class=
"md-nav__item">
993 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
1006 <li class=
"md-nav__item">
1007 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
1020 <li class=
"md-nav__item">
1021 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
1022 Browser and Screen Sizes
1034 <li class=
"md-nav__item">
1035 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
1055 <li class=
"md-nav__item">
1056 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
1069 <li class=
"md-nav__item">
1070 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
1092 <li class=
"md-nav__item md-nav__item--nested">
1095 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1100 <label class=
"md-nav__link" for=
"__nav_5">
1102 <span class=
"md-nav__icon md-icon"></span>
1105 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1106 <label class=
"md-nav__title" for=
"__nav_5">
1107 <span class=
"md-nav__icon md-icon"></span>
1110 <ul class=
"md-nav__list" data-md-scrollfix
>
1117 <li class=
"md-nav__item">
1118 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
1132 <li class=
"md-nav__item md-nav__item--nested">
1135 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1140 <label class=
"md-nav__link" for=
"__nav_5_2">
1142 <span class=
"md-nav__icon md-icon"></span>
1145 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1146 <label class=
"md-nav__title" for=
"__nav_5_2">
1147 <span class=
"md-nav__icon md-icon"></span>
1150 <ul class=
"md-nav__list" data-md-scrollfix
>
1157 <li class=
"md-nav__item">
1158 <a href=
"../../../package/pip/" class=
"md-nav__link">
1171 <li class=
"md-nav__item">
1172 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
1185 <li class=
"md-nav__item">
1186 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
1199 <li class=
"md-nav__item">
1200 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
1213 <li class=
"md-nav__item">
1214 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1227 <li class=
"md-nav__item">
1228 <a href=
"../../../package/pip/acp-template-delete/" class=
"md-nav__link">
1241 <li class=
"md-nav__item">
1242 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1255 <li class=
"md-nav__item">
1256 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1269 <li class=
"md-nav__item">
1270 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1283 <li class=
"md-nav__item">
1284 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1297 <li class=
"md-nav__item">
1298 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1311 <li class=
"md-nav__item">
1312 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1325 <li class=
"md-nav__item">
1326 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1339 <li class=
"md-nav__item">
1340 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1353 <li class=
"md-nav__item">
1354 <a href=
"../../../package/pip/file-delete/" class=
"md-nav__link">
1367 <li class=
"md-nav__item">
1368 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1381 <li class=
"md-nav__item">
1382 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1395 <li class=
"md-nav__item">
1396 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1409 <li class=
"md-nav__item">
1410 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1423 <li class=
"md-nav__item">
1424 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1437 <li class=
"md-nav__item">
1438 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1439 objectTypeDefinition
1451 <li class=
"md-nav__item">
1452 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1465 <li class=
"md-nav__item">
1466 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1479 <li class=
"md-nav__item">
1480 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1493 <li class=
"md-nav__item">
1494 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1507 <li class=
"md-nav__item">
1508 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1521 <li class=
"md-nav__item">
1522 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1535 <li class=
"md-nav__item">
1536 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1549 <li class=
"md-nav__item">
1550 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1563 <li class=
"md-nav__item">
1564 <a href=
"../../../package/pip/template-delete/" class=
"md-nav__link">
1577 <li class=
"md-nav__item">
1578 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1591 <li class=
"md-nav__item">
1592 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1605 <li class=
"md-nav__item">
1606 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1619 <li class=
"md-nav__item">
1620 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1621 userNotificationEvent
1633 <li class=
"md-nav__item">
1634 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1647 <li class=
"md-nav__item">
1648 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1668 <li class=
"md-nav__item">
1669 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1691 <li class=
"md-nav__item md-nav__item--nested">
1694 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1699 <label class=
"md-nav__link" for=
"__nav_6">
1701 <span class=
"md-nav__icon md-icon"></span>
1704 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1705 <label class=
"md-nav__title" for=
"__nav_6">
1706 <span class=
"md-nav__icon md-icon"></span>
1709 <ul class=
"md-nav__list" data-md-scrollfix
>
1717 <li class=
"md-nav__item md-nav__item--nested">
1720 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1725 <label class=
"md-nav__link" for=
"__nav_6_1">
1726 From WoltLab Suite
5.5
1727 <span class=
"md-nav__icon md-icon"></span>
1730 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 5.5" data-md-level=
"2">
1731 <label class=
"md-nav__title" for=
"__nav_6_1">
1732 <span class=
"md-nav__icon md-icon"></span>
1733 From WoltLab Suite
5.5
1735 <ul class=
"md-nav__list" data-md-scrollfix
>
1742 <li class=
"md-nav__item">
1743 <a href=
"../../../migration/wsc55/php/" class=
"md-nav__link">
1756 <li class=
"md-nav__item">
1757 <a href=
"../../../migration/wsc55/javascript/" class=
"md-nav__link">
1758 TypeScript and JavaScript
1770 <li class=
"md-nav__item">
1771 <a href=
"../../../migration/wsc55/templates/" class=
"md-nav__link">
1784 <li class=
"md-nav__item">
1785 <a href=
"../../../migration/wsc55/icons/" class=
"md-nav__link">
1798 <li class=
"md-nav__item">
1799 <a href=
"../../../migration/wsc55/dialogs/" class=
"md-nav__link">
1812 <li class=
"md-nav__item">
1813 <a href=
"../../../migration/wsc55/libraries/" class=
"md-nav__link">
1814 Third Party Libraries
1826 <li class=
"md-nav__item">
1827 <a href=
"../../../migration/wsc55/deprecations_removals/" class=
"md-nav__link">
1828 Deprecations and Removals
1848 <li class=
"md-nav__item md-nav__item--nested">
1851 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1856 <label class=
"md-nav__link" for=
"__nav_6_2">
1857 From WoltLab Suite
5.4
1858 <span class=
"md-nav__icon md-icon"></span>
1861 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 5.4" data-md-level=
"2">
1862 <label class=
"md-nav__title" for=
"__nav_6_2">
1863 <span class=
"md-nav__icon md-icon"></span>
1864 From WoltLab Suite
5.4
1866 <ul class=
"md-nav__list" data-md-scrollfix
>
1873 <li class=
"md-nav__item">
1874 <a href=
"../../../migration/wsc54/php/" class=
"md-nav__link">
1887 <li class=
"md-nav__item">
1888 <a href=
"../../../migration/wsc54/javascript/" class=
"md-nav__link">
1889 TypeScript and JavaScript
1901 <li class=
"md-nav__item">
1902 <a href=
"../../../migration/wsc54/templates/" class=
"md-nav__link">
1915 <li class=
"md-nav__item">
1916 <a href=
"../../../migration/wsc54/libraries/" class=
"md-nav__link">
1917 Third Party Libraries
1929 <li class=
"md-nav__item">
1930 <a href=
"../../../migration/wsc54/deprecations_removals/" class=
"md-nav__link">
1931 Deprecations and Removals
1951 <li class=
"md-nav__item md-nav__item--nested">
1954 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1959 <label class=
"md-nav__link" for=
"__nav_6_3">
1960 From WoltLab Suite
5.3
1961 <span class=
"md-nav__icon md-icon"></span>
1964 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 5.3" data-md-level=
"2">
1965 <label class=
"md-nav__title" for=
"__nav_6_3">
1966 <span class=
"md-nav__icon md-icon"></span>
1967 From WoltLab Suite
5.3
1969 <ul class=
"md-nav__list" data-md-scrollfix
>
1976 <li class=
"md-nav__item">
1977 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1990 <li class=
"md-nav__item">
1991 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1992 Session Handling and Authentication
2004 <li class=
"md-nav__item">
2005 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
2006 TypeScript and JavaScript
2018 <li class=
"md-nav__item">
2019 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
2032 <li class=
"md-nav__item">
2033 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
2034 Third Party Libraries
2054 <li class=
"md-nav__item md-nav__item--nested">
2057 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
2062 <label class=
"md-nav__link" for=
"__nav_6_4">
2063 From WoltLab Suite
5.2
2064 <span class=
"md-nav__icon md-icon"></span>
2067 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 5.2" data-md-level=
"2">
2068 <label class=
"md-nav__title" for=
"__nav_6_4">
2069 <span class=
"md-nav__icon md-icon"></span>
2070 From WoltLab Suite
5.2
2072 <ul class=
"md-nav__list" data-md-scrollfix
>
2079 <li class=
"md-nav__item">
2080 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
2093 <li class=
"md-nav__item">
2094 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
2095 Templates and Languages
2107 <li class=
"md-nav__item">
2108 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
2109 Third Party Libraries
2129 <li class=
"md-nav__item md-nav__item--nested">
2132 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
2137 <label class=
"md-nav__link" for=
"__nav_6_5">
2138 From WoltLab Suite
3.1
2139 <span class=
"md-nav__icon md-icon"></span>
2142 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 3.1" data-md-level=
"2">
2143 <label class=
"md-nav__title" for=
"__nav_6_5">
2144 <span class=
"md-nav__icon md-icon"></span>
2145 From WoltLab Suite
3.1
2147 <ul class=
"md-nav__list" data-md-scrollfix
>
2154 <li class=
"md-nav__item">
2155 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
2176 <li class=
"md-nav__item md-nav__item--nested">
2179 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_6" type=
"checkbox" id=
"__nav_6_6" >
2184 <label class=
"md-nav__link" for=
"__nav_6_6">
2185 From WoltLab Suite
3.0
2186 <span class=
"md-nav__icon md-icon"></span>
2189 <nav class=
"md-nav" aria-label=
"From WoltLab Suite 3.0" data-md-level=
"2">
2190 <label class=
"md-nav__title" for=
"__nav_6_6">
2191 <span class=
"md-nav__icon md-icon"></span>
2192 From WoltLab Suite
3.0
2194 <ul class=
"md-nav__list" data-md-scrollfix
>
2201 <li class=
"md-nav__item">
2202 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
2215 <li class=
"md-nav__item">
2216 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
2229 <li class=
"md-nav__item">
2230 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
2243 <li class=
"md-nav__item">
2244 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
2257 <li class=
"md-nav__item">
2258 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
2279 <li class=
"md-nav__item md-nav__item--nested">
2282 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_7" type=
"checkbox" id=
"__nav_6_7" >
2287 <label class=
"md-nav__link" for=
"__nav_6_7">
2289 <span class=
"md-nav__icon md-icon"></span>
2292 <nav class=
"md-nav" aria-label=
"From WCF 2.1" data-md-level=
"2">
2293 <label class=
"md-nav__title" for=
"__nav_6_7">
2294 <span class=
"md-nav__icon md-icon"></span>
2297 <ul class=
"md-nav__list" data-md-scrollfix
>
2304 <li class=
"md-nav__item">
2305 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
2318 <li class=
"md-nav__item">
2319 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
2332 <li class=
"md-nav__item">
2333 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
2346 <li class=
"md-nav__item">
2347 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
2376 <li class=
"md-nav__item md-nav__item--nested">
2379 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
2384 <label class=
"md-nav__link" for=
"__nav_7">
2386 <span class=
"md-nav__icon md-icon"></span>
2389 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
2390 <label class=
"md-nav__title" for=
"__nav_7">
2391 <span class=
"md-nav__icon md-icon"></span>
2394 <ul class=
"md-nav__list" data-md-scrollfix
>
2402 <li class=
"md-nav__item md-nav__item--nested">
2405 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
2410 <label class=
"md-nav__link" for=
"__nav_7_1">
2412 <span class=
"md-nav__icon md-icon"></span>
2415 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
2416 <label class=
"md-nav__title" for=
"__nav_7_1">
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=
"../../../tutorial/series/overview/" class=
"md-nav__link">
2441 <li class=
"md-nav__item">
2442 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
2455 <li class=
"md-nav__item">
2456 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
2469 <li class=
"md-nav__item">
2470 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
2483 <li class=
"md-nav__item">
2484 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
2497 <li class=
"md-nav__item">
2498 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
2511 <li class=
"md-nav__item">
2512 <a href=
"../../../tutorial/series/part_6/" class=
"md-nav__link">
2541 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2542 <div class=
"md-sidebar__scrollwrap">
2543 <div class=
"md-sidebar__inner">
2546 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2560 <div class=
"md-content" data-md-component=
"content">
2561 <article class=
"md-content__inner md-typeset">
2565 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/6.0/docs/php/api/user_activity_points.md" title=
"Edit this page" class=
"md-content__button md-icon">
2567 <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>
2571 <h1 id=
"user-activity-points">User Activity Points
<a class=
"headerlink" href=
"#user-activity-points" title=
"Permanent link">#
</a></h1>
2572 <p>Users get activity points whenever they create content to award them for their contribution.
2573 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>
2574 <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>
2575 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2576 <span class=
"normal">2</span>
2577 <span class=
"normal">3</span>
2578 <span class=
"normal">4</span>
2579 <span class=
"normal">5</span></pre></div></td><td class=
"code"><div><pre><span></span><code><span class=
"nt"><type
></span>
2580 <span class=
"nt"><name
></span>com.example.foo.activityPointEvent.bar
<span class=
"nt"></name
></span>
2581 <span class=
"nt"><definitionname
></span>com.woltlab.wcf.user.activityPointEvent
<span class=
"nt"></definitionname
></span>
2582 <span class=
"nt"><points
></span>10<span class=
"nt"></points
></span>
2583 <span class=
"nt"></type
></span>
2584 </code></pre></div></td></tr></table></div>
2585 <p>The number of points awarded for this type of activity point event can be changed by the administrator in the admin control panel.
2586 For this form and the user activity point list shown in the frontend, you have to provide the language item
</p>
2587 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span></pre></div></td><td class=
"code"><div><pre><span></span><code>wcf.user.activityPoint.objectType.com.example.foo.activityPointEvent.bar
2588 </code></pre></div></td></tr></table></div>
2589 <p>that contains the name of the content for which the activity points are awarded.
</p>
2590 <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>
2591 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2592 <span class=
"normal">2</span>
2593 <span class=
"normal">3</span>
2594 <span class=
"normal">4</span>
2595 <span class=
"normal">5</span></pre></div></td><td class=
"code"><div><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>
2596 <span class=
"s1">'com.example.foo.activityPointEvent.bar
'</span><span class=
"p">,
</span>
2597 <span class=
"nv">$bar
</span><span class=
"o">-
></span><span class=
"na">barID
</span><span class=
"p">,
</span>
2598 <span class=
"nv">$bar
</span><span class=
"o">-
></span><span class=
"na">userID
</span>
2599 <span class=
"p">);
</span>
2600 </code></pre></div></td></tr></table></div>
2601 <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>
2602 <div class=
"highlight"><table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2603 <span class=
"normal">2</span>
2604 <span class=
"normal">3</span>
2605 <span class=
"normal">4</span>
2606 <span class=
"normal">5</span>
2607 <span class=
"normal">6</span>
2608 <span class=
"normal">7</span></pre></div></td><td class=
"code"><div><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>
2609 <span class=
"s1">'com.example.foo.activityPointEvent.bar
'</span><span class=
"p">,
</span>
2610 <span class=
"p">[
</span>
2611 <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>
2612 <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>
2613 <span class=
"p">]
</span>
2614 <span class=
"p">);
</span>
2615 </code></pre></div></td></tr></table></div>
2618 <div class=
"md-source-file">
2640 <footer class=
"md-footer">
2643 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer" >
2646 <a href=
"../package_installation_plugins/" class=
"md-footer__link md-footer__link--prev" aria-label=
"Previous: Package Installation Plugins" rel=
"prev">
2647 <div class=
"md-footer__button md-icon">
2648 <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>
2650 <div class=
"md-footer__title">
2651 <div class=
"md-ellipsis">
2652 <span class=
"md-footer__direction">
2655 Package Installation Plugins
2662 <a href=
"../user_notifications/" class=
"md-footer__link md-footer__link--next" aria-label=
"Next: User Notifications" rel=
"next">
2663 <div class=
"md-footer__title">
2664 <div class=
"md-ellipsis">
2665 <span class=
"md-footer__direction">
2671 <div class=
"md-footer__button md-icon">
2672 <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>
2678 <div class=
"md-footer-meta md-typeset">
2679 <div class=
"md-footer-meta__inner md-grid">
2680 <div class=
"md-copyright">
2682 <div class=
"md-copyright__highlight">
2683 Copyright ©
2020 WoltLab GmbH
2688 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2694 <div class=
"md-copyright">
2695 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2696 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2704 <div class=
"md-dialog" data-md-component=
"dialog">
2705 <div class=
"md-dialog__inner md-typeset"></div>
2708 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [
"navigation.tracking"],
"search":
"../../../assets/javascripts/workers/search.16e2a7d4.min.js",
"translations": {
"clipboard.copied":
"Copied to clipboard",
"clipboard.copy":
"Copy to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"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.title":
"Select version"},
"version": {
"provider":
"mike"}}
</script>
2711 <script src=
"../../../assets/javascripts/bundle.d6c3db9e.min.js"></script>