6.0/php/api/user_activity_points/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11         <link rel="canonical" href="https://docs.woltlab.com/6.0/php/api/user_activity_points/">
  12
  13       <link rel="icon" href="../../../assets/default.favicon.ico">
  14       <meta name="generator" content="mkdocs-1.3.1, mkdocs-material-8.5.4">
  15
  16
  17
  18         <title>User Activity Points - WoltLab Suite Documentation</title>
  19
  20
  21
  22       <link rel="stylesheet" href="../../../assets/stylesheets/main.80dcb947.min.css">
  23
  24
  25         <link rel="stylesheet" href="../../../assets/stylesheets/palette.cbb835fc.min.css">
  26
  27
  28
  29           <meta name="theme-color" content="#009485">
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  41
  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>
  43
  44
  45
  46
  47
  48
  49   </head>
  50
  51
  52
  53
  54
  55
  56
  57     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  58
  59
  60
  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">
  65
  66
  67         <a href="#user-activity-points" class="md-skip">
  68           Skip to content
  69         </a>
  70
  71     </div>
  72     <div data-md-component="announce">
  73
  74         <aside class="md-banner">
  75           <div class="md-banner__inner md-grid md-typeset">
  76
  77
  78     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  79
  80           </div>
  81
  82         </aside>
  83
  84     </div>
  85
  86       <div data-md-component="outdated" hidden>
  87
  88       </div>
  89
  90
  91
  92
  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">
  96
  97   <img src="../../../assets/logo.png" alt="logo">
  98
  99     </a>
 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>
 102     </label>
 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
 108           </span>
 109         </div>
 110         <div class="md-header__topic" data-md-component="header-topic">
 111           <span class="md-ellipsis">
 112
 113               User Activity Points
 114
 115           </span>
 116         </div>
 117       </div>
 118     </div>
 119
 120
 121
 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>
 124       </label>
 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>
 133       </label>
 134       <nav class="md-search__options" aria-label="Search">
 135
 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>
 138         </button>
 139       </nav>
 140
 141     </form>
 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">
 146             Initializing search
 147           </div>
 148           <ol class="md-search-result__list"></ol>
 149         </div>
 150       </div>
 151     </div>
 152   </div>
 153 </div>
 154
 155
 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">
 159
 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>
 161   </div>
 162   <div class="md-source__repository">
 163     GitHub
 164   </div>
 165 </a>
 166       </div>
 167
 168   </nav>
 169
 170 </header>
 171
 172     <div class="md-container" data-md-component="container">
 173
 174
 175
 176
 177
 178
 179       <main class="md-main" data-md-component="main">
 180         <div class="md-main__inner md-grid">
 181
 182
 183
 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">
 187
 188
 189
 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">
 193
 194   <img src="../../../assets/logo.png" alt="logo">
 195
 196     </a>
 197     WoltLab Suite Documentation
 198   </label>
 199
 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">
 203
 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>
 205   </div>
 206   <div class="md-source__repository">
 207     GitHub
 208   </div>
 209 </a>
 210     </div>
 211
 212   <ul class="md-nav__list" data-md-scrollfix>
 213
 214
 215
 216
 217
 218
 219
 220
 221     <li class="md-nav__item">
 222       <a href="../../../getting-started/" class="md-nav__link">
 223         Getting Started
 224       </a>
 225     </li>
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 240
 241
 242         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
 243
 244
 245
 246
 247         <label class="md-nav__link" for="__nav_2">
 248           PHP API
 249           <span class="md-nav__icon md-icon"></span>
 250         </label>
 251
 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>
 255           PHP API
 256         </label>
 257         <ul class="md-nav__list" data-md-scrollfix>
 258
 259
 260
 261
 262
 263
 264     <li class="md-nav__item">
 265       <a href="../../pages/" class="md-nav__link">
 266         Pages
 267       </a>
 268     </li>
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278     <li class="md-nav__item">
 279       <a href="../../database-objects/" class="md-nav__link">
 280         Database Objects
 281       </a>
 282     </li>
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292     <li class="md-nav__item">
 293       <a href="../../database-access/" class="md-nav__link">
 294         Database Access
 295       </a>
 296     </li>
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306     <li class="md-nav__item">
 307       <a href="../../exceptions/" class="md-nav__link">
 308         Exceptions
 309       </a>
 310     </li>
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 324
 325
 326         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" checked>
 327
 328
 329
 330
 331         <label class="md-nav__link" for="__nav_2_5">
 332           API
 333           <span class="md-nav__icon md-icon"></span>
 334         </label>
 335
 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>
 339           API
 340         </label>
 341         <ul class="md-nav__list" data-md-scrollfix>
 342
 343
 344
 345
 346
 347
 348
 349     <li class="md-nav__item md-nav__item--nested">
 350
 351
 352         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 353
 354
 355
 356
 357         <label class="md-nav__link" for="__nav_2_5_1">
 358           Caches
 359           <span class="md-nav__icon md-icon"></span>
 360         </label>
 361
 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>
 365           Caches
 366         </label>
 367         <ul class="md-nav__list" data-md-scrollfix>
 368
 369
 370
 371
 372
 373
 374     <li class="md-nav__item">
 375       <a href="../caches/" class="md-nav__link">
 376         Overview
 377       </a>
 378     </li>
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388     <li class="md-nav__item">
 389       <a href="../caches_persistent-caches/" class="md-nav__link">
 390         Persistent Caches
 391       </a>
 392     </li>
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../caches_runtime-caches/" class="md-nav__link">
 404         Runtime Caches
 405       </a>
 406     </li>
 407
 408
 409
 410
 411         </ul>
 412       </nav>
 413     </li>
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423     <li class="md-nav__item">
 424       <a href="../comments/" class="md-nav__link">
 425         Comments
 426       </a>
 427     </li>
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437     <li class="md-nav__item">
 438       <a href="../cronjobs/" class="md-nav__link">
 439         Cronjobs
 440       </a>
 441     </li>
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451     <li class="md-nav__item">
 452       <a href="../events/" class="md-nav__link">
 453         Events
 454       </a>
 455     </li>
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466     <li class="md-nav__item md-nav__item--nested">
 467
 468
 469         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 470
 471
 472
 473
 474         <label class="md-nav__link" for="__nav_2_5_5">
 475           Form Builder
 476           <span class="md-nav__icon md-icon"></span>
 477         </label>
 478
 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>
 482           Form Builder
 483         </label>
 484         <ul class="md-nav__list" data-md-scrollfix>
 485
 486
 487
 488
 489
 490
 491     <li class="md-nav__item">
 492       <a href="../form_builder/overview/" class="md-nav__link">
 493         Overview
 494       </a>
 495     </li>
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505     <li class="md-nav__item">
 506       <a href="../form_builder/structure/" class="md-nav__link">
 507         Structure
 508       </a>
 509     </li>
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519     <li class="md-nav__item">
 520       <a href="../form_builder/form_fields/" class="md-nav__link">
 521         Fields
 522       </a>
 523     </li>
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533     <li class="md-nav__item">
 534       <a href="../form_builder/validation_data/" class="md-nav__link">
 535         Validation and Data
 536       </a>
 537     </li>
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547     <li class="md-nav__item">
 548       <a href="../form_builder/dependencies/" class="md-nav__link">
 549         Dependencies
 550       </a>
 551     </li>
 552
 553
 554
 555
 556         </ul>
 557       </nav>
 558     </li>
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568     <li class="md-nav__item">
 569       <a href="../package_installation_plugins/" class="md-nav__link">
 570         Package Installation Plugins
 571       </a>
 572     </li>
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584     <li class="md-nav__item md-nav__item--active">
 585
 586       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 587
 588
 589
 590
 591
 592       <a href="./" class="md-nav__link md-nav__link--active">
 593         User Activity Points
 594       </a>
 595
 596     </li>
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606     <li class="md-nav__item">
 607       <a href="../user_notifications/" class="md-nav__link">
 608         User Notifications
 609       </a>
 610     </li>
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620     <li class="md-nav__item">
 621       <a href="../sitemaps/" class="md-nav__link">
 622         Sitemaps
 623       </a>
 624     </li>
 625
 626
 627
 628
 629         </ul>
 630       </nav>
 631     </li>
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641     <li class="md-nav__item">
 642       <a href="../../code-style/" class="md-nav__link">
 643         Code Style
 644       </a>
 645     </li>
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655     <li class="md-nav__item">
 656       <a href="../../apps/" class="md-nav__link">
 657         Apps
 658       </a>
 659     </li>
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669     <li class="md-nav__item">
 670       <a href="../../gdpr/" class="md-nav__link">
 671         GDPR
 672       </a>
 673     </li>
 674
 675
 676
 677
 678         </ul>
 679       </nav>
 680     </li>
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692     <li class="md-nav__item md-nav__item--nested">
 693
 694
 695         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 696
 697
 698
 699
 700         <label class="md-nav__link" for="__nav_3">
 701           Languages, Templates & CSS
 702           <span class="md-nav__icon md-icon"></span>
 703         </label>
 704
 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
 709         </label>
 710         <ul class="md-nav__list" data-md-scrollfix>
 711
 712
 713
 714
 715
 716
 717     <li class="md-nav__item">
 718       <a href="../../../view/languages/" class="md-nav__link">
 719         Languages
 720       </a>
 721     </li>
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731     <li class="md-nav__item">
 732       <a href="../../../view/templates/" class="md-nav__link">
 733         Templates
 734       </a>
 735     </li>
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745     <li class="md-nav__item">
 746       <a href="../../../view/template-plugins/" class="md-nav__link">
 747         Template Plugins
 748       </a>
 749     </li>
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759     <li class="md-nav__item">
 760       <a href="../../../view/css/" class="md-nav__link">
 761         CSS
 762       </a>
 763     </li>
 764
 765
 766
 767
 768         </ul>
 769       </nav>
 770     </li>
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782     <li class="md-nav__item md-nav__item--nested">
 783
 784
 785         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 786
 787
 788
 789
 790         <label class="md-nav__link" for="__nav_4">
 791           TypeScript and JavaScript API
 792           <span class="md-nav__icon md-icon"></span>
 793         </label>
 794
 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
 799         </label>
 800         <ul class="md-nav__list" data-md-scrollfix>
 801
 802
 803
 804
 805
 806
 807     <li class="md-nav__item">
 808       <a href="../../../javascript/general-usage/" class="md-nav__link">
 809         General Usage
 810       </a>
 811     </li>
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821     <li class="md-nav__item">
 822       <a href="../../../javascript/typescript/" class="md-nav__link">
 823         TypeScript
 824       </a>
 825     </li>
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836     <li class="md-nav__item md-nav__item--nested">
 837
 838
 839         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 840
 841
 842
 843
 844         <label class="md-nav__link" for="__nav_4_3">
 845           New API
 846           <span class="md-nav__icon md-icon"></span>
 847         </label>
 848
 849       <nav class="md-nav" aria-label="New API" data-md-level="2">
 850         <label class="md-nav__title" for="__nav_4_3">
 851           <span class="md-nav__icon md-icon"></span>
 852           New API
 853         </label>
 854         <ul class="md-nav__list" data-md-scrollfix>
 855
 856
 857
 858
 859
 860
 861     <li class="md-nav__item">
 862       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 863         Writing a module
 864       </a>
 865     </li>
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875     <li class="md-nav__item">
 876       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 877         Data Structures
 878       </a>
 879     </li>
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889     <li class="md-nav__item">
 890       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 891         Core Functions
 892       </a>
 893     </li>
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903     <li class="md-nav__item">
 904       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 905         DOM
 906       </a>
 907     </li>
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917     <li class="md-nav__item">
 918       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 919         Event Handling
 920       </a>
 921     </li>
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931     <li class="md-nav__item">
 932       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 933         Ajax
 934       </a>
 935     </li>
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945     <li class="md-nav__item">
 946       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 947         Dialogs
 948       </a>
 949     </li>
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959     <li class="md-nav__item">
 960       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 961         Browser and Screen Sizes
 962       </a>
 963     </li>
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973     <li class="md-nav__item">
 974       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 975         User Interface
 976       </a>
 977     </li>
 978
 979
 980
 981
 982         </ul>
 983       </nav>
 984     </li>
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994     <li class="md-nav__item">
 995       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 996         Legacy API
 997       </a>
 998     </li>
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008     <li class="md-nav__item">
1009       <a href="../../../javascript/helper-functions/" class="md-nav__link">
1010         Helper Functions
1011       </a>
1012     </li>
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022     <li class="md-nav__item">
1023       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1024         Code Snippets
1025       </a>
1026     </li>
1027
1028
1029
1030
1031         </ul>
1032       </nav>
1033     </li>
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045     <li class="md-nav__item md-nav__item--nested">
1046
1047
1048         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
1049
1050
1051
1052
1053         <label class="md-nav__link" for="__nav_5">
1054           Package Components
1055           <span class="md-nav__icon md-icon"></span>
1056         </label>
1057
1058       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
1059         <label class="md-nav__title" for="__nav_5">
1060           <span class="md-nav__icon md-icon"></span>
1061           Package Components
1062         </label>
1063         <ul class="md-nav__list" data-md-scrollfix>
1064
1065
1066
1067
1068
1069
1070     <li class="md-nav__item">
1071       <a href="../../../package/package-xml/" class="md-nav__link">
1072         package.xml
1073       </a>
1074     </li>
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085     <li class="md-nav__item md-nav__item--nested">
1086
1087
1088         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1089
1090
1091
1092
1093         <label class="md-nav__link" for="__nav_5_2">
1094           PIPs
1095           <span class="md-nav__icon md-icon"></span>
1096         </label>
1097
1098       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1099         <label class="md-nav__title" for="__nav_5_2">
1100           <span class="md-nav__icon md-icon"></span>
1101           PIPs
1102         </label>
1103         <ul class="md-nav__list" data-md-scrollfix>
1104
1105
1106
1107
1108
1109
1110     <li class="md-nav__item">
1111       <a href="../../../package/pip/" class="md-nav__link">
1112         Overview
1113       </a>
1114     </li>
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124     <li class="md-nav__item">
1125       <a href="../../../package/pip/acl-option/" class="md-nav__link">
1126         aclOption
1127       </a>
1128     </li>
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138     <li class="md-nav__item">
1139       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
1140         acpMenu
1141       </a>
1142     </li>
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152     <li class="md-nav__item">
1153       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
1154         acpSearchProvider
1155       </a>
1156     </li>
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166     <li class="md-nav__item">
1167       <a href="../../../package/pip/acp-template/" class="md-nav__link">
1168         acpTemplate
1169       </a>
1170     </li>
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180     <li class="md-nav__item">
1181       <a href="../../../package/pip/acp-template-delete/" class="md-nav__link">
1182         acpTemplateDelete
1183       </a>
1184     </li>
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194     <li class="md-nav__item">
1195       <a href="../../../package/pip/bbcode/" class="md-nav__link">
1196         bbcode
1197       </a>
1198     </li>
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208     <li class="md-nav__item">
1209       <a href="../../../package/pip/box/" class="md-nav__link">
1210         box
1211       </a>
1212     </li>
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222     <li class="md-nav__item">
1223       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1224         clipboardAction
1225       </a>
1226     </li>
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236     <li class="md-nav__item">
1237       <a href="../../../package/pip/core-object/" class="md-nav__link">
1238         coreObject
1239       </a>
1240     </li>
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250     <li class="md-nav__item">
1251       <a href="../../../package/pip/cronjob/" class="md-nav__link">
1252         cronjob
1253       </a>
1254     </li>
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264     <li class="md-nav__item">
1265       <a href="../../../package/pip/database/" class="md-nav__link">
1266         database
1267       </a>
1268     </li>
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278     <li class="md-nav__item">
1279       <a href="../../../package/pip/event-listener/" class="md-nav__link">
1280         eventListener
1281       </a>
1282     </li>
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292     <li class="md-nav__item">
1293       <a href="../../../package/pip/file/" class="md-nav__link">
1294         file
1295       </a>
1296     </li>
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306     <li class="md-nav__item">
1307       <a href="../../../package/pip/file-delete/" class="md-nav__link">
1308         fileDelete
1309       </a>
1310     </li>
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320     <li class="md-nav__item">
1321       <a href="../../../package/pip/language/" class="md-nav__link">
1322         language
1323       </a>
1324     </li>
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334     <li class="md-nav__item">
1335       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1336         mediaProvider
1337       </a>
1338     </li>
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348     <li class="md-nav__item">
1349       <a href="../../../package/pip/menu/" class="md-nav__link">
1350         menu
1351       </a>
1352     </li>
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362     <li class="md-nav__item">
1363       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1364         menuItem
1365       </a>
1366     </li>
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376     <li class="md-nav__item">
1377       <a href="../../../package/pip/object-type/" class="md-nav__link">
1378         objectType
1379       </a>
1380     </li>
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390     <li class="md-nav__item">
1391       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1392         objectTypeDefinition
1393       </a>
1394     </li>
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404     <li class="md-nav__item">
1405       <a href="../../../package/pip/option/" class="md-nav__link">
1406         option
1407       </a>
1408     </li>
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418     <li class="md-nav__item">
1419       <a href="../../../package/pip/page/" class="md-nav__link">
1420         page
1421       </a>
1422     </li>
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432     <li class="md-nav__item">
1433       <a href="../../../package/pip/pip/" class="md-nav__link">
1434         pip
1435       </a>
1436     </li>
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446     <li class="md-nav__item">
1447       <a href="../../../package/pip/script/" class="md-nav__link">
1448         script
1449       </a>
1450     </li>
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460     <li class="md-nav__item">
1461       <a href="../../../package/pip/smiley/" class="md-nav__link">
1462         smiley
1463       </a>
1464     </li>
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474     <li class="md-nav__item">
1475       <a href="../../../package/pip/sql/" class="md-nav__link">
1476         sql
1477       </a>
1478     </li>
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488     <li class="md-nav__item">
1489       <a href="../../../package/pip/style/" class="md-nav__link">
1490         style
1491       </a>
1492     </li>
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502     <li class="md-nav__item">
1503       <a href="../../../package/pip/template/" class="md-nav__link">
1504         template
1505       </a>
1506     </li>
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516     <li class="md-nav__item">
1517       <a href="../../../package/pip/template-delete/" class="md-nav__link">
1518         templateDelete
1519       </a>
1520     </li>
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530     <li class="md-nav__item">
1531       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1532         templateListener
1533       </a>
1534     </li>
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544     <li class="md-nav__item">
1545       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1546         userGroupOption
1547       </a>
1548     </li>
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558     <li class="md-nav__item">
1559       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1560         userMenu
1561       </a>
1562     </li>
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572     <li class="md-nav__item">
1573       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1574         userNotificationEvent
1575       </a>
1576     </li>
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586     <li class="md-nav__item">
1587       <a href="../../../package/pip/user-option/" class="md-nav__link">
1588         userOption
1589       </a>
1590     </li>
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600     <li class="md-nav__item">
1601       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1602         userProfileMenu
1603       </a>
1604     </li>
1605
1606
1607
1608
1609         </ul>
1610       </nav>
1611     </li>
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621     <li class="md-nav__item">
1622       <a href="../../../package/database-php-api/" class="md-nav__link">
1623         Database PHP API
1624       </a>
1625     </li>
1626
1627
1628
1629
1630         </ul>
1631       </nav>
1632     </li>
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644     <li class="md-nav__item md-nav__item--nested">
1645
1646
1647         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1648
1649
1650
1651
1652         <label class="md-nav__link" for="__nav_6">
1653           Migration
1654           <span class="md-nav__icon md-icon"></span>
1655         </label>
1656
1657       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1658         <label class="md-nav__title" for="__nav_6">
1659           <span class="md-nav__icon md-icon"></span>
1660           Migration
1661         </label>
1662         <ul class="md-nav__list" data-md-scrollfix>
1663
1664
1665
1666
1667
1668
1669
1670     <li class="md-nav__item md-nav__item--nested">
1671
1672
1673         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1674
1675
1676
1677
1678         <label class="md-nav__link" for="__nav_6_1">
1679           From WoltLab Suite 5.5
1680           <span class="md-nav__icon md-icon"></span>
1681         </label>
1682
1683       <nav class="md-nav" aria-label="From WoltLab Suite 5.5" data-md-level="2">
1684         <label class="md-nav__title" for="__nav_6_1">
1685           <span class="md-nav__icon md-icon"></span>
1686           From WoltLab Suite 5.5
1687         </label>
1688         <ul class="md-nav__list" data-md-scrollfix>
1689
1690
1691
1692
1693
1694
1695     <li class="md-nav__item">
1696       <a href="../../../migration/wsc55/php/" class="md-nav__link">
1697         PHP API
1698       </a>
1699     </li>
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709     <li class="md-nav__item">
1710       <a href="../../../migration/wsc55/javascript/" class="md-nav__link">
1711         TypeScript and JavaScript
1712       </a>
1713     </li>
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723     <li class="md-nav__item">
1724       <a href="../../../migration/wsc55/templates/" class="md-nav__link">
1725         Templates
1726       </a>
1727     </li>
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737     <li class="md-nav__item">
1738       <a href="../../../migration/wsc55/libraries/" class="md-nav__link">
1739         Third Party Libraries
1740       </a>
1741     </li>
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751     <li class="md-nav__item">
1752       <a href="../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1753         Deprecations and Removals
1754       </a>
1755     </li>
1756
1757
1758
1759
1760         </ul>
1761       </nav>
1762     </li>
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773     <li class="md-nav__item md-nav__item--nested">
1774
1775
1776         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1777
1778
1779
1780
1781         <label class="md-nav__link" for="__nav_6_2">
1782           From WoltLab Suite 5.4
1783           <span class="md-nav__icon md-icon"></span>
1784         </label>
1785
1786       <nav class="md-nav" aria-label="From WoltLab Suite 5.4" data-md-level="2">
1787         <label class="md-nav__title" for="__nav_6_2">
1788           <span class="md-nav__icon md-icon"></span>
1789           From WoltLab Suite 5.4
1790         </label>
1791         <ul class="md-nav__list" data-md-scrollfix>
1792
1793
1794
1795
1796
1797
1798     <li class="md-nav__item">
1799       <a href="../../../migration/wsc54/php/" class="md-nav__link">
1800         PHP API
1801       </a>
1802     </li>
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812     <li class="md-nav__item">
1813       <a href="../../../migration/wsc54/javascript/" class="md-nav__link">
1814         TypeScript and JavaScript
1815       </a>
1816     </li>
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826     <li class="md-nav__item">
1827       <a href="../../../migration/wsc54/templates/" class="md-nav__link">
1828         Templates
1829       </a>
1830     </li>
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840     <li class="md-nav__item">
1841       <a href="../../../migration/wsc54/libraries/" class="md-nav__link">
1842         Third Party Libraries
1843       </a>
1844     </li>
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854     <li class="md-nav__item">
1855       <a href="../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
1856         Deprecations and Removals
1857       </a>
1858     </li>
1859
1860
1861
1862
1863         </ul>
1864       </nav>
1865     </li>
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876     <li class="md-nav__item md-nav__item--nested">
1877
1878
1879         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1880
1881
1882
1883
1884         <label class="md-nav__link" for="__nav_6_3">
1885           From WoltLab Suite 5.3
1886           <span class="md-nav__icon md-icon"></span>
1887         </label>
1888
1889       <nav class="md-nav" aria-label="From WoltLab Suite 5.3" data-md-level="2">
1890         <label class="md-nav__title" for="__nav_6_3">
1891           <span class="md-nav__icon md-icon"></span>
1892           From WoltLab Suite 5.3
1893         </label>
1894         <ul class="md-nav__list" data-md-scrollfix>
1895
1896
1897
1898
1899
1900
1901     <li class="md-nav__item">
1902       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1903         PHP API
1904       </a>
1905     </li>
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915     <li class="md-nav__item">
1916       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1917         Session Handling and Authentication
1918       </a>
1919     </li>
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929     <li class="md-nav__item">
1930       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1931         TypeScript and JavaScript
1932       </a>
1933     </li>
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943     <li class="md-nav__item">
1944       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1945         Templates
1946       </a>
1947     </li>
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957     <li class="md-nav__item">
1958       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1959         Third Party Libraries
1960       </a>
1961     </li>
1962
1963
1964
1965
1966         </ul>
1967       </nav>
1968     </li>
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979     <li class="md-nav__item md-nav__item--nested">
1980
1981
1982         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1983
1984
1985
1986
1987         <label class="md-nav__link" for="__nav_6_4">
1988           From WoltLab Suite 5.2
1989           <span class="md-nav__icon md-icon"></span>
1990         </label>
1991
1992       <nav class="md-nav" aria-label="From WoltLab Suite 5.2" data-md-level="2">
1993         <label class="md-nav__title" for="__nav_6_4">
1994           <span class="md-nav__icon md-icon"></span>
1995           From WoltLab Suite 5.2
1996         </label>
1997         <ul class="md-nav__list" data-md-scrollfix>
1998
1999
2000
2001
2002
2003
2004     <li class="md-nav__item">
2005       <a href="../../../migration/wsc52/php/" class="md-nav__link">
2006         PHP API
2007       </a>
2008     </li>
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018     <li class="md-nav__item">
2019       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
2020         Templates and Languages
2021       </a>
2022     </li>
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032     <li class="md-nav__item">
2033       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
2034         Third Party Libraries
2035       </a>
2036     </li>
2037
2038
2039
2040
2041         </ul>
2042       </nav>
2043     </li>
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054     <li class="md-nav__item md-nav__item--nested">
2055
2056
2057         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
2058
2059
2060
2061
2062         <label class="md-nav__link" for="__nav_6_5">
2063           From WoltLab Suite 3.1
2064           <span class="md-nav__icon md-icon"></span>
2065         </label>
2066
2067       <nav class="md-nav" aria-label="From WoltLab Suite 3.1" data-md-level="2">
2068         <label class="md-nav__title" for="__nav_6_5">
2069           <span class="md-nav__icon md-icon"></span>
2070           From WoltLab Suite 3.1
2071         </label>
2072         <ul class="md-nav__list" data-md-scrollfix>
2073
2074
2075
2076
2077
2078
2079     <li class="md-nav__item">
2080       <a href="../../../migration/wsc31/php/" class="md-nav__link">
2081         PHP API
2082       </a>
2083     </li>
2084
2085
2086
2087
2088         </ul>
2089       </nav>
2090     </li>
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101     <li class="md-nav__item md-nav__item--nested">
2102
2103
2104         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_6" type="checkbox" id="__nav_6_6" >
2105
2106
2107
2108
2109         <label class="md-nav__link" for="__nav_6_6">
2110           From WoltLab Suite 3.0
2111           <span class="md-nav__icon md-icon"></span>
2112         </label>
2113
2114       <nav class="md-nav" aria-label="From WoltLab Suite 3.0" data-md-level="2">
2115         <label class="md-nav__title" for="__nav_6_6">
2116           <span class="md-nav__icon md-icon"></span>
2117           From WoltLab Suite 3.0
2118         </label>
2119         <ul class="md-nav__list" data-md-scrollfix>
2120
2121
2122
2123
2124
2125
2126     <li class="md-nav__item">
2127       <a href="../../../migration/wsc30/php/" class="md-nav__link">
2128         PHP API
2129       </a>
2130     </li>
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140     <li class="md-nav__item">
2141       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
2142         JavaScript API
2143       </a>
2144     </li>
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154     <li class="md-nav__item">
2155       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
2156         Templates
2157       </a>
2158     </li>
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168     <li class="md-nav__item">
2169       <a href="../../../migration/wsc30/css/" class="md-nav__link">
2170         CSS
2171       </a>
2172     </li>
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182     <li class="md-nav__item">
2183       <a href="../../../migration/wsc30/package/" class="md-nav__link">
2184         Package Components
2185       </a>
2186     </li>
2187
2188
2189
2190
2191         </ul>
2192       </nav>
2193     </li>
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204     <li class="md-nav__item md-nav__item--nested">
2205
2206
2207         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_7" type="checkbox" id="__nav_6_7" >
2208
2209
2210
2211
2212         <label class="md-nav__link" for="__nav_6_7">
2213           From WCF 2.1
2214           <span class="md-nav__icon md-icon"></span>
2215         </label>
2216
2217       <nav class="md-nav" aria-label="From WCF 2.1" data-md-level="2">
2218         <label class="md-nav__title" for="__nav_6_7">
2219           <span class="md-nav__icon md-icon"></span>
2220           From WCF 2.1
2221         </label>
2222         <ul class="md-nav__list" data-md-scrollfix>
2223
2224
2225
2226
2227
2228
2229     <li class="md-nav__item">
2230       <a href="../../../migration/wcf21/php/" class="md-nav__link">
2231         PHP API
2232       </a>
2233     </li>
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243     <li class="md-nav__item">
2244       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
2245         Templates
2246       </a>
2247     </li>
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257     <li class="md-nav__item">
2258       <a href="../../../migration/wcf21/css/" class="md-nav__link">
2259         CSS
2260       </a>
2261     </li>
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271     <li class="md-nav__item">
2272       <a href="../../../migration/wcf21/package/" class="md-nav__link">
2273         Package Components
2274       </a>
2275     </li>
2276
2277
2278
2279
2280         </ul>
2281       </nav>
2282     </li>
2283
2284
2285
2286
2287         </ul>
2288       </nav>
2289     </li>
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301     <li class="md-nav__item md-nav__item--nested">
2302
2303
2304         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
2305
2306
2307
2308
2309         <label class="md-nav__link" for="__nav_7">
2310           Tutorials
2311           <span class="md-nav__icon md-icon"></span>
2312         </label>
2313
2314       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
2315         <label class="md-nav__title" for="__nav_7">
2316           <span class="md-nav__icon md-icon"></span>
2317           Tutorials
2318         </label>
2319         <ul class="md-nav__list" data-md-scrollfix>
2320
2321
2322
2323
2324
2325
2326
2327     <li class="md-nav__item md-nav__item--nested">
2328
2329
2330         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
2331
2332
2333
2334
2335         <label class="md-nav__link" for="__nav_7_1">
2336           Tutorial Series
2337           <span class="md-nav__icon md-icon"></span>
2338         </label>
2339
2340       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
2341         <label class="md-nav__title" for="__nav_7_1">
2342           <span class="md-nav__icon md-icon"></span>
2343           Tutorial Series
2344         </label>
2345         <ul class="md-nav__list" data-md-scrollfix>
2346
2347
2348
2349
2350
2351
2352     <li class="md-nav__item">
2353       <a href="../../../tutorial/series/overview/" class="md-nav__link">
2354         Overview
2355       </a>
2356     </li>
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366     <li class="md-nav__item">
2367       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2368         Part 1
2369       </a>
2370     </li>
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380     <li class="md-nav__item">
2381       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2382         Part 2
2383       </a>
2384     </li>
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394     <li class="md-nav__item">
2395       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2396         Part 3
2397       </a>
2398     </li>
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408     <li class="md-nav__item">
2409       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2410         Part 4
2411       </a>
2412     </li>
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422     <li class="md-nav__item">
2423       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2424         Part 5
2425       </a>
2426     </li>
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436     <li class="md-nav__item">
2437       <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2438         Part 6
2439       </a>
2440     </li>
2441
2442
2443
2444
2445         </ul>
2446       </nav>
2447     </li>
2448
2449
2450
2451
2452         </ul>
2453       </nav>
2454     </li>
2455
2456
2457
2458   </ul>
2459 </nav>
2460                   </div>
2461                 </div>
2462               </div>
2463
2464
2465
2466               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2467                 <div class="md-sidebar__scrollwrap">
2468                   <div class="md-sidebar__inner">
2469
2470
2471 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2472
2473
2474
2475
2476
2477
2478 </nav>
2479                   </div>
2480                 </div>
2481               </div>
2482
2483
2484
2485             <div class="md-content" data-md-component="content">
2486               <article class="md-content__inner md-typeset">
2487
2488
2489
2490   <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">
2491
2492     <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>
2493   </a>
2494
2495
2496 <h1 id="user-activity-points">User Activity Points<a class="headerlink" href="#user-activity-points" title="Permanent link">#</a></h1>
2497 <p>Users get activity points whenever they create content to award them for their contribution.
2498 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>
2499 <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>
2500 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2501 <span class="normal">2</span>
2502 <span class="normal">3</span>
2503 <span class="normal">4</span>
2504 <span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nt">&lt;type&gt;</span>
2505     <span class="nt">&lt;name&gt;</span>com.example.foo.activityPointEvent.bar<span class="nt">&lt;/name&gt;</span>
2506     <span class="nt">&lt;definitionname&gt;</span>com.woltlab.wcf.user.activityPointEvent<span class="nt">&lt;/definitionname&gt;</span>
2507     <span class="nt">&lt;points&gt;</span>10<span class="nt">&lt;/points&gt;</span>
2508 <span class="nt">&lt;/type&gt;</span>
2509 </code></pre></div></td></tr></table></div>
2510 <p>The number of points awarded for this type of activity point event can be changed by the administrator in the admin control panel.
2511 For this form and the user activity point list shown in the frontend, you have to provide the language item</p>
2512 <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
2513 </code></pre></div></td></tr></table></div>
2514 <p>that contains the name of the content for which the activity points are awarded.</p>
2515 <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>
2516 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2517 <span class="normal">2</span>
2518 <span class="normal">3</span>
2519 <span class="normal">4</span>
2520 <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">-&gt;</span><span class="na">fireEvent</span><span class="p">(</span>
2521         <span class="s1">&#39;com.example.foo.activityPointEvent.bar&#39;</span><span class="p">,</span>
2522         <span class="nv">$bar</span><span class="o">-&gt;</span><span class="na">barID</span><span class="p">,</span>
2523         <span class="nv">$bar</span><span class="o">-&gt;</span><span class="na">userID</span>
2524 <span class="p">);</span>
2525 </code></pre></div></td></tr></table></div>
2526 <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>
2527 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2528 <span class="normal">2</span>
2529 <span class="normal">3</span>
2530 <span class="normal">4</span>
2531 <span class="normal">5</span>
2532 <span class="normal">6</span>
2533 <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">-&gt;</span><span class="na">removeEvents</span><span class="p">(</span>
2534         <span class="s1">&#39;com.example.foo.activityPointEvent.bar&#39;</span><span class="p">,</span>
2535        <span class="p">[</span>
2536                 <span class="mi">1</span> <span class="o">=&gt;</span> <span class="mi">1</span><span class="p">,</span> <span class="c1">// remove points for one object for user with id `1`</span>
2537                 <span class="mi">4</span> <span class="o">=&gt;</span> <span class="mi">2</span>  <span class="c1">// remove points for two objects for user with id `4`</span>
2538         <span class="p">]</span>
2539 <span class="p">);</span>
2540 </code></pre></div></td></tr></table></div>
2541
2542   <hr>
2543 <div class="md-source-file">
2544   <small>
2545
2546       Last update:
2547       2021-01-08
2548
2549   </small>
2550 </div>
2551
2552
2553
2554
2555
2556
2557               </article>
2558             </div>
2559
2560
2561         </div>
2562
2563       </main>
2564
2565         <footer class="md-footer">
2566
2567
2568     <nav class="md-footer__inner md-grid" aria-label="Footer" >
2569
2570
2571         <a href="../package_installation_plugins/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Package Installation Plugins" rel="prev">
2572           <div class="md-footer__button md-icon">
2573             <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>
2574           </div>
2575           <div class="md-footer__title">
2576             <div class="md-ellipsis">
2577               <span class="md-footer__direction">
2578                 Previous
2579               </span>
2580               Package Installation Plugins
2581             </div>
2582           </div>
2583         </a>
2584
2585
2586
2587         <a href="../user_notifications/" class="md-footer__link md-footer__link--next" aria-label="Next: User Notifications" rel="next">
2588           <div class="md-footer__title">
2589             <div class="md-ellipsis">
2590               <span class="md-footer__direction">
2591                 Next
2592               </span>
2593               User Notifications
2594             </div>
2595           </div>
2596           <div class="md-footer__button md-icon">
2597             <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>
2598           </div>
2599         </a>
2600
2601     </nav>
2602
2603   <div class="md-footer-meta md-typeset">
2604     <div class="md-footer-meta__inner md-grid">
2605       <div class="md-copyright">
2606
2607     <div class="md-copyright__highlight">
2608       Copyright © 2020 WoltLab GmbH
2609     </div>
2610
2611
2612     Made with
2613     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2614       Material for MkDocs
2615     </a>
2616
2617 </div>
2618
2619         <div class="md-copyright">
2620         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2621         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2622 </div>
2623
2624     </div>
2625   </div>
2626 </footer>
2627
2628     </div>
2629     <div class="md-dialog" data-md-component="dialog">
2630       <div class="md-dialog__inner md-typeset"></div>
2631     </div>
2632
2633     <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.5bf1dace.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>
2634
2635
2636       <script src="../../../assets/javascripts/bundle.078830c0.min.js"></script>
2637
2638
2639   </body>
2640 </html>