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