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