5.4/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
  12       <link rel="icon" href="../../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0">
  14
  15
  16
  17         <title>PHP API - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../../assets/stylesheets/main.33e2939f.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  39
  40
  41
  42
  43
  44   </head>
  45
  46
  47
  48
  49
  50
  51
  52     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  53
  54
  55     <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
  56
  57     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  58     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  59     <label class="md-overlay" for="__drawer"></label>
  60     <div data-md-component="skip">
  61
  62
  63         <a href="#migrating-from-wsc-31-php" class="md-skip">
  64           Skip to content
  65         </a>
  66
  67     </div>
  68     <div data-md-component="announce">
  69
  70         <aside class="md-announce">
  71           <div class="md-announce__inner md-grid md-typeset">
  72
  73     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  74
  75           </div>
  76         </aside>
  77
  78     </div>
  79
  80       <header class="md-header" data-md-component="header">
  81   <nav class="md-header__inner md-grid" aria-label="Header">
  82     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  83
  84   <img src="../../../assets/logo.png" alt="logo">
  85
  86     </a>
  87     <label class="md-header__button md-icon" for="__drawer">
  88       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  89     </label>
  90     <div class="md-header__title" data-md-component="header-title">
  91       <div class="md-header__ellipsis">
  92         <div class="md-header__topic">
  93           <span class="md-ellipsis">
  94             WoltLab Suite Documentation
  95           </span>
  96         </div>
  97         <div class="md-header__topic" data-md-component="header-topic">
  98           <span class="md-ellipsis">
  99
 100               PHP API
 101
 102           </span>
 103         </div>
 104       </div>
 105     </div>
 106
 107
 108
 109       <label class="md-header__button md-icon" for="__search">
 110         <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>
 111       </label>
 112
 113 <div class="md-search" data-md-component="search" role="dialog">
 114   <label class="md-search__overlay" for="__search"></label>
 115   <div class="md-search__inner" role="search">
 116     <form class="md-search__form" name="search">
 117       <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" data-md-state="active" required>
 118       <label class="md-search__icon md-icon" for="__search">
 119         <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>
 120         <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>
 121       </label>
 122       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 123         <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>
 124       </button>
 125     </form>
 126     <div class="md-search__output">
 127       <div class="md-search__scrollwrap" data-md-scrollfix>
 128         <div class="md-search-result" data-md-component="search-result">
 129           <div class="md-search-result__meta">
 130             Initializing search
 131           </div>
 132           <ol class="md-search-result__list"></ol>
 133         </div>
 134       </div>
 135     </div>
 136   </div>
 137 </div>
 138
 139
 140       <div class="md-header__source">
 141
 142 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 143   <div class="md-source__icon md-icon">
 144
 145     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
 146   </div>
 147   <div class="md-source__repository">
 148     GitHub
 149   </div>
 150 </a>
 151       </div>
 152
 153   </nav>
 154 </header>
 155
 156     <div class="md-container" data-md-component="container">
 157
 158
 159
 160
 161       <main class="md-main" data-md-component="main">
 162         <div class="md-main__inner md-grid">
 163
 164
 165
 166               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 167                 <div class="md-sidebar__scrollwrap">
 168                   <div class="md-sidebar__inner">
 169
 170
 171
 172 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 173   <label class="md-nav__title" for="__drawer">
 174     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 175
 176   <img src="../../../assets/logo.png" alt="logo">
 177
 178     </a>
 179     WoltLab Suite Documentation
 180   </label>
 181
 182     <div class="md-nav__source">
 183
 184 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 185   <div class="md-source__icon md-icon">
 186
 187     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><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>
 188   </div>
 189   <div class="md-source__repository">
 190     GitHub
 191   </div>
 192 </a>
 193     </div>
 194
 195   <ul class="md-nav__list" data-md-scrollfix>
 196
 197
 198
 199
 200
 201
 202
 203
 204     <li class="md-nav__item">
 205       <a href="../../../getting-started/" class="md-nav__link">
 206         Getting Started
 207       </a>
 208     </li>
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220     <li class="md-nav__item md-nav__item--nested">
 221
 222
 223         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 224
 225       <label class="md-nav__link" for="__nav_2">
 226         PHP API
 227         <span class="md-nav__icon md-icon"></span>
 228       </label>
 229       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 230         <label class="md-nav__title" for="__nav_2">
 231           <span class="md-nav__icon md-icon"></span>
 232           PHP API
 233         </label>
 234         <ul class="md-nav__list" data-md-scrollfix>
 235
 236
 237
 238
 239
 240     <li class="md-nav__item">
 241       <a href="../../../php/pages/" class="md-nav__link">
 242         Pages
 243       </a>
 244     </li>
 245
 246
 247
 248
 249
 250
 251
 252     <li class="md-nav__item">
 253       <a href="../../../php/database-objects/" class="md-nav__link">
 254         Database Objects
 255       </a>
 256     </li>
 257
 258
 259
 260
 261
 262
 263
 264     <li class="md-nav__item">
 265       <a href="../../../php/database-access/" class="md-nav__link">
 266         Database Access
 267       </a>
 268     </li>
 269
 270
 271
 272
 273
 274
 275
 276     <li class="md-nav__item">
 277       <a href="../../../php/exceptions/" class="md-nav__link">
 278         Exceptions
 279       </a>
 280     </li>
 281
 282
 283
 284
 285
 286
 287
 288
 289     <li class="md-nav__item md-nav__item--nested">
 290
 291
 292         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 293
 294       <label class="md-nav__link" for="__nav_2_5">
 295         API
 296         <span class="md-nav__icon md-icon"></span>
 297       </label>
 298       <nav class="md-nav" aria-label="API" data-md-level="2">
 299         <label class="md-nav__title" for="__nav_2_5">
 300           <span class="md-nav__icon md-icon"></span>
 301           API
 302         </label>
 303         <ul class="md-nav__list" data-md-scrollfix>
 304
 305
 306
 307
 308
 309     <li class="md-nav__item">
 310       <a href="../../../php/api/caches/" class="md-nav__link">
 311         Caches
 312       </a>
 313     </li>
 314
 315
 316
 317
 318
 319
 320
 321     <li class="md-nav__item">
 322       <a href="../../../php/api/comments/" class="md-nav__link">
 323         Comments
 324       </a>
 325     </li>
 326
 327
 328
 329
 330
 331
 332
 333     <li class="md-nav__item">
 334       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 335         Cronjobs
 336       </a>
 337     </li>
 338
 339
 340
 341
 342
 343
 344
 345     <li class="md-nav__item">
 346       <a href="../../../php/api/events/" class="md-nav__link">
 347         Events
 348       </a>
 349     </li>
 350
 351
 352
 353
 354
 355
 356
 357
 358     <li class="md-nav__item md-nav__item--nested">
 359
 360
 361         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 362
 363       <label class="md-nav__link" for="__nav_2_5_5">
 364         Form Builder
 365         <span class="md-nav__icon md-icon"></span>
 366       </label>
 367       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 368         <label class="md-nav__title" for="__nav_2_5_5">
 369           <span class="md-nav__icon md-icon"></span>
 370           Form Builder
 371         </label>
 372         <ul class="md-nav__list" data-md-scrollfix>
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390     <li class="md-nav__item">
 391       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 392         Structure
 393       </a>
 394     </li>
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 404         Fields
 405       </a>
 406     </li>
 407
 408
 409
 410
 411
 412
 413
 414     <li class="md-nav__item">
 415       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 416         Validation and Data
 417       </a>
 418     </li>
 419
 420
 421
 422
 423
 424
 425
 426     <li class="md-nav__item">
 427       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 428         Dependencies
 429       </a>
 430     </li>
 431
 432
 433
 434         </ul>
 435       </nav>
 436     </li>
 437
 438
 439
 440
 441
 442
 443
 444     <li class="md-nav__item">
 445       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 446         Package Installation Plugins
 447       </a>
 448     </li>
 449
 450
 451
 452
 453
 454
 455
 456     <li class="md-nav__item">
 457       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 458         User Activity Points
 459       </a>
 460     </li>
 461
 462
 463
 464
 465
 466
 467
 468     <li class="md-nav__item">
 469       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 470         User Notifications
 471       </a>
 472     </li>
 473
 474
 475
 476
 477
 478
 479
 480     <li class="md-nav__item">
 481       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 482         Sitemaps
 483       </a>
 484     </li>
 485
 486
 487
 488         </ul>
 489       </nav>
 490     </li>
 491
 492
 493
 494
 495
 496
 497
 498     <li class="md-nav__item">
 499       <a href="../../../php/code-style/" class="md-nav__link">
 500         Code Style
 501       </a>
 502     </li>
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../../php/apps/" class="md-nav__link">
 512         Apps
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522     <li class="md-nav__item">
 523       <a href="../../../php/gdpr/" class="md-nav__link">
 524         GDPR
 525       </a>
 526     </li>
 527
 528
 529
 530         </ul>
 531       </nav>
 532     </li>
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544     <li class="md-nav__item md-nav__item--nested">
 545
 546
 547         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 548
 549       <label class="md-nav__link" for="__nav_3">
 550         Languages, Templates & CSS
 551         <span class="md-nav__icon md-icon"></span>
 552       </label>
 553       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 554         <label class="md-nav__title" for="__nav_3">
 555           <span class="md-nav__icon md-icon"></span>
 556           Languages, Templates & CSS
 557         </label>
 558         <ul class="md-nav__list" data-md-scrollfix>
 559
 560
 561
 562
 563
 564     <li class="md-nav__item">
 565       <a href="../../../view/languages/" class="md-nav__link">
 566         Languages
 567       </a>
 568     </li>
 569
 570
 571
 572
 573
 574
 575
 576     <li class="md-nav__item">
 577       <a href="../../../view/templates/" class="md-nav__link">
 578         Templates
 579       </a>
 580     </li>
 581
 582
 583
 584
 585
 586
 587
 588     <li class="md-nav__item">
 589       <a href="../../../view/css/" class="md-nav__link">
 590         CSS
 591       </a>
 592     </li>
 593
 594
 595
 596         </ul>
 597       </nav>
 598     </li>
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610     <li class="md-nav__item md-nav__item--nested">
 611
 612
 613         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 614
 615       <label class="md-nav__link" for="__nav_4">
 616         TypeScript and JavaScript API
 617         <span class="md-nav__icon md-icon"></span>
 618       </label>
 619       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 620         <label class="md-nav__title" for="__nav_4">
 621           <span class="md-nav__icon md-icon"></span>
 622           TypeScript and JavaScript API
 623         </label>
 624         <ul class="md-nav__list" data-md-scrollfix>
 625
 626
 627
 628
 629
 630     <li class="md-nav__item">
 631       <a href="../../../javascript/general-usage/" class="md-nav__link">
 632         General Usage
 633       </a>
 634     </li>
 635
 636
 637
 638
 639
 640
 641
 642     <li class="md-nav__item">
 643       <a href="../../../javascript/typescript/" class="md-nav__link">
 644         TypeScript
 645       </a>
 646     </li>
 647
 648
 649
 650
 651
 652
 653
 654
 655     <li class="md-nav__item md-nav__item--nested">
 656
 657
 658         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 659
 660       <label class="md-nav__link" for="__nav_4_3">
 661         New API
 662         <span class="md-nav__icon md-icon"></span>
 663       </label>
 664       <nav class="md-nav" aria-label="New API" data-md-level="2">
 665         <label class="md-nav__title" for="__nav_4_3">
 666           <span class="md-nav__icon md-icon"></span>
 667           New API
 668         </label>
 669         <ul class="md-nav__list" data-md-scrollfix>
 670
 671
 672
 673
 674
 675     <li class="md-nav__item">
 676       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 677         Writing a module
 678       </a>
 679     </li>
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item">
 688       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 689         Data Structures
 690       </a>
 691     </li>
 692
 693
 694
 695
 696
 697
 698
 699     <li class="md-nav__item">
 700       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 701         Core Functions
 702       </a>
 703     </li>
 704
 705
 706
 707
 708
 709
 710
 711     <li class="md-nav__item">
 712       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 713         DOM
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 725         Event Handling
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735     <li class="md-nav__item">
 736       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 737         Ajax
 738       </a>
 739     </li>
 740
 741
 742
 743
 744
 745
 746
 747     <li class="md-nav__item">
 748       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 749         Dialogs
 750       </a>
 751     </li>
 752
 753
 754
 755
 756
 757
 758
 759     <li class="md-nav__item">
 760       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 761         Browser and Screen Sizes
 762       </a>
 763     </li>
 764
 765
 766
 767
 768
 769
 770
 771     <li class="md-nav__item">
 772       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 773         User Interface
 774       </a>
 775     </li>
 776
 777
 778
 779         </ul>
 780       </nav>
 781     </li>
 782
 783
 784
 785
 786
 787
 788
 789     <li class="md-nav__item">
 790       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 791         Legacy API
 792       </a>
 793     </li>
 794
 795
 796
 797
 798
 799
 800
 801     <li class="md-nav__item">
 802       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 803         Helper Functions
 804       </a>
 805     </li>
 806
 807
 808
 809
 810
 811
 812
 813     <li class="md-nav__item">
 814       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 815         Code Snippets
 816       </a>
 817     </li>
 818
 819
 820
 821         </ul>
 822       </nav>
 823     </li>
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835     <li class="md-nav__item md-nav__item--nested">
 836
 837
 838         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 839
 840       <label class="md-nav__link" for="__nav_5">
 841         Package Components
 842         <span class="md-nav__icon md-icon"></span>
 843       </label>
 844       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 845         <label class="md-nav__title" for="__nav_5">
 846           <span class="md-nav__icon md-icon"></span>
 847           Package Components
 848         </label>
 849         <ul class="md-nav__list" data-md-scrollfix>
 850
 851
 852
 853
 854
 855     <li class="md-nav__item">
 856       <a href="../../../package/package-xml/" class="md-nav__link">
 857         package.xml
 858       </a>
 859     </li>
 860
 861
 862
 863
 864
 865
 866
 867
 868     <li class="md-nav__item md-nav__item--nested">
 869
 870
 871         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
 872
 873       <label class="md-nav__link" for="__nav_5_2">
 874         PIPs
 875         <span class="md-nav__icon md-icon"></span>
 876       </label>
 877       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 878         <label class="md-nav__title" for="__nav_5_2">
 879           <span class="md-nav__icon md-icon"></span>
 880           PIPs
 881         </label>
 882         <ul class="md-nav__list" data-md-scrollfix>
 883
 884
 885
 886
 887
 888     <li class="md-nav__item">
 889       <a href="../../../package/pip/" class="md-nav__link">
 890         Overview
 891       </a>
 892     </li>
 893
 894
 895
 896
 897
 898
 899
 900     <li class="md-nav__item">
 901       <a href="../../../package/pip/acl-option/" class="md-nav__link">
 902         aclOption
 903       </a>
 904     </li>
 905
 906
 907
 908
 909
 910
 911
 912     <li class="md-nav__item">
 913       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
 914         acpMenu
 915       </a>
 916     </li>
 917
 918
 919
 920
 921
 922
 923
 924     <li class="md-nav__item">
 925       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
 926         acpSearchProvider
 927       </a>
 928     </li>
 929
 930
 931
 932
 933
 934
 935
 936     <li class="md-nav__item">
 937       <a href="../../../package/pip/acp-template/" class="md-nav__link">
 938         acpTemplate
 939       </a>
 940     </li>
 941
 942
 943
 944
 945
 946
 947
 948     <li class="md-nav__item">
 949       <a href="../../../package/pip/bbcode/" class="md-nav__link">
 950         bbcode
 951       </a>
 952     </li>
 953
 954
 955
 956
 957
 958
 959
 960     <li class="md-nav__item">
 961       <a href="../../../package/pip/box/" class="md-nav__link">
 962         box
 963       </a>
 964     </li>
 965
 966
 967
 968
 969
 970
 971
 972     <li class="md-nav__item">
 973       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
 974         clipboardAction
 975       </a>
 976     </li>
 977
 978
 979
 980
 981
 982
 983
 984     <li class="md-nav__item">
 985       <a href="../../../package/pip/core-object/" class="md-nav__link">
 986         coreObject
 987       </a>
 988     </li>
 989
 990
 991
 992
 993
 994
 995
 996     <li class="md-nav__item">
 997       <a href="../../../package/pip/cronjob/" class="md-nav__link">
 998         cronjob
 999       </a>
