6.1/migration/wsc31/php/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.1/migration/wsc31/php/">
  12
  13
  14         <link rel="prev" href="../../wsc52/libraries/">
  15
  16
  17         <link rel="next" href="../../wsc30/php/">
  18
  19
  20       <link rel="icon" href="../../../assets/default.favicon.ico">
  21       <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.2">
  22
  23
  24
  25         <title>PHP API - WoltLab Suite Documentation</title>
  26
  27
  28
  29       <link rel="stylesheet" href="../../../assets/stylesheets/main.d451bc0e.min.css">
  30
  31
  32         <link rel="stylesheet" href="../../../assets/stylesheets/palette.a5377069.min.css">
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  46
  47     <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>
  48
  49
  50
  51
  52
  53
  54   </head>
  55
  56
  57
  58
  59
  60
  61
  62     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  63
  64
  65
  66     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  67     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  68     <label class="md-overlay" for="__drawer"></label>
  69     <div data-md-component="skip">
  70
  71
  72         <a href="#migrating-from-wsc-31-php" class="md-skip">
  73           Skip to content
  74         </a>
  75
  76     </div>
  77     <div data-md-component="announce">
  78
  79         <aside class="md-banner">
  80           <div class="md-banner__inner md-grid md-typeset">
  81
  82
  83     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  84
  85           </div>
  86
  87         </aside>
  88
  89     </div>
  90
  91       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  92
  93       </div>
  94
  95
  96
  97
  98
  99
 100 <header class="md-header md-header--shadow" data-md-component="header">
 101   <nav class="md-header__inner md-grid" aria-label="Header">
 102     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 103
 104   <img src="../../../assets/logo.png" alt="logo">
 105
 106     </a>
 107     <label class="md-header__button md-icon" for="__drawer">
 108
 109       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 110     </label>
 111     <div class="md-header__title" data-md-component="header-title">
 112       <div class="md-header__ellipsis">
 113         <div class="md-header__topic">
 114           <span class="md-ellipsis">
 115             WoltLab Suite Documentation
 116           </span>
 117         </div>
 118         <div class="md-header__topic" data-md-component="header-topic">
 119           <span class="md-ellipsis">
 120
 121               PHP API
 122
 123           </span>
 124         </div>
 125       </div>
 126     </div>
 127
 128
 129
 130
 131
 132       <label class="md-header__button md-icon" for="__search">
 133
 134         <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>
 135       </label>
 136       <div class="md-search" data-md-component="search" role="dialog">
 137   <label class="md-search__overlay" for="__search"></label>
 138   <div class="md-search__inner" role="search">
 139     <form class="md-search__form" name="search">
 140       <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>
 141       <label class="md-search__icon md-icon" for="__search">
 142
 143         <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>
 144
 145         <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>
 146       </label>
 147       <nav class="md-search__options" aria-label="Search">
 148
 149         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 150
 151           <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>
 152         </button>
 153       </nav>
 154
 155     </form>
 156     <div class="md-search__output">
 157       <div class="md-search__scrollwrap" data-md-scrollfix>
 158         <div class="md-search-result" data-md-component="search-result">
 159           <div class="md-search-result__meta">
 160             Initializing search
 161           </div>
 162           <ol class="md-search-result__list" role="presentation"></ol>
 163         </div>
 164       </div>
 165     </div>
 166   </div>
 167 </div>
 168
 169
 170       <div class="md-header__source">
 171         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 172   <div class="md-source__icon md-icon">
 173
 174     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 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 2023 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>
 175   </div>
 176   <div class="md-source__repository">
 177     GitHub
 178   </div>
 179 </a>
 180       </div>
 181
 182   </nav>
 183
 184 </header>
 185
 186     <div class="md-container" data-md-component="container">
 187
 188
 189
 190
 191
 192
 193       <main class="md-main" data-md-component="main">
 194         <div class="md-main__inner md-grid">
 195
 196
 197
 198               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 199                 <div class="md-sidebar__scrollwrap">
 200                   <div class="md-sidebar__inner">
 201
 202
 203
 204
 205 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 206   <label class="md-nav__title" for="__drawer">
 207     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 208
 209   <img src="../../../assets/logo.png" alt="logo">
 210
 211     </a>
 212     WoltLab Suite Documentation
 213   </label>
 214
 215     <div class="md-nav__source">
 216       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 217   <div class="md-source__icon md-icon">
 218
 219     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 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 2023 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>
 220   </div>
 221   <div class="md-source__repository">
 222     GitHub
 223   </div>
 224 </a>
 225     </div>
 226
 227   <ul class="md-nav__list" data-md-scrollfix>
 228
 229
 230
 231
 232
 233
 234     <li class="md-nav__item">
 235       <a href="../../../getting-started/" class="md-nav__link">
 236
 237
 238   <span class="md-ellipsis">
 239     Getting Started
 240   </span>
 241
 242
 243       </a>
 244     </li>
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258     <li class="md-nav__item md-nav__item--nested">
 259
 260
 261
 262
 263         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 264
 265
 266           <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 267
 268
 269   <span class="md-ellipsis">
 270     PHP API
 271   </span>
 272
 273
 274             <span class="md-nav__icon md-icon"></span>
 275           </label>
 276
 277         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 278           <label class="md-nav__title" for="__nav_2">
 279             <span class="md-nav__icon md-icon"></span>
 280             PHP API
 281           </label>
 282           <ul class="md-nav__list" data-md-scrollfix>
 283
 284
 285
 286
 287
 288
 289     <li class="md-nav__item">
 290       <a href="../../../php/pages/" class="md-nav__link">
 291
 292
 293   <span class="md-ellipsis">
 294     Pages
 295   </span>
 296
 297
 298       </a>
 299     </li>
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309     <li class="md-nav__item">
 310       <a href="../../../php/database-objects/" class="md-nav__link">
 311
 312
 313   <span class="md-ellipsis">
 314     Database Objects
 315   </span>
 316
 317
 318       </a>
 319     </li>
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329     <li class="md-nav__item">
 330       <a href="../../../php/database-access/" class="md-nav__link">
 331
 332
 333   <span class="md-ellipsis">
 334     Database Access
 335   </span>
 336
 337
 338       </a>
 339     </li>
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349     <li class="md-nav__item">
 350       <a href="../../../php/exceptions/" class="md-nav__link">
 351
 352
 353   <span class="md-ellipsis">
 354     Exceptions
 355   </span>
 356
 357
 358       </a>
 359     </li>
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374     <li class="md-nav__item md-nav__item--nested">
 375
 376
 377
 378
 379         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 380
 381
 382           <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 383
 384
 385   <span class="md-ellipsis">
 386     API
 387   </span>
 388
 389
 390             <span class="md-nav__icon md-icon"></span>
 391           </label>
 392
 393         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 394           <label class="md-nav__title" for="__nav_2_5">
 395             <span class="md-nav__icon md-icon"></span>
 396             API
 397           </label>
 398           <ul class="md-nav__list" data-md-scrollfix>
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410     <li class="md-nav__item md-nav__item--nested">
 411
 412
 413
 414
 415         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 416
 417
 418           <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 419
 420
 421   <span class="md-ellipsis">
 422     Caches
 423   </span>
 424
 425
 426             <span class="md-nav__icon md-icon"></span>
 427           </label>
 428
 429         <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 430           <label class="md-nav__title" for="__nav_2_5_1">
 431             <span class="md-nav__icon md-icon"></span>
 432             Caches
 433           </label>
 434           <ul class="md-nav__list" data-md-scrollfix>
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/caches/" class="md-nav__link">
 443
 444
 445   <span class="md-ellipsis">
 446     Overview
 447   </span>
 448
 449
 450       </a>
 451     </li>
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461     <li class="md-nav__item">
 462       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 463
 464
 465   <span class="md-ellipsis">
 466     Persistent Caches
 467   </span>
 468
 469
 470       </a>
 471     </li>
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481     <li class="md-nav__item">
 482       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 483
 484
 485   <span class="md-ellipsis">
 486     Runtime Caches
 487   </span>
 488
 489
 490       </a>
 491     </li>
 492
 493
 494
 495
 496           </ul>
 497         </nav>
 498
 499     </li>
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509     <li class="md-nav__item">
 510       <a href="../../../php/api/comments/" class="md-nav__link">
 511
 512
 513   <span class="md-ellipsis">
 514     Comments
 515   </span>
 516
 517
 518       </a>
 519     </li>
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529     <li class="md-nav__item">
 530       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 531
 532
 533   <span class="md-ellipsis">
 534     Cronjobs
 535   </span>
 536
 537
 538       </a>
 539     </li>
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549     <li class="md-nav__item">
 550       <a href="../../../php/api/events/" class="md-nav__link">
 551
 552
 553   <span class="md-ellipsis">
 554     Events
 555   </span>
 556
 557
 558       </a>
 559     </li>
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574     <li class="md-nav__item md-nav__item--nested">
 575
 576
 577
 578
 579         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 580
 581
 582           <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 583
 584
 585   <span class="md-ellipsis">
 586     Form Builder
 587   </span>
 588
 589
 590             <span class="md-nav__icon md-icon"></span>
 591           </label>
 592
 593         <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 594           <label class="md-nav__title" for="__nav_2_5_5">
 595             <span class="md-nav__icon md-icon"></span>
 596             Form Builder
 597           </label>
 598           <ul class="md-nav__list" data-md-scrollfix>
 599
 600
 601
 602
 603
 604
 605     <li class="md-nav__item">
 606       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 607
 608
 609   <span class="md-ellipsis">
 610     Overview
 611   </span>
 612
 613
 614       </a>
 615     </li>
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625     <li class="md-nav__item">
 626       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 627
 628
 629   <span class="md-ellipsis">
 630     Structure
 631   </span>
 632
 633
 634       </a>
 635     </li>
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645     <li class="md-nav__item">
 646       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 647
 648
 649   <span class="md-ellipsis">
 650     Fields
 651   </span>
 652
 653
 654       </a>
 655     </li>
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665     <li class="md-nav__item">
 666       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 667
 668
 669   <span class="md-ellipsis">
 670     Validation and Data
 671   </span>
 672
 673
 674       </a>
 675     </li>
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685     <li class="md-nav__item">
 686       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 687
 688
 689   <span class="md-ellipsis">
 690     Dependencies
 691   </span>
 692
 693
 694       </a>
 695     </li>
 696
 697
 698
 699
 700           </ul>
 701         </nav>
 702
 703     </li>
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713     <li class="md-nav__item">
 714       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 715
 716
 717   <span class="md-ellipsis">
 718     Package Installation Plugins
 719   </span>
 720
 721
 722       </a>
 723     </li>
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733     <li class="md-nav__item">
 734       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 735
 736
 737   <span class="md-ellipsis">
 738     User Activity Points
 739   </span>
 740
 741
 742       </a>
 743     </li>
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753     <li class="md-nav__item">
 754       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 755
 756
 757   <span class="md-ellipsis">
 758     User Notifications
 759   </span>
 760
 761
 762       </a>
 763     </li>
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773     <li class="md-nav__item">
 774       <a href="../../../php/api/rss_feeds/" class="md-nav__link">
 775
 776
 777   <span class="md-ellipsis">
 778     RSS Feeds
 779   </span>
 780
 781
 782       </a>
 783     </li>
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793     <li class="md-nav__item">
 794       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 795
 796
 797   <span class="md-ellipsis">
 798     Sitemaps
 799   </span>
 800
 801
 802       </a>
 803     </li>
 804
 805
 806
 807
 808           </ul>
 809         </nav>
 810
 811     </li>
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821     <li class="md-nav__item">
 822       <a href="../../../php/code-style/" class="md-nav__link">
 823
 824
 825   <span class="md-ellipsis">
 826     Code Style
 827   </span>
 828
 829
 830       </a>
 831     </li>
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841     <li class="md-nav__item">
 842       <a href="../../../php/apps/" class="md-nav__link">
 843
 844
 845   <span class="md-ellipsis">
 846     Apps
 847   </span>
 848
 849
 850       </a>
 851     </li>
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861     <li class="md-nav__item">
 862       <a href="../../../php/gdpr/" class="md-nav__link">
 863
 864
 865   <span class="md-ellipsis">
 866     GDPR
 867   </span>
 868
 869
 870       </a>
 871     </li>
 872
 873
 874
 875
 876           </ul>
 877         </nav>
 878
 879     </li>
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893     <li class="md-nav__item md-nav__item--nested">
 894
 895
 896
 897
 898         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 899
 900
 901           <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 902
 903
 904   <span class="md-ellipsis">
 905     Languages, Templates & CSS
 906   </span>
 907
 908
 909             <span class="md-nav__icon md-icon"></span>
 910           </label>
 911
 912         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 913           <label class="md-nav__title" for="__nav_3">
 914             <span class="md-nav__icon md-icon"></span>
 915             Languages, Templates & CSS
 916           </label>
 917           <ul class="md-nav__list" data-md-scrollfix>
 918
 919
 920
 921
 922
 923
 924     <li class="md-nav__item">
 925       <a href="../../../view/languages/" class="md-nav__link">
 926
 927
 928   <span class="md-ellipsis">
 929     Languages
 930   </span>
 931
 932
 933       </a>
 934     </li>
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944     <li class="md-nav__item">
 945       <a href="../../../view/templates/" class="md-nav__link">
 946
 947
 948   <span class="md-ellipsis">
 949     Templates
 950   </span>
 951
 952
 953       </a>
 954     </li>
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964     <li class="md-nav__item">
 965       <a href="../../../view/template-modifiers/" class="md-nav__link">
 966
 967
 968   <span class="md-ellipsis">
 969     Template Modifiers
 970   </span>
 971
 972
 973       </a>
 974     </li>
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984     <li class="md-nav__item">
 985       <a href="../../../view/template-plugins/" class="md-nav__link">
 986
 987
 988   <span class="md-ellipsis">
 989     Template Plugins
 990   </span>
 991
 992
 993       </a>
 994     </li>
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004     <li class="md-nav__item">
1005       <a href="../../../view/css/" class="md-nav__link">
1006
1007
1008   <span class="md-ellipsis">
1009     CSS
1010   </span>
1011
1012
1013       </a>
1014     </li>
1015
1016
1017
1018
1019           </ul>
1020         </nav>
1021
1022     </li>
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036     <li class="md-nav__item md-nav__item--nested">
1037
1038
1039
1040
1041         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
1042
1043
1044           <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
1045
1046
1047   <span class="md-ellipsis">
1048     TypeScript and JavaScript API
1049   </span>
1050
1051
1052             <span class="md-nav__icon md-icon"></span>
1053           </label>
1054
1055         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
1056           <label class="md-nav__title" for="__nav_4">
1057             <span class="md-nav__icon md-icon"></span>
1058             TypeScript and JavaScript API
1059           </label>
1060           <ul class="md-nav__list" data-md-scrollfix>
1061
1062
1063
1064
1065
1066
1067     <li class="md-nav__item">
1068       <a href="../../../javascript/general-usage/" class="md-nav__link">
1069
1070
1071   <span class="md-ellipsis">
1072     General Usage
1073   </span>
1074
1075
1076       </a>
1077     </li>
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087     <li class="md-nav__item">
1088       <a href="../../../javascript/typescript/" class="md-nav__link">
1089
1090
1091   <span class="md-ellipsis">
1092     TypeScript
1093   </span>
1094
1095
1096       </a>
1097     </li>
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112     <li class="md-nav__item md-nav__item--nested">
1113
1114
1115
1116
1117         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
1118
1119
1120           <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
1121
1122
1123   <span class="md-ellipsis">
1124     Components
1125   </span>
1126
1127
1128             <span class="md-nav__icon md-icon"></span>
1129           </label>
1130
1131         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
1132           <label class="md-nav__title" for="__nav_4_3">
1133             <span class="md-nav__icon md-icon"></span>
1134             Components
1135           </label>
1136           <ul class="md-nav__list" data-md-scrollfix>
1137
1138
1139
1140
1141
1142
1143     <li class="md-nav__item">
1144       <a href="../../../javascript/components_ckeditor5/" class="md-nav__link">
1145
1146
1147   <span class="md-ellipsis">
1148     CKEditor 5
1149   </span>
1150
1151
1152       </a>
1153     </li>
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163     <li class="md-nav__item">
1164       <a href="../../../javascript/components_confirmation/" class="md-nav__link">
1165
1166
1167   <span class="md-ellipsis">
1168     Confirmation
1169   </span>
1170
1171
1172       </a>
1173     </li>
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183     <li class="md-nav__item">
1184       <a href="../../../javascript/components_dialog/" class="md-nav__link">
1185
1186
1187   <span class="md-ellipsis">
1188     Dialog
1189   </span>
1190
1191
1192       </a>
1193     </li>
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203     <li class="md-nav__item">
1204       <a href="../../../javascript/components_google_maps/" class="md-nav__link">
1205
1206
1207   <span class="md-ellipsis">
1208     Google Maps
1209   </span>
1210
1211
1212       </a>
1213     </li>
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223     <li class="md-nav__item">
1224       <a href="../../../javascript/components_pagination/" class="md-nav__link">
1225
1226
1227   <span class="md-ellipsis">
1228     Pagination
1229   </span>
1230
1231
1232       </a>
1233     </li>
1234
1235
1236
1237
1238           </ul>
1239         </nav>
1240
1241     </li>
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256     <li class="md-nav__item md-nav__item--nested">
1257
1258
1259
1260
1261         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
1262
1263
1264           <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
1265
1266
1267   <span class="md-ellipsis">
1268     New API
1269   </span>
1270
1271
1272             <span class="md-nav__icon md-icon"></span>
1273           </label>
1274
1275         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
1276           <label class="md-nav__title" for="__nav_4_4">
1277             <span class="md-nav__icon md-icon"></span>
1278             New API
1279           </label>
1280           <ul class="md-nav__list" data-md-scrollfix>
1281
1282
1283
1284
1285
1286
1287     <li class="md-nav__item">
1288       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
1289
1290
1291   <span class="md-ellipsis">
1292     Writing a module
1293   </span>
1294
1295
1296       </a>
1297     </li>
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307     <li class="md-nav__item">
1308       <a href="../../../javascript/new-api_core/" class="md-nav__link">
1309
1310
1311   <span class="md-ellipsis">
1312     Core Functions
1313   </span>
1314
1315
1316       </a>
1317     </li>
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327     <li class="md-nav__item">
1328       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
1329
1330
1331   <span class="md-ellipsis">
1332     DOM
1333   </span>
1334
1335
1336       </a>
1337     </li>
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347     <li class="md-nav__item">
1348       <a href="../../../javascript/new-api_events/" class="md-nav__link">
1349
1350
1351   <span class="md-ellipsis">
1352     Event Handling
1353   </span>
1354
1355
1356       </a>
1357     </li>
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367     <li class="md-nav__item">
1368       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1369
1370
1371   <span class="md-ellipsis">
1372     Ajax
1373   </span>
1374
1375
1376       </a>
1377     </li>
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387     <li class="md-nav__item">
1388       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1389
1390
1391   <span class="md-ellipsis">
1392     Dialogs
1393   </span>
1394
1395
1396       </a>
1397     </li>
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407     <li class="md-nav__item">
1408       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1409
1410
1411   <span class="md-ellipsis">
1412     Browser and Screen Sizes
1413   </span>
1414
1415
1416       </a>
1417     </li>
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427     <li class="md-nav__item">
1428       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1429
1430
1431   <span class="md-ellipsis">
1432     User Interface
1433   </span>
1434
1435
1436       </a>
1437     </li>
1438
1439
1440
1441
1442           </ul>
1443         </nav>
1444
1445     </li>
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455     <li class="md-nav__item">
1456       <a href="../../../javascript/legacy-api/" class="md-nav__link">
1457
1458
1459   <span class="md-ellipsis">
1460     Legacy API
1461   </span>
1462
1463
1464       </a>
1465     </li>
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475     <li class="md-nav__item">
1476       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1477
1478
1479   <span class="md-ellipsis">
1480     Code Snippets
1481   </span>
1482
1483
1484       </a>
1485     </li>
1486
1487
1488
1489
1490           </ul>
1491         </nav>
1492
1493     </li>
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507     <li class="md-nav__item md-nav__item--nested">
1508
1509
1510
1511
1512         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1513
1514
1515           <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1516
1517
1518   <span class="md-ellipsis">
1519     Package Components
1520   </span>
1521
1522
1523             <span class="md-nav__icon md-icon"></span>
1524           </label>
1525
1526         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1527           <label class="md-nav__title" for="__nav_5">
1528             <span class="md-nav__icon md-icon"></span>
1529             Package Components
1530           </label>
1531           <ul class="md-nav__list" data-md-scrollfix>
1532
1533
1534
1535
1536
1537
1538     <li class="md-nav__item">
1539       <a href="../../../package/package-xml/" class="md-nav__link">
1540
1541
1542   <span class="md-ellipsis">
1543     package.xml
1544   </span>
1545
1546
1547       </a>
1548     </li>
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563     <li class="md-nav__item md-nav__item--nested">
1564
1565
1566
1567
1568         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1569
1570
1571           <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1572
1573
1574   <span class="md-ellipsis">
1575     PIPs
1576   </span>
1577
1578
1579             <span class="md-nav__icon md-icon"></span>
1580           </label>
1581
1582         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1583           <label class="md-nav__title" for="__nav_5_2">
1584             <span class="md-nav__icon md-icon"></span>
1585             PIPs
1586           </label>
1587           <ul class="md-nav__list" data-md-scrollfix>
1588
1589
1590
1591
1592
1593
1594     <li class="md-nav__item">
1595       <a href="../../../package/pip/" class="md-nav__link">
1596
1597
1598   <span class="md-ellipsis">
1599     Overview
1600   </span>
1601
1602
1603       </a>
1604     </li>
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614     <li class="md-nav__item">
1615       <a href="../../../package/pip/acl-option/" class="md-nav__link">
1616
1617
1618   <span class="md-ellipsis">
1619     aclOption
1620   </span>
1621
1622
1623       </a>
1624     </li>
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634     <li class="md-nav__item">
1635       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
1636
1637
1638   <span class="md-ellipsis">
1639     acpMenu
1640   </span>
1641
1642
1643       </a>
1644     </li>
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654     <li class="md-nav__item">
1655       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
1656
1657
1658   <span class="md-ellipsis">
1659     acpSearchProvider
1660   </span>
1661
1662
1663       </a>
1664     </li>
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674     <li class="md-nav__item">
1675       <a href="../../../package/pip/acp-template/" class="md-nav__link">
1676
1677
1678   <span class="md-ellipsis">
1679     acpTemplate
1680   </span>
1681
1682
1683       </a>
1684     </li>
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694     <li class="md-nav__item">
1695       <a href="../../../package/pip/acp-template-delete/" class="md-nav__link">
1696
1697
1698   <span class="md-ellipsis">
1699     acpTemplateDelete
1700   </span>
1701
1702
1703       </a>
1704     </li>
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714     <li class="md-nav__item">
1715       <a href="../../../package/pip/bbcode/" class="md-nav__link">
1716
1717
1718   <span class="md-ellipsis">
1719     bbcode
1720   </span>
1721
1722
1723       </a>
1724     </li>
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734     <li class="md-nav__item">
1735       <a href="../../../package/pip/box/" class="md-nav__link">
1736
1737
1738   <span class="md-ellipsis">
1739     box
1740   </span>
1741
1742
1743       </a>
1744     </li>
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754     <li class="md-nav__item">
1755       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1756
1757
1758   <span class="md-ellipsis">
1759     clipboardAction
1760   </span>
1761
1762
1763       </a>
1764     </li>
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774     <li class="md-nav__item">
1775       <a href="../../../package/pip/core-object/" class="md-nav__link">
1776
1777
1778   <span class="md-ellipsis">
1779     coreObject
1780   </span>
1781
1782
1783       </a>
1784     </li>
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794     <li class="md-nav__item">
1795       <a href="../../../package/pip/cronjob/" class="md-nav__link">
1796
1797
1798   <span class="md-ellipsis">
1799     cronjob
1800   </span>
1801
1802
1803       </a>
1804     </li>
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814     <li class="md-nav__item">
1815       <a href="../../../package/pip/database/" class="md-nav__link">
1816
1817
1818   <span class="md-ellipsis">
1819     database
1820   </span>
1821
1822
1823       </a>
1824     </li>
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834     <li class="md-nav__item">
1835       <a href="../../../package/pip/event-listener/" class="md-nav__link">
1836
1837
1838   <span class="md-ellipsis">
1839     eventListener
1840   </span>
1841
1842
1843       </a>
1844     </li>
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854     <li class="md-nav__item">
1855       <a href="../../../package/pip/file/" class="md-nav__link">
1856
1857
1858   <span class="md-ellipsis">
1859     file
1860   </span>
1861
1862
1863       </a>
1864     </li>
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874     <li class="md-nav__item">
1875       <a href="../../../package/pip/file-delete/" class="md-nav__link">
1876
1877
1878   <span class="md-ellipsis">
1879     fileDelete
1880   </span>
1881
1882
1883       </a>
1884     </li>
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894     <li class="md-nav__item">
1895       <a href="../../../package/pip/language/" class="md-nav__link">
1896
1897
1898   <span class="md-ellipsis">
1899     language
1900   </span>
1901
1902
1903       </a>
1904     </li>
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914     <li class="md-nav__item">
1915       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1916
1917
1918   <span class="md-ellipsis">
1919     mediaProvider
1920   </span>
1921
1922
1923       </a>
1924     </li>
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934     <li class="md-nav__item">
1935       <a href="../../../package/pip/menu/" class="md-nav__link">
1936
1937
1938   <span class="md-ellipsis">
1939     menu
1940   </span>
1941
1942
1943       </a>
1944     </li>
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954     <li class="md-nav__item">
1955       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1956
1957
1958   <span class="md-ellipsis">
1959     menuItem
1960   </span>
1961
1962
1963       </a>
1964     </li>
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974     <li class="md-nav__item">
1975       <a href="../../../package/pip/object-type/" class="md-nav__link">
1976
1977
1978   <span class="md-ellipsis">
1979     objectType
1980   </span>
1981
1982
1983       </a>
1984     </li>
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994     <li class="md-nav__item">
1995       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1996
1997
1998   <span class="md-ellipsis">
1999     objectTypeDefinition
2000   </span>
2001
2002
2003       </a>
2004     </li>
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014     <li class="md-nav__item">
2015       <a href="../../../package/pip/option/" class="md-nav__link">
2016
2017
2018   <span class="md-ellipsis">
2019     option
2020   </span>
2021
2022
2023       </a>
2024     </li>
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034     <li class="md-nav__item">
2035       <a href="../../../package/pip/page/" class="md-nav__link">
2036
2037
2038   <span class="md-ellipsis">
2039     page
2040   </span>
2041
2042
2043       </a>
2044     </li>
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054     <li class="md-nav__item">
2055       <a href="../../../package/pip/pip/" class="md-nav__link">
2056
2057
2058   <span class="md-ellipsis">
2059     pip
2060   </span>
2061
2062
2063       </a>
2064     </li>
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074     <li class="md-nav__item">
2075       <a href="../../../package/pip/script/" class="md-nav__link">
2076
2077
2078   <span class="md-ellipsis">
2079     script
2080   </span>
2081
2082
2083       </a>
2084     </li>
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094     <li class="md-nav__item">
2095       <a href="../../../package/pip/smiley/" class="md-nav__link">
2096
2097
2098   <span class="md-ellipsis">
2099     smiley
2100   </span>
2101
2102
2103       </a>
2104     </li>
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114     <li class="md-nav__item">
2115       <a href="../../../package/pip/sql/" class="md-nav__link">
2116
2117
2118   <span class="md-ellipsis">
2119     sql
2120   </span>
2121
2122
2123       </a>
2124     </li>
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134     <li class="md-nav__item">
2135       <a href="../../../package/pip/style/" class="md-nav__link">
2136
2137
2138   <span class="md-ellipsis">
2139     style
2140   </span>
2141
2142
2143       </a>
2144     </li>
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154     <li class="md-nav__item">
2155       <a href="../../../package/pip/template/" class="md-nav__link">
2156
2157
2158   <span class="md-ellipsis">
2159     template
2160   </span>
2161
2162
2163       </a>
2164     </li>
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174     <li class="md-nav__item">
2175       <a href="../../../package/pip/template-delete/" class="md-nav__link">
2176
2177
2178   <span class="md-ellipsis">
2179     templateDelete
2180   </span>
2181
2182
2183       </a>
2184     </li>
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194     <li class="md-nav__item">
2195       <a href="../../../package/pip/template-listener/" class="md-nav__link">
2196
2197
2198   <span class="md-ellipsis">
2199     templateListener
2200   </span>
2201
2202
2203       </a>
2204     </li>
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214     <li class="md-nav__item">
2215       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
2216
2217
2218   <span class="md-ellipsis">
2219     userGroupOption
2220   </span>
2221
2222
2223       </a>
2224     </li>
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234     <li class="md-nav__item">
2235       <a href="../../../package/pip/user-menu/" class="md-nav__link">
2236
2237
2238   <span class="md-ellipsis">
2239     userMenu
2240   </span>
2241
2242
2243       </a>
2244     </li>
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254     <li class="md-nav__item">
2255       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
2256
2257
2258   <span class="md-ellipsis">
2259     userNotificationEvent
2260   </span>
2261
2262
2263       </a>
2264     </li>
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274     <li class="md-nav__item">
2275       <a href="../../../package/pip/user-option/" class="md-nav__link">
2276
2277
2278   <span class="md-ellipsis">
2279     userOption
2280   </span>
2281
2282
2283       </a>
2284     </li>
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294     <li class="md-nav__item">
2295       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
2296
2297
2298   <span class="md-ellipsis">
2299     userProfileMenu
2300   </span>
2301
2302
2303       </a>
2304     </li>
2305
2306
2307
2308
2309           </ul>
2310         </nav>
2311
2312     </li>
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322     <li class="md-nav__item">
2323       <a href="../../../package/database-php-api/" class="md-nav__link">
2324
2325
2326   <span class="md-ellipsis">
2327     Database PHP API
2328   </span>
2329
2330
2331       </a>
2332     </li>
2333
2334
2335
2336
2337           </ul>
2338         </nav>
2339
2340     </li>
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
2357
2358
2359
2360
2361         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
2362
2363
2364           <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
2365
2366
2367   <span class="md-ellipsis">
2368     Migration
2369   </span>
2370
2371
2372             <span class="md-nav__icon md-icon"></span>
2373           </label>
2374
2375         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
2376           <label class="md-nav__title" for="__nav_6">
2377             <span class="md-nav__icon md-icon"></span>
2378             Migration
2379           </label>
2380           <ul class="md-nav__list" data-md-scrollfix>
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392     <li class="md-nav__item md-nav__item--nested">
2393
2394
2395
2396
2397         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
2398
2399
2400           <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
2401
2402
2403   <span class="md-ellipsis">
2404     From WoltLab Suite 6.0
2405   </span>
2406
2407
2408             <span class="md-nav__icon md-icon"></span>
2409           </label>
2410
2411         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
2412           <label class="md-nav__title" for="__nav_6_1">
2413             <span class="md-nav__icon md-icon"></span>
2414             From WoltLab Suite 6.0
2415           </label>
2416           <ul class="md-nav__list" data-md-scrollfix>
2417
2418
2419
2420
2421
2422
2423     <li class="md-nav__item">
2424       <a href="../../wsc60/php/" class="md-nav__link">
2425
2426
2427   <span class="md-ellipsis">
2428     PHP API
2429   </span>
2430
2431
2432       </a>
2433     </li>
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443     <li class="md-nav__item">
2444       <a href="../../wsc60/templates/" class="md-nav__link">
2445
2446
2447   <span class="md-ellipsis">
2448     Templates
2449   </span>
2450
2451
2452       </a>
2453     </li>
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463     <li class="md-nav__item">
2464       <a href="../../wsc60/deprecations_removals/" class="md-nav__link">
2465
2466
2467   <span class="md-ellipsis">
2468     Deprecations and Removals
2469   </span>
2470
2471
2472       </a>
2473     </li>
2474
2475
2476
2477
2478           </ul>
2479         </nav>
2480
2481     </li>
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496     <li class="md-nav__item md-nav__item--nested">
2497
2498
2499
2500
2501         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
2502
2503
2504           <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
2505
2506
2507   <span class="md-ellipsis">
2508     From WoltLab Suite 5.5
2509   </span>
2510
2511
2512             <span class="md-nav__icon md-icon"></span>
2513           </label>
2514
2515         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
2516           <label class="md-nav__title" for="__nav_6_2">
2517             <span class="md-nav__icon md-icon"></span>
2518             From WoltLab Suite 5.5
2519           </label>
2520           <ul class="md-nav__list" data-md-scrollfix>
2521
2522
2523
2524
2525
2526
2527     <li class="md-nav__item">
2528       <a href="../../wsc55/php/" class="md-nav__link">
2529
2530
2531   <span class="md-ellipsis">
2532     PHP API
2533   </span>
2534
2535
2536       </a>
2537     </li>
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547     <li class="md-nav__item">
2548       <a href="../../wsc55/javascript/" class="md-nav__link">
2549
2550
2551   <span class="md-ellipsis">
2552     TypeScript and JavaScript
2553   </span>
2554
2555
2556       </a>
2557     </li>
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567     <li class="md-nav__item">
2568       <a href="../../wsc55/templates/" class="md-nav__link">
2569
2570
2571   <span class="md-ellipsis">
2572     Templates
2573   </span>
2574
2575
2576       </a>
2577     </li>
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587     <li class="md-nav__item">
2588       <a href="../../wsc55/icons/" class="md-nav__link">
2589
2590
2591   <span class="md-ellipsis">
2592     Icons
2593   </span>
2594
2595
2596       </a>
2597     </li>
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607     <li class="md-nav__item">
2608       <a href="../../wsc55/dialogs/" class="md-nav__link">
2609
2610
2611   <span class="md-ellipsis">
2612     Dialogs
2613   </span>
2614
2615
2616       </a>
2617     </li>
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627     <li class="md-nav__item">
2628       <a href="../../wsc55/libraries/" class="md-nav__link">
2629
2630
2631   <span class="md-ellipsis">
2632     Third Party Libraries
2633   </span>
2634
2635
2636       </a>
2637     </li>
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647     <li class="md-nav__item">
2648       <a href="../../wsc55/deprecations_removals/" class="md-nav__link">
2649
2650
2651   <span class="md-ellipsis">
2652     Deprecations and Removals
2653   </span>
2654
2655
2656       </a>
2657     </li>
2658
2659
2660
2661
2662           </ul>
2663         </nav>
2664
2665     </li>
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680     <li class="md-nav__item md-nav__item--nested">
2681
2682
2683
2684
2685         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2686
2687
2688           <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2689
2690
2691   <span class="md-ellipsis">
2692     From WoltLab Suite 5.4
2693   </span>
2694
2695
2696             <span class="md-nav__icon md-icon"></span>
2697           </label>
2698
2699         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2700           <label class="md-nav__title" for="__nav_6_3">
2701             <span class="md-nav__icon md-icon"></span>
2702             From WoltLab Suite 5.4
2703           </label>
2704           <ul class="md-nav__list" data-md-scrollfix>
2705
2706
2707
2708
2709
2710
2711     <li class="md-nav__item">
2712       <a href="../../wsc54/php/" class="md-nav__link">
2713
2714
2715   <span class="md-ellipsis">
2716     PHP API
2717   </span>
2718
2719
2720       </a>
2721     </li>
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731     <li class="md-nav__item">
2732       <a href="../../wsc54/javascript/" class="md-nav__link">
2733
2734
2735   <span class="md-ellipsis">
2736     TypeScript and JavaScript
2737   </span>
2738
2739
2740       </a>
2741     </li>
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751     <li class="md-nav__item">
2752       <a href="../../wsc54/templates/" class="md-nav__link">
2753
2754
2755   <span class="md-ellipsis">
2756     Templates
2757   </span>
2758
2759
2760       </a>
2761     </li>
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771     <li class="md-nav__item">
2772       <a href="../../wsc54/libraries/" class="md-nav__link">
2773
2774
2775   <span class="md-ellipsis">
2776     Third Party Libraries
2777   </span>
2778
2779
2780       </a>
2781     </li>
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791     <li class="md-nav__item">
2792       <a href="../../wsc54/deprecations_removals/" class="md-nav__link">
2793
2794
2795   <span class="md-ellipsis">
2796     Deprecations and Removals
2797   </span>
2798
2799
2800       </a>
2801     </li>
2802
2803
2804
2805
2806           </ul>
2807         </nav>
2808
2809     </li>
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824     <li class="md-nav__item md-nav__item--nested">
2825
2826
2827
2828
2829         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2830
2831
2832           <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2833
2834
2835   <span class="md-ellipsis">
2836     From WoltLab Suite 5.3
2837   </span>
2838
2839
2840             <span class="md-nav__icon md-icon"></span>
2841           </label>
2842
2843         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2844           <label class="md-nav__title" for="__nav_6_4">
2845             <span class="md-nav__icon md-icon"></span>
2846             From WoltLab Suite 5.3
2847           </label>
2848           <ul class="md-nav__list" data-md-scrollfix>
2849
2850
2851
2852
2853
2854
2855     <li class="md-nav__item">
2856       <a href="../../wsc53/php/" class="md-nav__link">
2857
2858
2859   <span class="md-ellipsis">
2860     PHP API
2861   </span>
2862
2863
2864       </a>
2865     </li>
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875     <li class="md-nav__item">
2876       <a href="../../wsc53/session/" class="md-nav__link">
2877
2878
2879   <span class="md-ellipsis">
2880     Session Handling and Authentication
2881   </span>
2882
2883
2884       </a>
2885     </li>
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895     <li class="md-nav__item">
2896       <a href="../../wsc53/javascript/" class="md-nav__link">
2897
2898
2899   <span class="md-ellipsis">
2900     TypeScript and JavaScript
2901   </span>
2902
2903
2904       </a>
2905     </li>
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915     <li class="md-nav__item">
2916       <a href="../../wsc53/templates/" class="md-nav__link">
2917
2918
2919   <span class="md-ellipsis">
2920     Templates
2921   </span>
2922
2923
2924       </a>
2925     </li>
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935     <li class="md-nav__item">
2936       <a href="../../wsc53/libraries/" class="md-nav__link">
2937
2938
2939   <span class="md-ellipsis">
2940     Third Party Libraries
2941   </span>
2942
2943
2944       </a>
2945     </li>
2946
2947
2948
2949
2950           </ul>
2951         </nav>
2952
2953     </li>
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968     <li class="md-nav__item md-nav__item--nested">
2969
2970
2971
2972
2973         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2974
2975
2976           <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2977
2978
2979   <span class="md-ellipsis">
2980     From WoltLab Suite 5.2
2981   </span>
2982
2983
2984             <span class="md-nav__icon md-icon"></span>
2985           </label>
2986
2987         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2988           <label class="md-nav__title" for="__nav_6_5">
2989             <span class="md-nav__icon md-icon"></span>
2990             From WoltLab Suite 5.2
2991           </label>
2992           <ul class="md-nav__list" data-md-scrollfix>
2993
2994
2995
2996
2997
2998
2999     <li class="md-nav__item">
3000       <a href="../../wsc52/php/" class="md-nav__link">
3001
3002
3003   <span class="md-ellipsis">
3004     PHP API
3005   </span>
3006
3007
3008       </a>
3009     </li>
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019     <li class="md-nav__item">
3020       <a href="../../wsc52/templates/" class="md-nav__link">
3021
3022
3023   <span class="md-ellipsis">
3024     Templates and Languages
3025   </span>
3026
3027
3028       </a>
3029     </li>
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039     <li class="md-nav__item">
3040       <a href="../../wsc52/libraries/" class="md-nav__link">
3041
3042
3043   <span class="md-ellipsis">
3044     Third Party Libraries
3045   </span>
3046
3047
3048       </a>
3049     </li>
3050
3051
3052
3053
3054           </ul>
3055         </nav>
3056
3057     </li>
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
3075
3076
3077
3078
3079         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" checked>
3080
3081
3082           <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
3083
3084
3085   <span class="md-ellipsis">
3086     From WoltLab Suite 3.1
3087   </span>
3088
3089
3090             <span class="md-nav__icon md-icon"></span>
3091           </label>
3092
3093         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="true">
3094           <label class="md-nav__title" for="__nav_6_6">
3095             <span class="md-nav__icon md-icon"></span>
3096             From WoltLab Suite 3.1
3097           </label>
3098           <ul class="md-nav__list" data-md-scrollfix>
3099
3100
3101
3102
3103
3104
3105
3106
3107     <li class="md-nav__item md-nav__item--active">
3108
3109       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
3110
3111
3112
3113
3114
3115         <label class="md-nav__link md-nav__link--active" for="__toc">
3116
3117
3118   <span class="md-ellipsis">
3119     PHP API
3120   </span>
3121
3122
3123           <span class="md-nav__icon md-icon"></span>
3124         </label>
3125
3126       <a href="./" class="md-nav__link md-nav__link--active">
3127
3128
3129   <span class="md-ellipsis">
3130     PHP API
3131   </span>
3132
3133
3134       </a>
3135
3136
3137
3138 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
3139
3140
3141
3142
3143
3144
3145     <label class="md-nav__title" for="__toc">
3146       <span class="md-nav__icon md-icon"></span>
3147       Table of contents
3148     </label>
3149     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
3150
3151         <li class="md-nav__item">
3152   <a href="#form-builder" class="md-nav__link">
3153     Form Builder
3154   </a>
3155
3156 </li>
3157
3158         <li class="md-nav__item">
3159   <a href="#like-system" class="md-nav__link">
3160     Like System
3161   </a>
3162
3163 </li>
3164
3165         <li class="md-nav__item">
3166   <a href="#user-content-providers" class="md-nav__link">
3167     User Content Providers
3168   </a>
3169
3170     <nav class="md-nav" aria-label="User Content Providers">
3171       <ul class="md-nav__list">
3172
3173           <li class="md-nav__item">
3174   <a href="#php-class" class="md-nav__link">
3175     PHP Class
3176   </a>
3177
3178 </li>
3179
3180           <li class="md-nav__item">
3181   <a href="#object-type" class="md-nav__link">
3182     Object Type
3183   </a>
3184
3185     <nav class="md-nav" aria-label="Object Type">
3186       <ul class="md-nav__list">
3187
3188           <li class="md-nav__item">
3189   <a href="#nicevalue" class="md-nav__link">
3190     nicevalue
3191   </a>
3192
3193 </li>
3194
3195           <li class="md-nav__item">
3196   <a href="#hidden" class="md-nav__link">
3197     hidden
3198   </a>
3199
3200 </li>
3201
3202           <li class="md-nav__item">
3203   <a href="#requiredobjecttype" class="md-nav__link">
3204     requiredobjecttype
3205   </a>
3206
3207 </li>
3208
3209       </ul>
3210     </nav>
3211
3212 </li>
3213
3214       </ul>
3215     </nav>
3216
3217 </li>
3218
3219         <li class="md-nav__item">
3220   <a href="#php-database-api" class="md-nav__link">
3221     PHP Database API
3222   </a>
3223
3224 </li>
3225
3226     </ul>
3227
3228 </nav>
3229
3230     </li>
3231
3232
3233
3234
3235           </ul>
3236         </nav>
3237
3238     </li>
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253     <li class="md-nav__item md-nav__item--nested">
3254
3255
3256
3257
3258         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
3259
3260
3261           <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
3262
3263
3264   <span class="md-ellipsis">
3265     From WoltLab Suite 3.0
3266   </span>
3267
3268
3269             <span class="md-nav__icon md-icon"></span>
3270           </label>
3271
3272         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
3273           <label class="md-nav__title" for="__nav_6_7">
3274             <span class="md-nav__icon md-icon"></span>
3275             From WoltLab Suite 3.0
3276           </label>
3277           <ul class="md-nav__list" data-md-scrollfix>
3278
3279
3280
3281
3282
3283
3284     <li class="md-nav__item">
3285       <a href="../../wsc30/php/" class="md-nav__link">
3286
3287
3288   <span class="md-ellipsis">
3289     PHP API
3290   </span>
3291
3292
3293       </a>
3294     </li>
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304     <li class="md-nav__item">
3305       <a href="../../wsc30/javascript/" class="md-nav__link">
3306
3307
3308   <span class="md-ellipsis">
3309     JavaScript API
3310   </span>
3311
3312
3313       </a>
3314     </li>
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324     <li class="md-nav__item">
3325       <a href="../../wsc30/templates/" class="md-nav__link">
3326
3327
3328   <span class="md-ellipsis">
3329     Templates
3330   </span>
3331
3332
3333       </a>
3334     </li>
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344     <li class="md-nav__item">
3345       <a href="../../wsc30/css/" class="md-nav__link">
3346
3347
3348   <span class="md-ellipsis">
3349     CSS
3350   </span>
3351
3352
3353       </a>
3354     </li>
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364     <li class="md-nav__item">
3365       <a href="../../wsc30/package/" class="md-nav__link">
3366
3367
3368   <span class="md-ellipsis">
3369     Package Components
3370   </span>
3371
3372
3373       </a>
3374     </li>
3375
3376
3377
3378
3379           </ul>
3380         </nav>
3381
3382     </li>
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397     <li class="md-nav__item md-nav__item--nested">
3398
3399
3400
3401
3402         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_8" >
3403
3404
3405           <label class="md-nav__link" for="__nav_6_8" id="__nav_6_8_label" tabindex="0">
3406
3407
3408   <span class="md-ellipsis">
3409     From WCF 2.1
3410   </span>
3411
3412
3413             <span class="md-nav__icon md-icon"></span>
3414           </label>
3415
3416         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_8_label" aria-expanded="false">
3417           <label class="md-nav__title" for="__nav_6_8">
3418             <span class="md-nav__icon md-icon"></span>
3419             From WCF 2.1
3420           </label>
3421           <ul class="md-nav__list" data-md-scrollfix>
3422
3423
3424
3425
3426
3427
3428     <li class="md-nav__item">
3429       <a href="../../wcf21/php/" class="md-nav__link">
3430
3431
3432   <span class="md-ellipsis">
3433     PHP API
3434   </span>
3435
3436
3437       </a>
3438     </li>
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448     <li class="md-nav__item">
3449       <a href="../../wcf21/templates/" class="md-nav__link">
3450
3451
3452   <span class="md-ellipsis">
3453     Templates
3454   </span>
3455
3456
3457       </a>
3458     </li>
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468     <li class="md-nav__item">
3469       <a href="../../wcf21/css/" class="md-nav__link">
3470
3471
3472   <span class="md-ellipsis">
3473     CSS
3474   </span>
3475
3476
3477       </a>
3478     </li>
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488     <li class="md-nav__item">
3489       <a href="../../wcf21/package/" class="md-nav__link">
3490
3491
3492   <span class="md-ellipsis">
3493     Package Components
3494   </span>
3495
3496
3497       </a>
3498     </li>
3499
3500
3501
3502
3503           </ul>
3504         </nav>
3505
3506     </li>
3507
3508
3509
3510
3511           </ul>
3512         </nav>
3513
3514     </li>
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528     <li class="md-nav__item md-nav__item--nested">
3529
3530
3531
3532
3533         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
3534
3535
3536           <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
3537
3538
3539   <span class="md-ellipsis">
3540     Tutorials
3541   </span>
3542
3543
3544             <span class="md-nav__icon md-icon"></span>
3545           </label>
3546
3547         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
3548           <label class="md-nav__title" for="__nav_7">
3549             <span class="md-nav__icon md-icon"></span>
3550             Tutorials
3551           </label>
3552           <ul class="md-nav__list" data-md-scrollfix>
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564     <li class="md-nav__item md-nav__item--nested">
3565
3566
3567
3568
3569         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
3570
3571
3572           <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
3573
3574
3575   <span class="md-ellipsis">
3576     Tutorial Series
3577   </span>
3578
3579
3580             <span class="md-nav__icon md-icon"></span>
3581           </label>
3582
3583         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
3584           <label class="md-nav__title" for="__nav_7_1">
3585             <span class="md-nav__icon md-icon"></span>
3586             Tutorial Series
3587           </label>
3588           <ul class="md-nav__list" data-md-scrollfix>
3589
3590
3591
3592
3593
3594
3595     <li class="md-nav__item">
3596       <a href="../../../tutorial/series/overview/" class="md-nav__link">
3597
3598
3599   <span class="md-ellipsis">
3600     Overview
3601   </span>
3602
3603
3604       </a>
3605     </li>
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615     <li class="md-nav__item">
3616       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
3617
3618
3619   <span class="md-ellipsis">
3620     Part 1
3621   </span>
3622
3623
3624       </a>
3625     </li>
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635     <li class="md-nav__item">
3636       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
3637
3638
3639   <span class="md-ellipsis">
3640     Part 2
3641   </span>
3642
3643
3644       </a>
3645     </li>
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655     <li class="md-nav__item">
3656       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
3657
3658
3659   <span class="md-ellipsis">
3660     Part 3
3661   </span>
3662
3663
3664       </a>
3665     </li>
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675     <li class="md-nav__item">
3676       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
3677
3678
3679   <span class="md-ellipsis">
3680     Part 4
3681   </span>
3682
3683
3684       </a>
3685     </li>
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695     <li class="md-nav__item">
3696       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
3697
3698
3699   <span class="md-ellipsis">
3700     Part 5
3701   </span>
3702
3703
3704       </a>
3705     </li>
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715     <li class="md-nav__item">
3716       <a href="../../../tutorial/series/part_6/" class="md-nav__link">
3717
3718
3719   <span class="md-ellipsis">
3720     Part 6
3721   </span>
3722
3723
3724       </a>
3725     </li>
3726
3727
3728
3729
3730           </ul>
3731         </nav>
3732
3733     </li>
3734
3735
3736
3737
3738           </ul>
3739         </nav>
3740
3741     </li>
3742
3743
3744
3745   </ul>
3746 </nav>
3747                   </div>
3748                 </div>
3749               </div>
3750
3751
3752
3753               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
3754                 <div class="md-sidebar__scrollwrap">
3755                   <div class="md-sidebar__inner">
3756
3757
3758 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
3759
3760
3761
3762
3763
3764
3765     <label class="md-nav__title" for="__toc">
3766       <span class="md-nav__icon md-icon"></span>
3767       Table of contents
3768     </label>
3769     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
3770
3771         <li class="md-nav__item">
3772   <a href="#form-builder" class="md-nav__link">
3773     Form Builder
3774   </a>
3775
3776 </li>
3777
3778         <li class="md-nav__item">
3779   <a href="#like-system" class="md-nav__link">
3780     Like System
3781   </a>
3782
3783 </li>
3784
3785         <li class="md-nav__item">
3786   <a href="#user-content-providers" class="md-nav__link">
3787     User Content Providers
3788   </a>
3789
3790     <nav class="md-nav" aria-label="User Content Providers">
3791       <ul class="md-nav__list">
3792
3793           <li class="md-nav__item">
3794   <a href="#php-class" class="md-nav__link">
3795     PHP Class
3796   </a>
3797
3798 </li>
3799
3800           <li class="md-nav__item">
3801   <a href="#object-type" class="md-nav__link">
3802     Object Type
3803   </a>
3804
3805     <nav class="md-nav" aria-label="Object Type">
3806       <ul class="md-nav__list">
3807
3808           <li class="md-nav__item">
3809   <a href="#nicevalue" class="md-nav__link">
3810     nicevalue
3811   </a>
3812
3813 </li>
3814
3815           <li class="md-nav__item">
3816   <a href="#hidden" class="md-nav__link">
3817     hidden
3818   </a>
3819
3820 </li>
3821
3822           <li class="md-nav__item">
3823   <a href="#requiredobjecttype" class="md-nav__link">
3824     requiredobjecttype
3825   </a>
3826
3827 </li>
3828
3829       </ul>
3830     </nav>
3831
3832 </li>
3833
3834       </ul>
3835     </nav>
3836
3837 </li>
3838
3839         <li class="md-nav__item">
3840   <a href="#php-database-api" class="md-nav__link">
3841     PHP Database API
3842   </a>
3843
3844 </li>
3845
3846     </ul>
3847
3848 </nav>
3849                   </div>
3850                 </div>
3851               </div>
3852
3853
3854
3855             <div class="md-content" data-md-component="content">
3856               <article class="md-content__inner md-typeset">
3857
3858
3859
3860
3861
3862
3863
3864 <h1 id="migrating-from-wsc-31-php">Migrating from WSC 3.1 - PHP<a class="headerlink" href="#migrating-from-wsc-31-php" title="Permanent link">#</a></h1>
3865 <h2 id="form-builder">Form Builder<a class="headerlink" href="#form-builder" title="Permanent link">#</a></h2>
3866 <p>WoltLab Suite Core 5.2 introduces a new, simpler and quicker way of creating forms:
3867 <a href="../../../php/api/form_builder/overview/">form builder</a>.
3868 You can find examples of how to migrate existing forms to form builder <a href="../form-builder/">here</a>.</p>
3869 <p>In the near future, to ensure backwards compatibility within WoltLab packages, we will only use form builder for new forms or for major rewrites of existing forms that would break backwards compatibility anyway.</p>
3870 <h2 id="like-system">Like System<a class="headerlink" href="#like-system" title="Permanent link">#</a></h2>
3871 <p>WoltLab Suite Core 5.2 replaced the like system with the reaction system. You can find the migration guide <a href="../like/">here</a>.</p>
3872 <h2 id="user-content-providers">User Content Providers<a class="headerlink" href="#user-content-providers" title="Permanent link">#</a></h2>
3873 <p>User content providers help the WoltLab Suite to find user generated content. They provide a class with which you can find content from a particular user and delete objects.</p>
3874 <h3 id="php-class">PHP Class<a class="headerlink" href="#php-class" title="Permanent link">#</a></h3>
3875 <p>First, we create the PHP class that provides our interface to provide the data. The class must implement interface <code>wcf\system\user\content\provider\IUserContentProvider</code> in any case. Mostly we process data which is based on <a href="../../../php/database-objects/"><code>wcf\data\DatabaseObject</code></a>. In this case, the WoltLab Suite provides an abstract class <code>wcf\system\user\content\provider\AbstractDatabaseUserContentProvider</code> that can be used to automatically generates the standardized classes to generate the list and deletes objects via the DatabaseObjectAction. For example, if we would create a content provider for comments, the class would look like this: </p>
3876 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/system/user/content/provider/CommentUserContentProvider.class.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3877 <span class="normal"> 2</span>
3878 <span class="normal"> 3</span>
3879 <span class="normal"> 4</span>
3880 <span class="normal"> 5</span>
3881 <span class="normal"> 6</span>
3882 <span class="normal"> 7</span>
3883 <span class="normal"> 8</span>
3884 <span class="normal"> 9</span>
3885 <span class="normal">10</span>
3886 <span class="normal">11</span>
3887 <span class="normal">12</span>
3888 <span class="normal">13</span>
3889 <span class="normal">14</span>
3890 <span class="normal">15</span>
3891 <span class="normal">16</span>
3892 <span class="normal">17</span>
3893 <span class="normal">18</span>
3894 <span class="normal">19</span>
3895 <span class="normal">20</span>
3896 <span class="normal">21</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3897 <span class="k">namespace</span> <span class="nx">wcf\system\user\content\provider</span><span class="p">;</span>
3898 <span class="k">use</span> <span class="nx">wcf\data\comment\Comment</span><span class="p">;</span>
3899
3900 <span class="sd">/**</span>
3901 <span class="sd"> * User content provider for comments.</span>
3902 <span class="sd"> *</span>
3903 <span class="sd"> * @author  Joshua Ruesweg</span>
3904 <span class="sd"> * @copyright   2001-2018 WoltLab GmbH</span>
3905 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
3906 <span class="sd"> * @package WoltLabSuite\Core\System\User\Content\Provider</span>
3907 <span class="sd"> * @since   5.2</span>
3908 <span class="sd"> */</span>
3909 <span class="k">class</span> <span class="nc">CommentUserContentProvider</span> <span class="k">extends</span> <span class="nx">AbstractDatabaseUserContentProvider</span> <span class="p">{</span>
3910     <span class="sd">/**</span>
3911 <span class="sd">     * @inheritdoc</span>
3912 <span class="sd">     */</span>
3913     <span class="k">public</span> <span class="k">static</span> <span class="k">function</span> <span class="nf">getDatabaseObjectClass</span><span class="p">()</span> <span class="p">{</span>
3914         <span class="k">return</span> <span class="nx">Comment</span><span class="o">::</span><span class="na">class</span><span class="p">;</span>
3915     <span class="p">}</span>
3916 <span class="p">}</span>
3917 </code></pre></div></td></tr></table></div>
3918 <h3 id="object-type">Object Type<a class="headerlink" href="#object-type" title="Permanent link">#</a></h3>
3919 <p>Now the appropriate object type must be created for the class. This object type must be from the definition <code>com.woltlab.wcf.content.userContentProvider</code> and include the previous created class as FQN in the parameter <code>classname</code>. Also the following parameters can be used in the object type: </p>
3920 <h4 id="nicevalue"><code>nicevalue</code><a class="headerlink" href="#nicevalue" title="Permanent link">#</a></h4>
3921 <p><span class="label label-info">Optional</span></p>
3922 <p>The nice value is used to determine the order in which the remove content worker are execute the provider. Content provider with lower nice values are executed first.</p>
3923 <h4 id="hidden"><code>hidden</code><a class="headerlink" href="#hidden" title="Permanent link">#</a></h4>
3924 <p><span class="label label-info">Optional</span></p>
3925 <p>Specifies whether or not this content provider can be actively selected in the Content Remove Worker. If it cannot be selected, it will not be executed automatically! </p>
3926 <h4 id="requiredobjecttype"><code>requiredobjecttype</code><a class="headerlink" href="#requiredobjecttype" title="Permanent link">#</a></h4>
3927 <p><span class="label label-info">Optional</span></p>
3928 <p>The specified list of comma-separated object types are automatically removed during content removal when this object type is being removed.
3929 <strong>Attention</strong>: The order of removal is undefined by default, specify a <code>nicevalue</code> if the order is important.</p>
3930 <h2 id="php-database-api">PHP Database API<a class="headerlink" href="#php-database-api" title="Permanent link">#</a></h2>
3931 <p>WoltLab Suite 5.2 introduces a new way to update the database scheme:
3932 <a href="../../../package/database-php-api/">database PHP API</a>.</p>
3933
3934   <hr>
3935 <div class="md-source-file">
3936   <small>
3937
3938       Last update:
3939       2021-12-16
3940
3941   </small>
3942 </div>
3943
3944
3945
3946
3947
3948
3949               </article>
3950             </div>
3951
3952
3953         </div>
3954
3955       </main>
3956
3957         <footer class="md-footer">
3958
3959   <div class="md-footer-meta md-typeset">
3960     <div class="md-footer-meta__inner md-grid">
3961       <div class="md-copyright">
3962
3963     <div class="md-copyright__highlight">
3964       Copyright © 2020 WoltLab GmbH
3965     </div>
3966
3967
3968     Made with
3969     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3970       Material for MkDocs
3971     </a>
3972
3973 </div>
3974
3975         <div class="md-copyright">
3976         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
3977         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
3978 </div>
3979
3980     </div>
3981   </div>
3982 </footer>
3983
3984     </div>
3985     <div class="md-dialog" data-md-component="dialog">
3986       <div class="md-dialog__inner md-typeset"></div>
3987     </div>
3988
3989     <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.a264c092.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>
3990
3991
3992       <script src="../../../assets/javascripts/bundle.726fbb30.min.js"></script>
3993
3994
3995   </body>
3996 </html>