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.4.2, mkdocs-material-8.5.7">
  15
  16
  17
  18         <title>User Activity Points - WoltLab Suite Documentation</title>
  19
  20
  21
  22       <link rel="stylesheet" href="../../../assets/stylesheets/main.20d9efc8.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           Components
 846           <span class="md-nav__icon md-icon"></span>
 847         </label>
 848
 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>
 852           Components
 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/components_confirmation/" class="md-nav__link">
 863         Confirmation
 864       </a>
 865     </li>
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875     <li class="md-nav__item">
 876       <a href="../../../javascript/components_dialog/" class="md-nav__link">
 877         Dialog
 878       </a>
 879     </li>
 880
 881
 882
 883
 884         </ul>
 885       </nav>
 886     </li>
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897     <li class="md-nav__item md-nav__item--nested">
 898
 899
 900         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_4" type="checkbox" id="__nav_4_4" >
 901
 902
 903
 904
 905         <label class="md-nav__link" for="__nav_4_4">
 906           New API
 907           <span class="md-nav__icon md-icon"></span>
 908         </label>
 909
 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>
 913           New API
 914         </label>
 915         <ul class="md-nav__list" data-md-scrollfix>
 916
 917
 918
 919
 920
 921
 922     <li class="md-nav__item">
 923       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 924         Writing a module
 925       </a>
 926     </li>
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936     <li class="md-nav__item">
 937       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 938         Data Structures
 939       </a>
 940     </li>
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950     <li class="md-nav__item">
 951       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 952         Core Functions
 953       </a>
 954     </li>
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964     <li class="md-nav__item">
 965       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 966         DOM
 967       </a>
 968     </li>
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978     <li class="md-nav__item">
 979       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 980         Event Handling
 981       </a>
 982     </li>
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992     <li class="md-nav__item">
 993       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 994         Ajax
 995       </a>
 996     </li>
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006     <li class="md-nav__item">
1007       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1008         Dialogs
1009       </a>
1010     </li>
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020     <li class="md-nav__item">
1021       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1022         Browser and Screen Sizes
1023       </a>
1024     </li>
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034     <li class="md-nav__item">
1035       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1036         User Interface
1037       </a>
1038     </li>
1039
1040
1041
1042
1043         </ul>
1044       </nav>
1045     </li>
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055     <li class="md-nav__item">
1056       <a href="../../../javascript/legacy-api/" class="md-nav__link">
1057         Legacy API
1058       </a>
1059     </li>
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069     <li class="md-nav__item">
1070       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1071         Code Snippets
1072       </a>
1073     </li>
1074
1075
1076
1077
1078         </ul>
1079       </nav>
1080     </li>
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092     <li class="md-nav__item md-nav__item--nested">
1093
1094
1095         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
1096
1097
1098
1099
1100         <label class="md-nav__link" for="__nav_5">
1101           Package Components
1102           <span class="md-nav__icon md-icon"></span>
1103         </label>
1104
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>
1108           Package Components
1109         </label>
1110         <ul class="md-nav__list" data-md-scrollfix>
1111
1112
1113
1114
1115
1116
1117     <li class="md-nav__item">
1118       <a href="../../../package/package-xml/" class="md-nav__link">
1119         package.xml
1120       </a>
1121     </li>
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132     <li class="md-nav__item md-nav__item--nested">
1133
1134
1135         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1136
1137
1138
1139
1140         <label class="md-nav__link" for="__nav_5_2">
1141           PIPs
1142           <span class="md-nav__icon md-icon"></span>
1143         </label>
1144
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>
1148           PIPs
1149         </label>
1150         <ul class="md-nav__list" data-md-scrollfix>
1151
1152
1153
1154
1155
1156
1157     <li class="md-nav__item">
1158       <a href="../../../package/pip/" class="md-nav__link">
1159         Overview
1160       </a>
1161     </li>
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171     <li class="md-nav__item">
1172       <a href="../../../package/pip/acl-option/" class="md-nav__link">
1173         aclOption
1174       </a>
1175     </li>
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185     <li class="md-nav__item">
1186       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
1187         acpMenu
1188       </a>
1189     </li>
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199     <li class="md-nav__item">
1200       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
1201         acpSearchProvider
1202       </a>
1203     </li>
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213     <li class="md-nav__item">
1214       <a href="../../../package/pip/acp-template/" class="md-nav__link">
1215         acpTemplate
1216       </a>
1217     </li>
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227     <li class="md-nav__item">
1228       <a href="../../../package/pip/acp-template-delete/" class="md-nav__link">
1229         acpTemplateDelete
1230       </a>
1231     </li>
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241     <li class="md-nav__item">
1242       <a href="../../../package/pip/bbcode/" class="md-nav__link">
1243         bbcode
1244       </a>
1245     </li>
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255     <li class="md-nav__item">
1256       <a href="../../../package/pip/box/" class="md-nav__link">
1257         box
1258       </a>
1259     </li>
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269     <li class="md-nav__item">
1270       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1271         clipboardAction
1272       </a>
1273     </li>
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283     <li class="md-nav__item">
1284       <a href="../../../package/pip/core-object/" class="md-nav__link">
1285         coreObject
1286       </a>
1287     </li>
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297     <li class="md-nav__item">
1298       <a href="../../../package/pip/cronjob/" class="md-nav__link">
1299         cronjob
1300       </a>
1301     </li>
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311     <li class="md-nav__item">
1312       <a href="../../../package/pip/database/" class="md-nav__link">
1313         database
1314       </a>
1315     </li>
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325     <li class="md-nav__item">
1326       <a href="../../../package/pip/event-listener/" class="md-nav__link">
1327         eventListener
1328       </a>
1329     </li>
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339     <li class="md-nav__item">
1340       <a href="../../../package/pip/file/" class="md-nav__link">
1341         file
1342       </a>
1343     </li>
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353     <li class="md-nav__item">
1354       <a href="../../../package/pip/file-delete/" class="md-nav__link">
1355         fileDelete
1356       </a>
1357     </li>
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367     <li class="md-nav__item">
1368       <a href="../../../package/pip/language/" class="md-nav__link">
1369         language
1370       </a>
1371     </li>
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381     <li class="md-nav__item">
1382       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1383         mediaProvider
1384       </a>
1385     </li>
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395     <li class="md-nav__item">
1396       <a href="../../../package/pip/menu/" class="md-nav__link">
1397         menu
1398       </a>
1399     </li>
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409     <li class="md-nav__item">
1410       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1411         menuItem
1412       </a>
1413     </li>
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423     <li class="md-nav__item">
1424       <a href="../../../package/pip/object-type/" class="md-nav__link">
1425         objectType
1426       </a>
1427     </li>
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437     <li class="md-nav__item">
1438       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1439         objectTypeDefinition
1440       </a>
1441     </li>
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451     <li class="md-nav__item">
1452       <a href="../../../package/pip/option/" class="md-nav__link">
1453         option
1454       </a>
1455     </li>
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465     <li class="md-nav__item">
1466       <a href="../../../package/pip/page/" class="md-nav__link">
1467         page
1468       </a>
1469     </li>
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479     <li class="md-nav__item">
1480       <a href="../../../package/pip/pip/" class="md-nav__link">
1481         pip
1482       </a>
1483     </li>
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493     <li class="md-nav__item">
1494       <a href="../../../package/pip/script/" class="md-nav__link">
1495         script
1496       </a>
1497     </li>
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507     <li class="md-nav__item">
1508       <a href="../../../package/pip/smiley/" class="md-nav__link">
1509         smiley
1510       </a>
1511     </li>
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521     <li class="md-nav__item">
1522       <a href="../../../package/pip/sql/" class="md-nav__link">
1523         sql
1524       </a>
1525     </li>
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535     <li class="md-nav__item">
1536       <a href="../../../package/pip/style/" class="md-nav__link">
1537         style
1538       </a>
1539     </li>
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549     <li class="md-nav__item">
1550       <a href="../../../package/pip/template/" class="md-nav__link">
1551         template
1552       </a>
1553     </li>
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563     <li class="md-nav__item">
1564       <a href="../../../package/pip/template-delete/" class="md-nav__link">
1565         templateDelete
1566       </a>
1567     </li>
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577     <li class="md-nav__item">
1578       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1579         templateListener
1580       </a>
1581     </li>
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591     <li class="md-nav__item">
1592       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1593         userGroupOption
1594       </a>
1595     </li>
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605     <li class="md-nav__item">
1606       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1607         userMenu
1608       </a>
1609     </li>
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619     <li class="md-nav__item">
1620       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1621         userNotificationEvent
1622       </a>
1623     </li>
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633     <li class="md-nav__item">
1634       <a href="../../../package/pip/user-option/" class="md-nav__link">
1635         userOption
1636       </a>
1637     </li>
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647     <li class="md-nav__item">
1648       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1649         userProfileMenu
1650       </a>
1651     </li>
1652
1653
1654
1655
1656         </ul>
1657       </nav>
1658     </li>
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668     <li class="md-nav__item">
1669       <a href="../../../package/database-php-api/" class="md-nav__link">
1670         Database PHP API
1671       </a>
1672     </li>
1673
1674
1675
1676
1677         </ul>
1678       </nav>
1679     </li>
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691     <li class="md-nav__item md-nav__item--nested">
1692
1693
1694         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1695
1696
1697
1698
1699         <label class="md-nav__link" for="__nav_6">
1700           Migration
1701           <span class="md-nav__icon md-icon"></span>
1702         </label>
1703
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>
1707           Migration
1708         </label>
1709         <ul class="md-nav__list" data-md-scrollfix>
1710
1711
1712
1713
1714
1715
1716
1717     <li class="md-nav__item md-nav__item--nested">
1718
1719
1720         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1721
1722
1723
1724
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>
1728         </label>
1729
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
1734         </label>
1735         <ul class="md-nav__list" data-md-scrollfix>
1736
1737
1738
1739
1740
1741
1742     <li class="md-nav__item">
1743       <a href="../../../migration/wsc55/php/" class="md-nav__link">
1744         PHP API
1745       </a>
1746     </li>
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756     <li class="md-nav__item">
1757       <a href="../../../migration/wsc55/javascript/" class="md-nav__link">
1758         TypeScript and JavaScript
1759       </a>
1760     </li>
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770     <li class="md-nav__item">
1771       <a href="../../../migration/wsc55/templates/" class="md-nav__link">
1772         Templates
1773       </a>
1774     </li>
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784     <li class="md-nav__item">
1785       <a href="../../../migration/wsc55/icons/" class="md-nav__link">
1786         Icons
1787       </a>
1788     </li>
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798     <li class="md-nav__item">
1799       <a href="../../../migration/wsc55/dialogs/" class="md-nav__link">
1800         Dialogs
1801       </a>
1802     </li>
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812     <li class="md-nav__item">
1813       <a href="../../../migration/wsc55/libraries/" class="md-nav__link">
1814         Third Party Libraries
1815       </a>
1816     </li>
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826     <li class="md-nav__item">
1827       <a href="../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1828         Deprecations and Removals
1829       </a>
1830     </li>
1831
1832
1833
1834
1835         </ul>
1836       </nav>
1837     </li>
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848     <li class="md-nav__item md-nav__item--nested">
1849
1850
1851         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1852
1853
1854
1855
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>
1859         </label>
1860
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
1865         </label>
1866         <ul class="md-nav__list" data-md-scrollfix>
1867
1868
1869
1870
1871
1872
1873     <li class="md-nav__item">
1874       <a href="../../../migration/wsc54/php/" class="md-nav__link">
1875         PHP API
1876       </a>
1877     </li>
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887     <li class="md-nav__item">
1888       <a href="../../../migration/wsc54/javascript/" class="md-nav__link">
1889         TypeScript and JavaScript
1890       </a>
1891     </li>
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901     <li class="md-nav__item">
1902       <a href="../../../migration/wsc54/templates/" class="md-nav__link">
1903         Templates
1904       </a>
1905     </li>
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915     <li class="md-nav__item">
1916       <a href="../../../migration/wsc54/libraries/" class="md-nav__link">
1917         Third Party Libraries
1918       </a>
1919     </li>
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929     <li class="md-nav__item">
1930       <a href="../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
1931         Deprecations and Removals
1932       </a>
1933     </li>
1934
1935
1936
1937
1938         </ul>
1939       </nav>
1940     </li>
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951     <li class="md-nav__item md-nav__item--nested">
1952
1953
1954         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1955
1956
1957
1958
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>
1962         </label>
1963
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
1968         </label>
1969         <ul class="md-nav__list" data-md-scrollfix>
1970
1971
1972
1973
1974
1975
1976     <li class="md-nav__item">
1977       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1978         PHP API
1979       </a>
1980     </li>
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990     <li class="md-nav__item">
1991       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1992         Session Handling and Authentication
1993       </a>
1994     </li>
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004     <li class="md-nav__item">
2005       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
2006         TypeScript and JavaScript
2007       </a>
2008     </li>
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018     <li class="md-nav__item">
2019       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
2020         Templates
2021       </a>
2022     </li>
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032     <li class="md-nav__item">
2033       <a href="../../../migration/wsc53/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_4" type="checkbox" id="__nav_6_4" >
2058
2059
2060
2061
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>
2065         </label>
2066
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
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/wsc52/php/" class="md-nav__link">
2081         PHP API
2082       </a>
2083     </li>
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093     <li class="md-nav__item">
2094       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
2095         Templates and Languages
2096       </a>
2097     </li>
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107     <li class="md-nav__item">
2108       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
2109         Third Party Libraries
2110       </a>
2111     </li>
2112
2113
2114
2115
2116         </ul>
2117       </nav>
2118     </li>
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129     <li class="md-nav__item md-nav__item--nested">
2130
2131
2132         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
2133
2134
2135
2136
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>
2140         </label>
2141
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
2146         </label>
2147         <ul class="md-nav__list" data-md-scrollfix>
2148
2149
2150
2151
2152
2153
2154     <li class="md-nav__item">
2155       <a href="../../../migration/wsc31/php/" class="md-nav__link">
2156         PHP API
2157       </a>
2158     </li>
2159
2160
2161
2162
2163         </ul>
2164       </nav>
2165     </li>
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176     <li class="md-nav__item md-nav__item--nested">
2177
2178
2179         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_6" type="checkbox" id="__nav_6_6" >
2180
2181
2182
2183
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>
2187         </label>
2188
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
2193         </label>
2194         <ul class="md-nav__list" data-md-scrollfix>
2195
2196
2197
2198
2199
2200
2201     <li class="md-nav__item">
2202       <a href="../../../migration/wsc30/php/" class="md-nav__link">
2203         PHP API
2204       </a>
2205     </li>
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215     <li class="md-nav__item">
2216       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
2217         JavaScript API
2218       </a>
2219     </li>
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229     <li class="md-nav__item">
2230       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
2231         Templates
2232       </a>
2233     </li>
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243     <li class="md-nav__item">
2244       <a href="../../../migration/wsc30/css/" class="md-nav__link">
2245         CSS
2246       </a>
2247     </li>
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257     <li class="md-nav__item">
2258       <a href="../../../migration/wsc30/package/" class="md-nav__link">
2259         Package Components
2260       </a>
2261     </li>
2262
2263
2264
2265
2266         </ul>
2267       </nav>
2268     </li>
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279     <li class="md-nav__item md-nav__item--nested">
2280
2281
2282         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_7" type="checkbox" id="__nav_6_7" >
2283
2284
2285
2286
2287         <label class="md-nav__link" for="__nav_6_7">
2288           From WCF 2.1
2289           <span class="md-nav__icon md-icon"></span>
2290         </label>
2291
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>
2295           From WCF 2.1
2296         </label>
2297         <ul class="md-nav__list" data-md-scrollfix>
2298
2299
2300
2301
2302
2303
2304     <li class="md-nav__item">
2305       <a href="../../../migration/wcf21/php/" class="md-nav__link">
2306         PHP API
2307       </a>
2308     </li>
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318     <li class="md-nav__item">
2319       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
2320         Templates
2321       </a>
2322     </li>
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332     <li class="md-nav__item">
2333       <a href="../../../migration/wcf21/css/" class="md-nav__link">
2334         CSS
2335       </a>
2336     </li>
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346     <li class="md-nav__item">
2347       <a href="../../../migration/wcf21/package/" class="md-nav__link">
2348         Package Components
2349       </a>
2350     </li>
2351
2352
2353
2354
2355         </ul>
2356       </nav>
2357     </li>
2358
2359
2360
2361
2362         </ul>
2363       </nav>
2364     </li>
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376     <li class="md-nav__item md-nav__item--nested">
2377
2378
2379         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
2380
2381
2382
2383
2384         <label class="md-nav__link" for="__nav_7">
2385           Tutorials
2386           <span class="md-nav__icon md-icon"></span>
2387         </label>
2388
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>
2392           Tutorials
2393         </label>
2394         <ul class="md-nav__list" data-md-scrollfix>
2395
2396
2397
2398
2399
2400
2401
2402     <li class="md-nav__item md-nav__item--nested">
2403
2404
2405         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
2406
2407
2408
2409
2410         <label class="md-nav__link" for="__nav_7_1">
2411           Tutorial Series
2412           <span class="md-nav__icon md-icon"></span>
2413         </label>
2414
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>
2418           Tutorial Series
2419         </label>
2420         <ul class="md-nav__list" data-md-scrollfix>
2421
2422
2423
2424
2425
2426
2427     <li class="md-nav__item">
2428       <a href="../../../tutorial/series/overview/" class="md-nav__link">
2429         Overview
2430       </a>
2431     </li>
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441     <li class="md-nav__item">
2442       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2443         Part 1
2444       </a>
2445     </li>
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455     <li class="md-nav__item">
2456       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2457         Part 2
2458       </a>
2459     </li>
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469     <li class="md-nav__item">
2470       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2471         Part 3
2472       </a>
2473     </li>
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483     <li class="md-nav__item">
2484       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2485         Part 4
2486       </a>
2487     </li>
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497     <li class="md-nav__item">
2498       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2499         Part 5
2500       </a>
2501     </li>
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511     <li class="md-nav__item">
2512       <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2513         Part 6
2514       </a>
2515     </li>
2516
2517
2518
2519
2520         </ul>
2521       </nav>
2522     </li>
2523
2524
2525
2526
2527         </ul>
2528       </nav>
2529     </li>
2530
2531
2532
2533   </ul>
2534 </nav>
2535                   </div>
2536                 </div>
2537               </div>
2538
2539
2540
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">
2544
2545
2546 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2547
2548
2549
2550
2551
2552
2553 </nav>
2554                   </div>
2555                 </div>
2556               </div>
2557
2558
2559
2560             <div class="md-content" data-md-component="content">
2561               <article class="md-content__inner md-typeset">
2562
2563
2564
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">
2566
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>
2568   </a>
2569
2570
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">&lt;type&gt;</span>
2580     <span class="nt">&lt;name&gt;</span>com.example.foo.activityPointEvent.bar<span class="nt">&lt;/name&gt;</span>
2581     <span class="nt">&lt;definitionname&gt;</span>com.woltlab.wcf.user.activityPointEvent<span class="nt">&lt;/definitionname&gt;</span>
2582     <span class="nt">&lt;points&gt;</span>10<span class="nt">&lt;/points&gt;</span>
2583 <span class="nt">&lt;/type&gt;</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">-&gt;</span><span class="na">fireEvent</span><span class="p">(</span>
2596         <span class="s1">&#39;com.example.foo.activityPointEvent.bar&#39;</span><span class="p">,</span>
2597         <span class="nv">$bar</span><span class="o">-&gt;</span><span class="na">barID</span><span class="p">,</span>
2598         <span class="nv">$bar</span><span class="o">-&gt;</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">-&gt;</span><span class="na">removeEvents</span><span class="p">(</span>
2609         <span class="s1">&#39;com.example.foo.activityPointEvent.bar&#39;</span><span class="p">,</span>
2610        <span class="p">[</span>
2611                 <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>
2612                 <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>
2613         <span class="p">]</span>
2614 <span class="p">);</span>
2615 </code></pre></div></td></tr></table></div>
2616
2617   <hr>
2618 <div class="md-source-file">
2619   <small>
2620
2621       Last update:
2622       2021-01-08
2623
2624   </small>
2625 </div>
2626
2627
2628
2629
2630
2631
2632               </article>
2633             </div>
2634
2635
2636         </div>
2637
2638       </main>
2639
2640         <footer class="md-footer">
2641
2642
2643     <nav class="md-footer__inner md-grid" aria-label="Footer" >
2644
2645
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>
2649           </div>
2650           <div class="md-footer__title">
2651             <div class="md-ellipsis">
2652               <span class="md-footer__direction">
2653                 Previous
2654               </span>
2655               Package Installation Plugins
2656             </div>
2657           </div>
2658         </a>
2659
2660
2661
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">
2666                 Next
2667               </span>
2668               User Notifications
2669             </div>
2670           </div>
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>
2673           </div>
2674         </a>
2675
2676     </nav>
2677
2678   <div class="md-footer-meta md-typeset">
2679     <div class="md-footer-meta__inner md-grid">
2680       <div class="md-copyright">
2681
2682     <div class="md-copyright__highlight">
2683       Copyright © 2020 WoltLab GmbH
2684     </div>
2685
2686
2687     Made with
2688     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2689       Material for MkDocs
2690     </a>
2691
2692 </div>
2693
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>
2697 </div>
2698
2699     </div>
2700   </div>
2701 </footer>
2702
2703     </div>
2704     <div class="md-dialog" data-md-component="dialog">
2705       <div class="md-dialog__inner md-typeset"></div>
2706     </div>
2707
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>
2709
2710
2711       <script src="../../../assets/javascripts/bundle.8492ddcf.min.js"></script>
2712
2713
2714   </body>
2715 </html>