1000     </li>
1001
1002
1003
1004
1005
1006
1007
1008     <li class="md-nav__item">
1009       <a href="../../../package/pip/event-listener/" class="md-nav__link">
1010         eventListener
1011       </a>
1012     </li>
1013
1014
1015
1016
1017
1018
1019
1020     <li class="md-nav__item">
1021       <a href="../../../package/pip/file/" class="md-nav__link">
1022         file
1023       </a>
1024     </li>
1025
1026
1027
1028
1029
1030
1031
1032     <li class="md-nav__item">
1033       <a href="../../../package/pip/language/" class="md-nav__link">
1034         language
1035       </a>
1036     </li>
1037
1038
1039
1040
1041
1042
1043
1044     <li class="md-nav__item">
1045       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1046         mediaProvider
1047       </a>
1048     </li>
1049
1050
1051
1052
1053
1054
1055
1056     <li class="md-nav__item">
1057       <a href="../../../package/pip/menu/" class="md-nav__link">
1058         menu
1059       </a>
1060     </li>
1061
1062
1063
1064
1065
1066
1067
1068     <li class="md-nav__item">
1069       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1070         menuItem
1071       </a>
1072     </li>
1073
1074
1075
1076
1077
1078
1079
1080     <li class="md-nav__item">
1081       <a href="../../../package/pip/object-type/" class="md-nav__link">
1082         objectType
1083       </a>
1084     </li>
1085
1086
1087
1088
1089
1090
1091
1092     <li class="md-nav__item">
1093       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1094         objectTypeDefinition
1095       </a>
1096     </li>
1097
1098
1099
1100
1101
1102
1103
1104     <li class="md-nav__item">
1105       <a href="../../../package/pip/option/" class="md-nav__link">
1106         option
1107       </a>
1108     </li>
1109
1110
1111
1112
1113
1114
1115
1116     <li class="md-nav__item">
1117       <a href="../../../package/pip/page/" class="md-nav__link">
1118         page
1119       </a>
1120     </li>
1121
1122
1123
1124
1125
1126
1127
1128     <li class="md-nav__item">
1129       <a href="../../../package/pip/pip/" class="md-nav__link">
1130         pip
1131       </a>
1132     </li>
1133
1134
1135
1136
1137
1138
1139
1140     <li class="md-nav__item">
1141       <a href="../../../package/pip/script/" class="md-nav__link">
1142         script
1143       </a>
1144     </li>
1145
1146
1147
1148
1149
1150
1151
1152     <li class="md-nav__item">
1153       <a href="../../../package/pip/smiley/" class="md-nav__link">
1154         smiley
1155       </a>
1156     </li>
1157
1158
1159
1160
1161
1162
1163
1164     <li class="md-nav__item">
1165       <a href="../../../package/pip/sql/" class="md-nav__link">
1166         sql
1167       </a>
1168     </li>
1169
1170
1171
1172
1173
1174
1175
1176     <li class="md-nav__item">
1177       <a href="../../../package/pip/style/" class="md-nav__link">
1178         style
1179       </a>
1180     </li>
1181
1182
1183
1184
1185
1186
1187
1188     <li class="md-nav__item">
1189       <a href="../../../package/pip/template/" class="md-nav__link">
1190         template
1191       </a>
1192     </li>
1193
1194
1195
1196
1197
1198
1199
1200     <li class="md-nav__item">
1201       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1202         templateListener
1203       </a>
1204     </li>
1205
1206
1207
1208
1209
1210
1211
1212     <li class="md-nav__item">
1213       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1214         userGroupOption
1215       </a>
1216     </li>
1217
1218
1219
1220
1221
1222
1223
1224     <li class="md-nav__item">
1225       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1226         userMenu
1227       </a>
1228     </li>
1229
1230
1231
1232
1233
1234
1235
1236     <li class="md-nav__item">
1237       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1238         userNotificationEvent
1239       </a>
1240     </li>
1241
1242
1243
1244
1245
1246
1247
1248     <li class="md-nav__item">
1249       <a href="../../../package/pip/user-option/" class="md-nav__link">
1250         userOption
1251       </a>
1252     </li>
1253
1254
1255
1256
1257
1258
1259
1260     <li class="md-nav__item">
1261       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1262         userProfileMenu
1263       </a>
1264     </li>
1265
1266
1267
1268         </ul>
1269       </nav>
1270     </li>
1271
1272
1273
1274
1275
1276
1277
1278     <li class="md-nav__item">
1279       <a href="../../../package/database-php-api/" class="md-nav__link">
1280         Database PHP API
1281       </a>
1282     </li>
1283
1284
1285
1286         </ul>
1287       </nav>
1288     </li>
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1303
1304
1305         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
1306
1307       <label class="md-nav__link" for="__nav_6">
1308         Migration
1309         <span class="md-nav__icon md-icon"></span>
1310       </label>
1311       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1312         <label class="md-nav__title" for="__nav_6">
1313           <span class="md-nav__icon md-icon"></span>
1314           Migration
1315         </label>
1316         <ul class="md-nav__list" data-md-scrollfix>
1317
1318
1319
1320
1321
1322
1323     <li class="md-nav__item md-nav__item--nested">
1324
1325
1326         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1327
1328       <label class="md-nav__link" for="__nav_6_1">
1329         Migrating from WSC 5.3
1330         <span class="md-nav__icon md-icon"></span>
1331       </label>
1332       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1333         <label class="md-nav__title" for="__nav_6_1">
1334           <span class="md-nav__icon md-icon"></span>
1335           Migrating from WSC 5.3
1336         </label>
1337         <ul class="md-nav__list" data-md-scrollfix>
1338
1339
1340
1341
1342
1343     <li class="md-nav__item">
1344       <a href="../../wsc53/php/" class="md-nav__link">
1345         PHP API
1346       </a>
1347     </li>
1348
1349
1350
1351
1352
1353
1354
1355     <li class="md-nav__item">
1356       <a href="../../wsc53/session/" class="md-nav__link">
1357         Session Handling and Authentication
1358       </a>
1359     </li>
1360
1361
1362
1363
1364
1365
1366
1367     <li class="md-nav__item">
1368       <a href="../../wsc53/javascript/" class="md-nav__link">
1369         TypeScript and JavaScript
1370       </a>
1371     </li>
1372
1373
1374
1375
1376
1377
1378
1379     <li class="md-nav__item">
1380       <a href="../../wsc53/templates/" class="md-nav__link">
1381         Templates
1382       </a>
1383     </li>
1384
1385
1386
1387
1388
1389
1390
1391     <li class="md-nav__item">
1392       <a href="../../wsc53/libraries/" class="md-nav__link">
1393         Third Party Libraries
1394       </a>
1395     </li>
1396
1397
1398
1399         </ul>
1400       </nav>
1401     </li>
1402
1403
1404
1405
1406
1407
1408
1409
1410     <li class="md-nav__item md-nav__item--nested">
1411
1412
1413         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1414
1415       <label class="md-nav__link" for="__nav_6_2">
1416         Migrating from WSC 5.2
1417         <span class="md-nav__icon md-icon"></span>
1418       </label>
1419       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1420         <label class="md-nav__title" for="__nav_6_2">
1421           <span class="md-nav__icon md-icon"></span>
1422           Migrating from WSC 5.2
1423         </label>
1424         <ul class="md-nav__list" data-md-scrollfix>
1425
1426
1427
1428
1429
1430     <li class="md-nav__item">
1431       <a href="../../wsc52/php/" class="md-nav__link">
1432         PHP API
1433       </a>
1434     </li>
1435
1436
1437
1438
1439
1440
1441
1442     <li class="md-nav__item">
1443       <a href="../../wsc52/templates/" class="md-nav__link">
1444         Templates and Languages
1445       </a>
1446     </li>
1447
1448
1449
1450
1451
1452
1453
1454     <li class="md-nav__item">
1455       <a href="../../wsc52/libraries/" class="md-nav__link">
1456         Third Party Libraries
1457       </a>
1458     </li>
1459
1460
1461
1462         </ul>
1463       </nav>
1464     </li>
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1476
1477
1478         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" checked>
1479
1480       <label class="md-nav__link" for="__nav_6_3">
1481         Migrating from WSC 3.1
1482         <span class="md-nav__icon md-icon"></span>
1483       </label>
1484       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1485         <label class="md-nav__title" for="__nav_6_3">
1486           <span class="md-nav__icon md-icon"></span>
1487           Migrating from WSC 3.1
1488         </label>
1489         <ul class="md-nav__list" data-md-scrollfix>
1490
1491
1492
1493
1494
1495
1496
1497     <li class="md-nav__item md-nav__item--active">
1498
1499       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1500
1501
1502
1503
1504         <label class="md-nav__link md-nav__link--active" for="__toc">
1505           PHP API
1506           <span class="md-nav__icon md-icon"></span>
1507         </label>
1508
1509       <a href="./" class="md-nav__link md-nav__link--active">
1510         PHP API
1511       </a>
1512
1513
1514 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1515
1516
1517
1518
1519
1520     <label class="md-nav__title" for="__toc">
1521       <span class="md-nav__icon md-icon"></span>
1522       Table of contents
1523     </label>
1524     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1525
1526         <li class="md-nav__item">
1527   <a href="#form-builder" class="md-nav__link">
1528     Form Builder
1529   </a>
1530
1531 </li>
1532
1533         <li class="md-nav__item">
1534   <a href="#like-system" class="md-nav__link">
1535     Like System
1536   </a>
1537
1538 </li>
1539
1540         <li class="md-nav__item">
1541   <a href="#user-content-providers" class="md-nav__link">
1542     User Content Providers
1543   </a>
1544
1545     <nav class="md-nav" aria-label="User Content Providers">
1546       <ul class="md-nav__list">
1547
1548           <li class="md-nav__item">
1549   <a href="#php-class" class="md-nav__link">
1550     PHP Class
1551   </a>
1552
1553 </li>
1554
1555           <li class="md-nav__item">
1556   <a href="#object-type" class="md-nav__link">
1557     Object Type
1558   </a>
1559
1560     <nav class="md-nav" aria-label="Object Type">
1561       <ul class="md-nav__list">
1562
1563           <li class="md-nav__item">
1564   <a href="#nicevalue" class="md-nav__link">
1565     nicevalue
1566   </a>
1567
1568 </li>
1569
1570           <li class="md-nav__item">
1571   <a href="#hidden" class="md-nav__link">
1572     hidden
1573   </a>
1574
1575 </li>
1576
1577           <li class="md-nav__item">
1578   <a href="#requiredobjecttype" class="md-nav__link">
1579     requiredobjecttype
1580   </a>
1581
1582 </li>
1583
1584       </ul>
1585     </nav>
1586
1587 </li>
1588
1589       </ul>
1590     </nav>
1591
1592 </li>
1593
1594         <li class="md-nav__item">
1595   <a href="#php-database-api" class="md-nav__link">
1596     PHP Database API
1597   </a>
1598
1599 </li>
1600
1601     </ul>
1602
1603 </nav>
1604
1605     </li>
1606
1607
1608
1609         </ul>
1610       </nav>
1611     </li>
1612
1613
1614
1615
1616
1617
1618
1619
1620     <li class="md-nav__item md-nav__item--nested">
1621
1622
1623         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1624
1625       <label class="md-nav__link" for="__nav_6_4">
1626         Migrating from WSC 3.0
1627         <span class="md-nav__icon md-icon"></span>
1628       </label>
1629       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1630         <label class="md-nav__title" for="__nav_6_4">
1631           <span class="md-nav__icon md-icon"></span>
1632           Migrating from WSC 3.0
1633         </label>
1634         <ul class="md-nav__list" data-md-scrollfix>
1635
1636
1637
1638
1639
1640     <li class="md-nav__item">
1641       <a href="../../wsc30/php/" class="md-nav__link">
1642         PHP API
1643       </a>
1644     </li>
1645
1646
1647
1648
1649
1650
1651
1652     <li class="md-nav__item">
1653       <a href="../../wsc30/javascript/" class="md-nav__link">
1654         JavaScript API
1655       </a>
1656     </li>
1657
1658
1659
1660
1661
1662
1663
1664     <li class="md-nav__item">
1665       <a href="../../wsc30/templates/" class="md-nav__link">
1666         Templates
1667       </a>
1668     </li>
1669
1670
1671
1672
1673
1674
1675
1676     <li class="md-nav__item">
1677       <a href="../../wsc30/css/" class="md-nav__link">
1678         CSS
1679       </a>
1680     </li>
1681
1682
1683
1684
1685
1686
1687
1688     <li class="md-nav__item">
1689       <a href="../../wsc30/package/" class="md-nav__link">
1690         Package Components
1691       </a>
1692     </li>
1693
1694
1695
1696         </ul>
1697       </nav>
1698     </li>
1699
1700
1701
1702
1703
1704
1705
1706
1707     <li class="md-nav__item md-nav__item--nested">
1708
1709
1710         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1711
1712       <label class="md-nav__link" for="__nav_6_5">
1713         Migrating from WCF 2.1
1714         <span class="md-nav__icon md-icon"></span>
1715       </label>
1716       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1717         <label class="md-nav__title" for="__nav_6_5">
1718           <span class="md-nav__icon md-icon"></span>
1719           Migrating from WCF 2.1
1720         </label>
1721         <ul class="md-nav__list" data-md-scrollfix>
1722
1723
1724
1725
1726
1727     <li class="md-nav__item">
1728       <a href="../../wcf21/php/" class="md-nav__link">
1729         PHP API
1730       </a>
1731     </li>
1732
1733
1734
1735
1736
1737
1738
1739     <li class="md-nav__item">
1740       <a href="../../wcf21/templates/" class="md-nav__link">
1741         Templates
1742       </a>
1743     </li>
1744
1745
1746
1747
1748
1749
1750
1751     <li class="md-nav__item">
1752       <a href="../../wcf21/css/" class="md-nav__link">
1753         CSS
1754       </a>
1755     </li>
1756
1757
1758
1759
1760
1761
1762
1763     <li class="md-nav__item">
1764       <a href="../../wcf21/package/" class="md-nav__link">
1765         Package Components
1766       </a>
1767     </li>
1768
1769
1770
1771         </ul>
1772       </nav>
1773     </li>
1774
1775
1776
1777         </ul>
1778       </nav>
1779     </li>
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791     <li class="md-nav__item md-nav__item--nested">
1792
1793
1794         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1795
1796       <label class="md-nav__link" for="__nav_7">
1797         Tutorials
1798         <span class="md-nav__icon md-icon"></span>
1799       </label>
1800       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1801         <label class="md-nav__title" for="__nav_7">
1802           <span class="md-nav__icon md-icon"></span>
1803           Tutorials
1804         </label>
1805         <ul class="md-nav__list" data-md-scrollfix>
1806
1807
1808
1809
1810
1811
1812     <li class="md-nav__item md-nav__item--nested">
1813
1814
1815         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1816
1817       <label class="md-nav__link" for="__nav_7_1">
1818         Tutorial Series
1819         <span class="md-nav__icon md-icon"></span>
1820       </label>
1821       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1822         <label class="md-nav__title" for="__nav_7_1">
1823           <span class="md-nav__icon md-icon"></span>
1824           Tutorial Series
1825         </label>
1826         <ul class="md-nav__list" data-md-scrollfix>
1827
1828
1829
1830
1831
1832     <li class="md-nav__item">
1833       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1834         Overview
1835       </a>
1836     </li>
1837
1838
1839
1840
1841
1842
1843
1844     <li class="md-nav__item">
1845       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1846         Part 1
1847       </a>
1848     </li>
1849
1850
1851
1852
1853
1854
1855
1856     <li class="md-nav__item">
1857       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1858         Part 2
1859       </a>
1860     </li>
1861
1862
1863
1864
1865
1866
1867
1868     <li class="md-nav__item">
1869       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1870         Part 3
1871       </a>
1872     </li>
1873
1874
1875
1876         </ul>
1877       </nav>
1878     </li>
1879
1880
1881
1882         </ul>
1883       </nav>
1884     </li>
1885
1886
1887
1888   </ul>
1889 </nav>
1890                   </div>
1891                 </div>
1892               </div>
1893
1894
1895
1896               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1897                 <div class="md-sidebar__scrollwrap">
1898                   <div class="md-sidebar__inner">
1899
1900 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1901
1902
1903
1904
1905
1906     <label class="md-nav__title" for="__toc">
1907       <span class="md-nav__icon md-icon"></span>
1908       Table of contents
1909     </label>
1910     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1911
1912         <li class="md-nav__item">
1913   <a href="#form-builder" class="md-nav__link">
1914     Form Builder
1915   </a>
1916
1917 </li>
1918
1919         <li class="md-nav__item">
1920   <a href="#like-system" class="md-nav__link">
1921     Like System
1922   </a>
1923
1924 </li>
1925
1926         <li class="md-nav__item">
1927   <a href="#user-content-providers" class="md-nav__link">
1928     User Content Providers
1929   </a>
1930
1931     <nav class="md-nav" aria-label="User Content Providers">
1932       <ul class="md-nav__list">
1933
1934           <li class="md-nav__item">
1935   <a href="#php-class" class="md-nav__link">
1936     PHP Class
1937   </a>
1938
1939 </li>
1940
1941           <li class="md-nav__item">
1942   <a href="#object-type" class="md-nav__link">
1943     Object Type
1944   </a>
1945
1946     <nav class="md-nav" aria-label="Object Type">
1947       <ul class="md-nav__list">
1948
1949           <li class="md-nav__item">
1950   <a href="#nicevalue" class="md-nav__link">
1951     nicevalue
1952   </a>
1953
1954 </li>
1955
1956           <li class="md-nav__item">
1957   <a href="#hidden" class="md-nav__link">
1958     hidden
1959   </a>
1960
1961 </li>
1962
1963           <li class="md-nav__item">
1964   <a href="#requiredobjecttype" class="md-nav__link">
1965     requiredobjecttype
1966   </a>
1967
1968 </li>
1969
1970       </ul>
1971     </nav>
1972
1973 </li>
1974
1975       </ul>
1976     </nav>
1977
1978 </li>
1979
1980         <li class="md-nav__item">
1981   <a href="#php-database-api" class="md-nav__link">
1982     PHP Database API
1983   </a>
1984
1985 </li>
1986
1987     </ul>
1988
1989 </nav>
1990                   </div>
1991                 </div>
1992               </div>
1993
1994
1995           <div class="md-content" data-md-component="content">
1996             <article class="md-content__inner md-typeset">
1997
1998
1999                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/migration/wsc31/php.md" title="Edit this page" class="md-content__button md-icon">
2000                     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
2001                   </a>
2002
2003
2004                 <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>
2005 <h2 id="form-builder">Form Builder<a class="headerlink" href="#form-builder" title="Permanent link">#</a></h2>
2006 <p>WoltLab Suite Core 5.2 introduces a new, simpler and quicker way of creating forms:
2007 <a href="../../../php/api/form_builder/overview/">form builder</a>.
2008 You can find examples of how to migrate existing forms to form builder <a href="../form-builder/">here</a>.</p>
2009 <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>
2010 <h2 id="like-system">Like System<a class="headerlink" href="#like-system" title="Permanent link">#</a></h2>
2011 <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>
2012 <h2 id="user-content-providers">User Content Providers<a class="headerlink" href="#user-content-providers" title="Permanent link">#</a></h2>
2013 <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>
2014 <h3 id="php-class">PHP Class<a class="headerlink" href="#php-class" title="Permanent link">#</a></h3>
2015 <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>
2016 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2017 <span class="k">namespace</span> <span class="nx">wcf\system\user\content\provider</span><span class="p">;</span>
2018 <span class="k">use</span> <span class="nx">wcf\data\comment\Comment</span><span class="p">;</span>
2019
2020 <span class="sd">/**</span>
2021 <span class="sd"> * User content provider for comments.</span>
2022 <span class="sd"> *</span>
2023 <span class="sd"> * @author  Joshua Ruesweg</span>
2024 <span class="sd"> * @copyright   2001-2018 WoltLab GmbH</span>
2025 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2026 <span class="sd"> * @package WoltLabSuite\Core\System\User\Content\Provider</span>
2027 <span class="sd"> * @since   5.2</span>
2028 <span class="sd"> */</span>
2029 <span class="k">class</span> <span class="nc">CommentUserContentProvider</span> <span class="k">extends</span> <span class="nx">AbstractDatabaseUserContentProvider</span> <span class="p">{</span>
2030     <span class="sd">/**</span>
2031 <span class="sd">     * @inheritdoc</span>
2032 <span class="sd">     */</span>
2033     <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>
2034         <span class="k">return</span> <span class="nx">Comment</span><span class="o">::</span><span class="na">class</span><span class="p">;</span>
2035     <span class="p">}</span>
2036 <span class="p">}</span>
2037 </code></pre></div>
2038 <h3 id="object-type">Object Type<a class="headerlink" href="#object-type" title="Permanent link">#</a></h3>
2039 <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>
2040 <h4 id="nicevalue"><code>nicevalue</code><a class="headerlink" href="#nicevalue" title="Permanent link">#</a></h4>
2041 <p><span class="label label-info">Optional</span></p>
2042 <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>
2043 <h4 id="hidden"><code>hidden</code><a class="headerlink" href="#hidden" title="Permanent link">#</a></h4>
2044 <p><span class="label label-info">Optional</span></p>
2045 <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>
2046 <h4 id="requiredobjecttype"><code>requiredobjecttype</code><a class="headerlink" href="#requiredobjecttype" title="Permanent link">#</a></h4>
2047 <p><span class="label label-info">Optional</span></p>
2048 <p>The specified list of comma-separated object types are automatically removed during content removal when this object type is being removed.
2049 <strong>Attention</strong>: The order of removal is undefined by default, specify a <code>nicevalue</code> if the order is important.</p>
2050 <h2 id="php-database-api">PHP Database API<a class="headerlink" href="#php-database-api" title="Permanent link">#</a></h2>
2051 <p>WoltLab Suite 5.2 introduces a new way to update the database scheme:
2052 <a href="../../../package/database-php-api/">database PHP API</a>.</p>
2053
2054
2055
2056
2057 <hr>
2058 <div class="md-source-date">
2059   <small>
2060
2061       Last update: 2021-02-05
2062
2063   </small>
2064 </div>
2065
2066
2067
2068
2069
2070
2071
2072
2073             </article>
2074           </div>
2075         </div>
2076
2077       </main>
2078
2079
2080 <footer class="md-footer">
2081
2082     <nav class="md-footer__inner md-grid" aria-label="Footer">
2083
2084         <a href="../../wsc52/libraries/" class="md-footer__link md-footer__link--prev" rel="prev">
2085           <div class="md-footer__button md-icon">
2086             <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>
2087           </div>
2088           <div class="md-footer__title">
2089             <div class="md-ellipsis">
2090               <span class="md-footer__direction">
2091                 Previous
2092               </span>
2093               Third Party Libraries
2094             </div>
2095           </div>
2096         </a>
2097
2098
2099         <a href="../../wsc30/php/" class="md-footer__link md-footer__link--next" rel="next">
2100           <div class="md-footer__title">
2101             <div class="md-ellipsis">
2102               <span class="md-footer__direction">
2103                 Next
2104               </span>
2105               PHP API
2106             </div>
2107           </div>
2108           <div class="md-footer__button md-icon">
2109             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2110           </div>
2111         </a>
2112
2113     </nav>
2114
2115   <div class="md-footer-meta md-typeset">
2116     <div class="md-footer-meta__inner md-grid">
2117       <div class="md-footer-copyright">
2118
2119           <div class="md-footer-copyright__highlight">
2120             Copyright © 2020 WoltLab GmbH
2121           </div>
2122
2123         Made with
2124         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2125           Material for MkDocs
2126         </a>
2127
2128       </div>
2129       <div class="md-footer-copyright">
2130         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2131         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2132 </div>
2133     </div>
2134   </div>
2135 </footer>
2136
2137     </div>
2138     <div class="md-dialog" data-md-component="dialog">
2139       <div class="md-dialog__inner md-typeset"></div>
2140     </div>
2141     <script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script>
2142
2143
2144       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2145
2146
2147   </body>
2148 </html>