latest/migration/wsc53/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-53-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
 310     <li class="md-nav__item md-nav__item--nested">
 311
 312
 313         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 314
 315       <label class="md-nav__link" for="__nav_2_5_1">
 316         Caches
 317         <span class="md-nav__icon md-icon"></span>
 318       </label>
 319       <nav class="md-nav" aria-label="Caches" data-md-level="3">
 320         <label class="md-nav__title" for="__nav_2_5_1">
 321           <span class="md-nav__icon md-icon"></span>
 322           Caches
 323         </label>
 324         <ul class="md-nav__list" data-md-scrollfix>
 325
 326
 327
 328
 329
 330     <li class="md-nav__item">
 331       <a href="../../../php/api/caches/" class="md-nav__link">
 332         Overview
 333       </a>
 334     </li>
 335
 336
 337
 338
 339
 340
 341
 342     <li class="md-nav__item">
 343       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 344         Persistent Caches
 345       </a>
 346     </li>
 347
 348
 349
 350
 351
 352
 353
 354     <li class="md-nav__item">
 355       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 356         Runtime Caches
 357       </a>
 358     </li>
 359
 360
 361
 362         </ul>
 363       </nav>
 364     </li>
 365
 366
 367
 368
 369
 370
 371
 372     <li class="md-nav__item">
 373       <a href="../../../php/api/comments/" class="md-nav__link">
 374         Comments
 375       </a>
 376     </li>
 377
 378
 379
 380
 381
 382
 383
 384     <li class="md-nav__item">
 385       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 386         Cronjobs
 387       </a>
 388     </li>
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../../../php/api/events/" class="md-nav__link">
 398         Events
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409     <li class="md-nav__item md-nav__item--nested">
 410
 411
 412         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 413
 414       <label class="md-nav__link" for="__nav_2_5_5">
 415         Form Builder
 416         <span class="md-nav__icon md-icon"></span>
 417       </label>
 418       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 419         <label class="md-nav__title" for="__nav_2_5_5">
 420           <span class="md-nav__icon md-icon"></span>
 421           Form Builder
 422         </label>
 423         <ul class="md-nav__list" data-md-scrollfix>
 424
 425
 426
 427
 428
 429     <li class="md-nav__item">
 430       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 431         Overview
 432       </a>
 433     </li>
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 443         Structure
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item">
 454       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 455         Fields
 456       </a>
 457     </li>
 458
 459
 460
 461
 462
 463
 464
 465     <li class="md-nav__item">
 466       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 467         Validation and Data
 468       </a>
 469     </li>
 470
 471
 472
 473
 474
 475
 476
 477     <li class="md-nav__item">
 478       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 479         Dependencies
 480       </a>
 481     </li>
 482
 483
 484
 485         </ul>
 486       </nav>
 487     </li>
 488
 489
 490
 491
 492
 493
 494
 495     <li class="md-nav__item">
 496       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 497         Package Installation Plugins
 498       </a>
 499     </li>
 500
 501
 502
 503
 504
 505
 506
 507     <li class="md-nav__item">
 508       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 509         User Activity Points
 510       </a>
 511     </li>
 512
 513
 514
 515
 516
 517
 518
 519     <li class="md-nav__item">
 520       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 521         User Notifications
 522       </a>
 523     </li>
 524
 525
 526
 527
 528
 529
 530
 531     <li class="md-nav__item">
 532       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 533         Sitemaps
 534       </a>
 535     </li>
 536
 537
 538
 539         </ul>
 540       </nav>
 541     </li>
 542
 543
 544
 545
 546
 547
 548
 549     <li class="md-nav__item">
 550       <a href="../../../php/code-style/" class="md-nav__link">
 551         Code Style
 552       </a>
 553     </li>
 554
 555
 556
 557
 558
 559
 560
 561     <li class="md-nav__item">
 562       <a href="../../../php/apps/" class="md-nav__link">
 563         Apps
 564       </a>
 565     </li>
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../../php/gdpr/" class="md-nav__link">
 575         GDPR
 576       </a>
 577     </li>
 578
 579
 580
 581         </ul>
 582       </nav>
 583     </li>
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595     <li class="md-nav__item md-nav__item--nested">
 596
 597
 598         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 599
 600       <label class="md-nav__link" for="__nav_3">
 601         Languages, Templates & CSS
 602         <span class="md-nav__icon md-icon"></span>
 603       </label>
 604       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 605         <label class="md-nav__title" for="__nav_3">
 606           <span class="md-nav__icon md-icon"></span>
 607           Languages, Templates & CSS
 608         </label>
 609         <ul class="md-nav__list" data-md-scrollfix>
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../../view/languages/" class="md-nav__link">
 617         Languages
 618       </a>
 619     </li>
 620
 621
 622
 623
 624
 625
 626
 627     <li class="md-nav__item">
 628       <a href="../../../view/templates/" class="md-nav__link">
 629         Templates
 630       </a>
 631     </li>
 632
 633
 634
 635
 636
 637
 638
 639     <li class="md-nav__item">
 640       <a href="../../../view/template-plugins/" class="md-nav__link">
 641         Template Plugins
 642       </a>
 643     </li>
 644
 645
 646
 647
 648
 649
 650
 651     <li class="md-nav__item">
 652       <a href="../../../view/css/" class="md-nav__link">
 653         CSS
 654       </a>
 655     </li>
 656
 657
 658
 659         </ul>
 660       </nav>
 661     </li>
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673     <li class="md-nav__item md-nav__item--nested">
 674
 675
 676         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 677
 678       <label class="md-nav__link" for="__nav_4">
 679         TypeScript and JavaScript API
 680         <span class="md-nav__icon md-icon"></span>
 681       </label>
 682       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 683         <label class="md-nav__title" for="__nav_4">
 684           <span class="md-nav__icon md-icon"></span>
 685           TypeScript and JavaScript API
 686         </label>
 687         <ul class="md-nav__list" data-md-scrollfix>
 688
 689
 690
 691
 692
 693     <li class="md-nav__item">
 694       <a href="../../../javascript/general-usage/" class="md-nav__link">
 695         General Usage
 696       </a>
 697     </li>
 698
 699
 700
 701
 702
 703
 704
 705     <li class="md-nav__item">
 706       <a href="../../../javascript/typescript/" class="md-nav__link">
 707         TypeScript
 708       </a>
 709     </li>
 710
 711
 712
 713
 714
 715
 716
 717
 718     <li class="md-nav__item md-nav__item--nested">
 719
 720
 721         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 722
 723       <label class="md-nav__link" for="__nav_4_3">
 724         New API
 725         <span class="md-nav__icon md-icon"></span>
 726       </label>
 727       <nav class="md-nav" aria-label="New API" data-md-level="2">
 728         <label class="md-nav__title" for="__nav_4_3">
 729           <span class="md-nav__icon md-icon"></span>
 730           New API
 731         </label>
 732         <ul class="md-nav__list" data-md-scrollfix>
 733
 734
 735
 736
 737
 738     <li class="md-nav__item">
 739       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 740         Writing a module
 741       </a>
 742     </li>
 743
 744
 745
 746
 747
 748
 749
 750     <li class="md-nav__item">
 751       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 752         Data Structures
 753       </a>
 754     </li>
 755
 756
 757
 758
 759
 760
 761
 762     <li class="md-nav__item">
 763       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 764         Core Functions
 765       </a>
 766     </li>
 767
 768
 769
 770
 771
 772
 773
 774     <li class="md-nav__item">
 775       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 776         DOM
 777       </a>
 778     </li>
 779
 780
 781
 782
 783
 784
 785
 786     <li class="md-nav__item">
 787       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 788         Event Handling
 789       </a>
 790     </li>
 791
 792
 793
 794
 795
 796
 797
 798     <li class="md-nav__item">
 799       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 800         Ajax
 801       </a>
 802     </li>
 803
 804
 805
 806
 807
 808
 809
 810     <li class="md-nav__item">
 811       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 812         Dialogs
 813       </a>
 814     </li>
 815
 816
 817
 818
 819
 820
 821
 822     <li class="md-nav__item">
 823       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 824         Browser and Screen Sizes
 825       </a>
 826     </li>
 827
 828
 829
 830
 831
 832
 833
 834     <li class="md-nav__item">
 835       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 836         User Interface
 837       </a>
 838     </li>
 839
 840
 841
 842         </ul>
 843       </nav>
 844     </li>
 845
 846
 847
 848
 849
 850
 851
 852     <li class="md-nav__item">
 853       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 854         Legacy API
 855       </a>
 856     </li>
 857
 858
 859
 860
 861
 862
 863
 864     <li class="md-nav__item">
 865       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 866         Helper Functions
 867       </a>
 868     </li>
 869
 870
 871
 872
 873
 874
 875
 876     <li class="md-nav__item">
 877       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 878         Code Snippets
 879       </a>
 880     </li>
 881
 882
 883
 884         </ul>
 885       </nav>
 886     </li>
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898     <li class="md-nav__item md-nav__item--nested">
 899
 900
 901         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 902
 903       <label class="md-nav__link" for="__nav_5">
 904         Package Components
 905         <span class="md-nav__icon md-icon"></span>
 906       </label>
 907       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 908         <label class="md-nav__title" for="__nav_5">
 909           <span class="md-nav__icon md-icon"></span>
 910           Package Components
 911         </label>
 912         <ul class="md-nav__list" data-md-scrollfix>
 913
 914
 915
 916
 917
 918     <li class="md-nav__item">
 919       <a href="../../../package/package-xml/" class="md-nav__link">
 920         package.xml
 921       </a>
 922     </li>
 923
 924
 925
 926
 927
 928
 929
 930
 931     <li class="md-nav__item md-nav__item--nested">
 932
 933
 934         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
 935
 936       <label class="md-nav__link" for="__nav_5_2">
 937         PIPs
 938         <span class="md-nav__icon md-icon"></span>
 939       </label>
 940       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 941         <label class="md-nav__title" for="__nav_5_2">
 942           <span class="md-nav__icon md-icon"></span>
 943           PIPs
 944         </label>
 945         <ul class="md-nav__list" data-md-scrollfix>
 946
 947
 948
 949
 950
 951     <li class="md-nav__item">
 952       <a href="../../../package/pip/" class="md-nav__link">
 953         Overview
 954       </a>
 955     </li>
 956
 957
 958
 959
 960
 961
 962
 963     <li class="md-nav__item">
 964       <a href="../../../package/pip/acl-option/" class="md-nav__link">
 965         aclOption
 966       </a>
 967     </li>
 968
 969
 970
 971
 972
 973
 974
 975     <li class="md-nav__item">
 976       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
 977         acpMenu
 978       </a>
 979     </li>
 980
 981
 982
 983
 984
 985
 986
 987     <li class="md-nav__item">
 988       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
 989         acpSearchProvider
 990       </a>
 991     </li>
 992
 993
 994
 995
 996
 997
 998
 999     <li class="md-nav__item">
1000       <a href="../../../package/pip/acp-template/" class="md-nav__link">
1001         acpTemplate
1002       </a>
1003     </li>
1004
1005
1006
1007
1008
1009
1010
1011     <li class="md-nav__item">
1012       <a href="../../../package/pip/bbcode/" class="md-nav__link">
1013         bbcode
1014       </a>
1015     </li>
1016
1017
1018
1019
1020
1021
1022
1023     <li class="md-nav__item">
1024       <a href="../../../package/pip/box/" class="md-nav__link">
1025         box
1026       </a>
1027     </li>
1028
1029
1030
1031
1032
1033
1034
1035     <li class="md-nav__item">
1036       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1037         clipboardAction
1038       </a>
1039     </li>
1040
1041
1042
1043
1044
1045
1046
1047     <li class="md-nav__item">
1048       <a href="../../../package/pip/core-object/" class="md-nav__link">
1049         coreObject
1050       </a>
1051     </li>
1052
1053
1054
1055
1056
1057
1058
1059     <li class="md-nav__item">
1060       <a href="../../../package/pip/cronjob/" class="md-nav__link">
1061         cronjob
1062       </a>
1063     </li>
1064
1065
1066
1067
1068
1069
1070
1071     <li class="md-nav__item">
1072       <a href="../../../package/pip/database/" class="md-nav__link">
1073         database
1074       </a>
1075     </li>
1076
1077
1078
1079
1080
1081
1082
1083     <li class="md-nav__item">
1084       <a href="../../../package/pip/event-listener/" class="md-nav__link">
1085         eventListener
1086       </a>
1087     </li>
1088
1089
1090
1091
1092
1093
1094
1095     <li class="md-nav__item">
1096       <a href="../../../package/pip/file/" class="md-nav__link">
1097         file
1098       </a>
1099     </li>
1100
1101
1102
1103
1104
1105
1106
1107     <li class="md-nav__item">
1108       <a href="../../../package/pip/language/" class="md-nav__link">
1109         language
1110       </a>
1111     </li>
1112
1113
1114
1115
1116
1117
1118
1119     <li class="md-nav__item">
1120       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1121         mediaProvider
1122       </a>
1123     </li>
1124
1125
1126
1127
1128
1129
1130
1131     <li class="md-nav__item">
1132       <a href="../../../package/pip/menu/" class="md-nav__link">
1133         menu
1134       </a>
1135     </li>
1136
1137
1138
1139
1140
1141
1142
1143     <li class="md-nav__item">
1144       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1145         menuItem
1146       </a>
1147     </li>
1148
1149
1150
1151
1152
1153
1154
1155     <li class="md-nav__item">
1156       <a href="../../../package/pip/object-type/" class="md-nav__link">
1157         objectType
1158       </a>
1159     </li>
1160
1161
1162
1163
1164
1165
1166
1167     <li class="md-nav__item">
1168       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1169         objectTypeDefinition
1170       </a>
1171     </li>
1172
1173
1174
1175
1176
1177
1178
1179     <li class="md-nav__item">
1180       <a href="../../../package/pip/option/" class="md-nav__link">
1181         option
1182       </a>
1183     </li>
1184
1185
1186
1187
1188
1189
1190
1191     <li class="md-nav__item">
1192       <a href="../../../package/pip/page/" class="md-nav__link">
1193         page
1194       </a>
1195     </li>
1196
1197
1198
1199
1200
1201
1202
1203     <li class="md-nav__item">
1204       <a href="../../../package/pip/pip/" class="md-nav__link">
1205         pip
1206       </a>
1207     </li>
1208
1209
1210
1211
1212
1213
1214
1215     <li class="md-nav__item">
1216       <a href="../../../package/pip/script/" class="md-nav__link">
1217         script
1218       </a>
1219     </li>
1220
1221
1222
1223
1224
1225
1226
1227     <li class="md-nav__item">
1228       <a href="../../../package/pip/smiley/" class="md-nav__link">
1229         smiley
1230       </a>
1231     </li>
1232
1233
1234
1235
1236
1237
1238
1239     <li class="md-nav__item">
1240       <a href="../../../package/pip/sql/" class="md-nav__link">
1241         sql
1242       </a>
1243     </li>
1244
1245
1246
1247
1248
1249
1250
1251     <li class="md-nav__item">
1252       <a href="../../../package/pip/style/" class="md-nav__link">
1253         style
1254       </a>
1255     </li>
1256
1257
1258
1259
1260
1261
1262
1263     <li class="md-nav__item">
1264       <a href="../../../package/pip/template/" class="md-nav__link">
1265         template
1266       </a>
1267     </li>
1268
1269
1270
1271
1272
1273
1274
1275     <li class="md-nav__item">
1276       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1277         templateListener
1278       </a>
1279     </li>
1280
1281
1282
1283
1284
1285
1286
1287     <li class="md-nav__item">
1288       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1289         userGroupOption
1290       </a>
1291     </li>
1292
1293
1294
1295
1296
1297
1298
1299     <li class="md-nav__item">
1300       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1301         userMenu
1302       </a>
1303     </li>
1304
1305
1306
1307
1308
1309
1310
1311     <li class="md-nav__item">
1312       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1313         userNotificationEvent
1314       </a>
1315     </li>
1316
1317
1318
1319
1320
1321
1322
1323     <li class="md-nav__item">
1324       <a href="../../../package/pip/user-option/" class="md-nav__link">
1325         userOption
1326       </a>
1327     </li>
1328
1329
1330
1331
1332
1333
1334
1335     <li class="md-nav__item">
1336       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1337         userProfileMenu
1338       </a>
1339     </li>
1340
1341
1342
1343         </ul>
1344       </nav>
1345     </li>
1346
1347
1348
1349
1350
1351
1352
1353     <li class="md-nav__item">
1354       <a href="../../../package/database-php-api/" class="md-nav__link">
1355         Database PHP API
1356       </a>
1357     </li>
1358
1359
1360
1361         </ul>
1362       </nav>
1363     </li>
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1378
1379
1380         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
1381
1382       <label class="md-nav__link" for="__nav_6">
1383         Migration
1384         <span class="md-nav__icon md-icon"></span>
1385       </label>
1386       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1387         <label class="md-nav__title" for="__nav_6">
1388           <span class="md-nav__icon md-icon"></span>
1389           Migration
1390         </label>
1391         <ul class="md-nav__list" data-md-scrollfix>
1392
1393
1394
1395
1396
1397
1398
1399
1400     <li class="md-nav__item md-nav__item--active 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" checked>
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
1421
1422     <li class="md-nav__item md-nav__item--active">
1423
1424       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1425
1426
1427
1428
1429         <label class="md-nav__link md-nav__link--active" for="__toc">
1430           PHP API
1431           <span class="md-nav__icon md-icon"></span>
1432         </label>
1433
1434       <a href="./" class="md-nav__link md-nav__link--active">
1435         PHP API
1436       </a>
1437
1438
1439 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1440
1441
1442
1443
1444
1445     <label class="md-nav__title" for="__toc">
1446       <span class="md-nav__icon md-icon"></span>
1447       Table of contents
1448     </label>
1449     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1450
1451         <li class="md-nav__item">
1452   <a href="#minimum-requirements" class="md-nav__link">
1453     Minimum requirements
1454   </a>
1455
1456 </li>
1457
1458         <li class="md-nav__item">
1459   <a href="#flood-control" class="md-nav__link">
1460     Flood Control
1461   </a>
1462
1463 </li>
1464
1465         <li class="md-nav__item">
1466   <a href="#databasepackageinstallationplugin" class="md-nav__link">
1467     DatabasePackageInstallationPlugin
1468   </a>
1469
1470 </li>
1471
1472         <li class="md-nav__item">
1473   <a href="#php-database-api" class="md-nav__link">
1474     PHP Database API
1475   </a>
1476
1477 </li>
1478
1479         <li class="md-nav__item">
1480   <a href="#captcha" class="md-nav__link">
1481     Captcha
1482   </a>
1483
1484 </li>
1485
1486         <li class="md-nav__item">
1487   <a href="#search" class="md-nav__link">
1488     Search
1489   </a>
1490
1491 </li>
1492
1493         <li class="md-nav__item">
1494   <a href="#styles" class="md-nav__link">
1495     Styles
1496   </a>
1497
1498 </li>
1499
1500         <li class="md-nav__item">
1501   <a href="#tags" class="md-nav__link">
1502     Tags
1503   </a>
1504
1505 </li>
1506
1507         <li class="md-nav__item">
1508   <a href="#avatars" class="md-nav__link">
1509     Avatars
1510   </a>
1511
1512 </li>
1513
1514     </ul>
1515
1516 </nav>
1517
1518     </li>
1519
1520
1521
1522
1523
1524
1525
1526     <li class="md-nav__item">
1527       <a href="../session/" class="md-nav__link">
1528         Session Handling and Authentication
1529       </a>
1530     </li>
1531
1532
1533
1534
1535
1536
1537
1538     <li class="md-nav__item">
1539       <a href="../javascript/" class="md-nav__link">
1540         TypeScript and JavaScript
1541       </a>
1542     </li>
1543
1544
1545
1546
1547
1548
1549
1550     <li class="md-nav__item">
1551       <a href="../templates/" class="md-nav__link">
1552         Templates
1553       </a>
1554     </li>
1555
1556
1557
1558
1559
1560
1561
1562     <li class="md-nav__item">
1563       <a href="../libraries/" class="md-nav__link">
1564         Third Party Libraries
1565       </a>
1566     </li>
1567
1568
1569
1570         </ul>
1571       </nav>
1572     </li>
1573
1574
1575
1576
1577
1578
1579
1580
1581     <li class="md-nav__item md-nav__item--nested">
1582
1583
1584         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1585
1586       <label class="md-nav__link" for="__nav_6_2">
1587         Migrating from WSC 5.2
1588         <span class="md-nav__icon md-icon"></span>
1589       </label>
1590       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1591         <label class="md-nav__title" for="__nav_6_2">
1592           <span class="md-nav__icon md-icon"></span>
1593           Migrating from WSC 5.2
1594         </label>
1595         <ul class="md-nav__list" data-md-scrollfix>
1596
1597
1598
1599
1600
1601     <li class="md-nav__item">
1602       <a href="../../wsc52/php/" class="md-nav__link">
1603         PHP API
1604       </a>
1605     </li>
1606
1607
1608
1609
1610
1611
1612
1613     <li class="md-nav__item">
1614       <a href="../../wsc52/templates/" class="md-nav__link">
1615         Templates and Languages
1616       </a>
1617     </li>
1618
1619
1620
1621
1622
1623
1624
1625     <li class="md-nav__item">
1626       <a href="../../wsc52/libraries/" class="md-nav__link">
1627         Third Party Libraries
1628       </a>
1629     </li>
1630
1631
1632
1633         </ul>
1634       </nav>
1635     </li>
1636
1637
1638
1639
1640
1641
1642
1643
1644     <li class="md-nav__item md-nav__item--nested">
1645
1646
1647         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1648
1649       <label class="md-nav__link" for="__nav_6_3">
1650         Migrating from WSC 3.1
1651         <span class="md-nav__icon md-icon"></span>
1652       </label>
1653       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1654         <label class="md-nav__title" for="__nav_6_3">
1655           <span class="md-nav__icon md-icon"></span>
1656           Migrating from WSC 3.1
1657         </label>
1658         <ul class="md-nav__list" data-md-scrollfix>
1659
1660
1661
1662
1663
1664     <li class="md-nav__item">
1665       <a href="../../wsc31/php/" class="md-nav__link">
1666         PHP API
1667       </a>
1668     </li>
1669
1670
1671
1672         </ul>
1673       </nav>
1674     </li>
1675
1676
1677
1678
1679
1680
1681
1682
1683     <li class="md-nav__item md-nav__item--nested">
1684
1685
1686         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1687
1688       <label class="md-nav__link" for="__nav_6_4">
1689         Migrating from WSC 3.0
1690         <span class="md-nav__icon md-icon"></span>
1691       </label>
1692       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1693         <label class="md-nav__title" for="__nav_6_4">
1694           <span class="md-nav__icon md-icon"></span>
1695           Migrating from WSC 3.0
1696         </label>
1697         <ul class="md-nav__list" data-md-scrollfix>
1698
1699
1700
1701
1702
1703     <li class="md-nav__item">
1704       <a href="../../wsc30/php/" class="md-nav__link">
1705         PHP API
1706       </a>
1707     </li>
1708
1709
1710
1711
1712
1713
1714
1715     <li class="md-nav__item">
1716       <a href="../../wsc30/javascript/" class="md-nav__link">
1717         JavaScript API
1718       </a>
1719     </li>
1720
1721
1722
1723
1724
1725
1726
1727     <li class="md-nav__item">
1728       <a href="../../wsc30/templates/" class="md-nav__link">
1729         Templates
1730       </a>
1731     </li>
1732
1733
1734
1735
1736
1737
1738
1739     <li class="md-nav__item">
1740       <a href="../../wsc30/css/" class="md-nav__link">
1741         CSS
1742       </a>
1743     </li>
1744
1745
1746
1747
1748
1749
1750
1751     <li class="md-nav__item">
1752       <a href="../../wsc30/package/" class="md-nav__link">
1753         Package Components
1754       </a>
1755     </li>
1756
1757
1758
1759         </ul>
1760       </nav>
1761     </li>
1762
1763
1764
1765
1766
1767
1768
1769
1770     <li class="md-nav__item md-nav__item--nested">
1771
1772
1773         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1774
1775       <label class="md-nav__link" for="__nav_6_5">
1776         Migrating from WCF 2.1
1777         <span class="md-nav__icon md-icon"></span>
1778       </label>
1779       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1780         <label class="md-nav__title" for="__nav_6_5">
1781           <span class="md-nav__icon md-icon"></span>
1782           Migrating from WCF 2.1
1783         </label>
1784         <ul class="md-nav__list" data-md-scrollfix>
1785
1786
1787
1788
1789
1790     <li class="md-nav__item">
1791       <a href="../../wcf21/php/" class="md-nav__link">
1792         PHP API
1793       </a>
1794     </li>
1795
1796
1797
1798
1799
1800
1801
1802     <li class="md-nav__item">
1803       <a href="../../wcf21/templates/" class="md-nav__link">
1804         Templates
1805       </a>
1806     </li>
1807
1808
1809
1810
1811
1812
1813
1814     <li class="md-nav__item">
1815       <a href="../../wcf21/css/" class="md-nav__link">
1816         CSS
1817       </a>
1818     </li>
1819
1820
1821
1822
1823
1824
1825
1826     <li class="md-nav__item">
1827       <a href="../../wcf21/package/" class="md-nav__link">
1828         Package Components
1829       </a>
1830     </li>
1831
1832
1833
1834         </ul>
1835       </nav>
1836     </li>
1837
1838
1839
1840         </ul>
1841       </nav>
1842     </li>
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854     <li class="md-nav__item md-nav__item--nested">
1855
1856
1857         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1858
1859       <label class="md-nav__link" for="__nav_7">
1860         Tutorials
1861         <span class="md-nav__icon md-icon"></span>
1862       </label>
1863       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1864         <label class="md-nav__title" for="__nav_7">
1865           <span class="md-nav__icon md-icon"></span>
1866           Tutorials
1867         </label>
1868         <ul class="md-nav__list" data-md-scrollfix>
1869
1870
1871
1872
1873
1874
1875     <li class="md-nav__item md-nav__item--nested">
1876
1877
1878         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1879
1880       <label class="md-nav__link" for="__nav_7_1">
1881         Tutorial Series
1882         <span class="md-nav__icon md-icon"></span>
1883       </label>
1884       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1885         <label class="md-nav__title" for="__nav_7_1">
1886           <span class="md-nav__icon md-icon"></span>
1887           Tutorial Series
1888         </label>
1889         <ul class="md-nav__list" data-md-scrollfix>
1890
1891
1892
1893
1894
1895     <li class="md-nav__item">
1896       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1897         Overview
1898       </a>
1899     </li>
1900
1901
1902
1903
1904
1905
1906
1907     <li class="md-nav__item">
1908       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1909         Part 1
1910       </a>
1911     </li>
1912
1913
1914
1915
1916
1917
1918
1919     <li class="md-nav__item">
1920       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1921         Part 2
1922       </a>
1923     </li>
1924
1925
1926
1927
1928
1929
1930
1931     <li class="md-nav__item">
1932       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1933         Part 3
1934       </a>
1935     </li>
1936
1937
1938
1939         </ul>
1940       </nav>
1941     </li>
1942
1943
1944
1945         </ul>
1946       </nav>
1947     </li>
1948
1949
1950
1951   </ul>
1952 </nav>
1953                   </div>
1954                 </div>
1955               </div>
1956
1957
1958
1959               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1960                 <div class="md-sidebar__scrollwrap">
1961                   <div class="md-sidebar__inner">
1962
1963 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1964
1965
1966
1967
1968
1969     <label class="md-nav__title" for="__toc">
1970       <span class="md-nav__icon md-icon"></span>
1971       Table of contents
1972     </label>
1973     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1974
1975         <li class="md-nav__item">
1976   <a href="#minimum-requirements" class="md-nav__link">
1977     Minimum requirements
1978   </a>
1979
1980 </li>
1981
1982         <li class="md-nav__item">
1983   <a href="#flood-control" class="md-nav__link">
1984     Flood Control
1985   </a>
1986
1987 </li>
1988
1989         <li class="md-nav__item">
1990   <a href="#databasepackageinstallationplugin" class="md-nav__link">
1991     DatabasePackageInstallationPlugin
1992   </a>
1993
1994 </li>
1995
1996         <li class="md-nav__item">
1997   <a href="#php-database-api" class="md-nav__link">
1998     PHP Database API
1999   </a>
2000
2001 </li>
2002
2003         <li class="md-nav__item">
2004   <a href="#captcha" class="md-nav__link">
2005     Captcha
2006   </a>
2007
2008 </li>
2009
2010         <li class="md-nav__item">
2011   <a href="#search" class="md-nav__link">
2012     Search
2013   </a>
2014
2015 </li>
2016
2017         <li class="md-nav__item">
2018   <a href="#styles" class="md-nav__link">
2019     Styles
2020   </a>
2021
2022 </li>
2023
2024         <li class="md-nav__item">
2025   <a href="#tags" class="md-nav__link">
2026     Tags
2027   </a>
2028
2029 </li>
2030
2031         <li class="md-nav__item">
2032   <a href="#avatars" class="md-nav__link">
2033     Avatars
2034   </a>
2035
2036 </li>
2037
2038     </ul>
2039
2040 </nav>
2041                   </div>
2042                 </div>
2043               </div>
2044
2045
2046           <div class="md-content" data-md-component="content">
2047             <article class="md-content__inner md-typeset">
2048
2049
2050                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/migration/wsc53/php.md" title="Edit this page" class="md-content__button md-icon">
2051                     <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>
2052                   </a>
2053
2054
2055                 <h1 id="migrating-from-wsc-53-php">Migrating from WSC 5.3 - PHP<a class="headerlink" href="#migrating-from-wsc-53-php" title="Permanent link">#</a></h1>
2056 <h2 id="minimum-requirements">Minimum requirements<a class="headerlink" href="#minimum-requirements" title="Permanent link">#</a></h2>
2057 <p>The minimum requirements have been increased to the following:</p>
2058 <ul>
2059 <li><strong>PHP:</strong> 7.2.24</li>
2060 <li><strong>MySQL:</strong> 5.7.31 or 8.0.19</li>
2061 <li><strong>MariaDB:</strong> 10.1.44</li>
2062 </ul>
2063 <p>Most notably PHP 7.2 contains usable support for scalar types by the addition of nullable types in PHP 7.1 and parameter type widening in PHP 7.2.</p>
2064 <p>It is recommended to make use of scalar types and other newly introduced features whereever possible.
2065 Please refer to the PHP documentation for details.</p>
2066 <h2 id="flood-control">Flood Control<a class="headerlink" href="#flood-control" title="Permanent link">#</a></h2>
2067 <p>To prevent users from creating massive amounts of contents in short periods of time, i.e., spam, existing systems already use flood control mechanisms to limit the amount of contents created within a certain period of time.
2068 With WoltLab Suite 5.4, we have added a general API that manages such rate limiting.
2069 Leveraging this API is easily done.</p>
2070 <ol>
2071 <li>Register an object type for the definition <code>com.woltlab.wcf.floodControl</code>: <code>com.example.foo.myContent</code>.</li>
2072 <li>Whenever the active user creates content of this type, call
2073     <div class="highlight"><pre><span></span><code><span class="nx">FloodControl</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">registerContent</span><span class="p">(</span><span class="s1">&#39;com.example.foo.myContent&#39;</span><span class="p">);</span>
2074 </code></pre></div>
2075     You should only call this method if the user creates the content themselves.
2076     If the content is automatically created by the system, for example when copying / duplicating existing content, no activity should be registered.</li>
2077 <li>
2078 <p>To check the last time when the active user created content of the relevant type, use
2079     <div class="highlight"><pre><span></span><code><span class="nx">FloodControl</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getLastTime</span><span class="p">(</span><span class="s1">&#39;com.example.foo.myContent&#39;</span><span class="p">);</span>
2080 </code></pre></div>
2081     If you want to limit the number of content items created within a certain period of time, for example within one day, use
2082     <div class="highlight"><pre><span></span><code><span class="nv">$data</span> <span class="o">=</span> <span class="nx">FloodControl</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">countContent</span><span class="p">(</span><span class="s1">&#39;com.example.foo.myContent&#39;</span><span class="p">,</span> <span class="k">new</span> <span class="nx">\DateInterval</span><span class="p">(</span><span class="s1">&#39;P1D&#39;</span><span class="p">));</span>
2083 <span class="c1">// number of content items created within the last day</span>
2084 <span class="nv">$count</span> <span class="o">=</span> <span class="nv">$data</span><span class="p">[</span><span class="s1">&#39;count&#39;</span><span class="p">];</span>
2085 <span class="c1">// timestamp when the earliest content item was created within the last day</span>
2086 <span class="nv">$earliestTime</span> <span class="o">=</span> <span class="nv">$data</span><span class="p">[</span><span class="s1">&#39;earliestTime&#39;</span><span class="p">];</span>
2087 </code></pre></div>
2088     The method also returns <code>earliestTime</code> so that you can tell the user in the error message when they are able again to create new content of the relevant type.</p>
2089 <div class="admonition info">
2090 <p class="admonition-title">Flood control entries are only stored for 31 days and older entries are cleaned up daily.</p>
2091 </div>
2092 </li>
2093 </ol>
2094 <p>The previously mentioned methods of <code>FloodControl</code> use the active user and the current timestamp as reference point.
2095 <code>FloodControl</code> also provides methods to register content or check flood control for other registered users or for guests via their IP address.
2096 For further details on these methods, please refer to the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/flood/FloodControl.class.php">documentation in the FloodControl class</a>.</p>
2097 <div class="admonition warning">
2098 <p class="admonition-title">Do not interact directly with the flood control database table but only via the <code>FloodControl</code> class!</p>
2099 </div>
2100 <h2 id="databasepackageinstallationplugin">DatabasePackageInstallationPlugin<a class="headerlink" href="#databasepackageinstallationplugin" title="Permanent link">#</a></h2>
2101 <p><code>DatabasePackageInstallationPlugin</code> is a new idempotent package installation plugin (thus it is available in the sync function in the devtools) to update the database schema using the PHP-based database API.
2102 <code>DatabasePackageInstallationPlugin</code> is similar to <code>ScriptPackageInstallationPlugin</code> by requiring a PHP script that is included during the execution of the script.
2103 The script is expected to return an array of <code>DatabaseTable</code> objects representing the schema changes so that in contrast to using <code>ScriptPackageInstallationPlugin</code>, no <code>DatabaseTableChangeProcessor</code> object has to be created.
2104 The PHP file must be located in the <code>acp/database/</code> directory for the devtools sync function to recognize the file.</p>
2105 <h2 id="php-database-api">PHP Database API<a class="headerlink" href="#php-database-api" title="Permanent link">#</a></h2>
2106 <p>The PHP API to add and change database tables during package installations and updates in the <code>wcf\system\database\table</code> namespace now also supports renaming existing table columns with the new <code>IDatabaseTableColumn::renameTo()</code> method:</p>
2107 <div class="highlight"><pre><span></span><code><span class="nx">PartialDatabaseTable</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;wcf1_test&#39;</span><span class="p">)</span>
2108         <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span>
2109                 <span class="nx">NotNullInt10DatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;oldName&#39;</span><span class="p">)</span>
2110                         <span class="o">-&gt;</span><span class="na">renameTo</span><span class="p">(</span><span class="s1">&#39;newName&#39;</span><span class="p">)</span>
2111         <span class="p">]);</span>
2112 </code></pre></div>
2113 <div class="admonition info">
2114 <p class="admonition-title">Like with every change to existing database tables, packages can only rename columns that they installed.</p>
2115 </div>
2116 <h2 id="captcha">Captcha<a class="headerlink" href="#captcha" title="Permanent link">#</a></h2>
2117 <p>The reCAPTCHA v1 implementation was completely removed.
2118 This includes the <code>\wcf\system\recaptcha\RecaptchaHandler</code> class (not to be confused with the one in the <code>captcha</code> namespace).</p>
2119 <p>The reCAPTCHA v1 endpoints have already been turned off by Google and always return a HTTP 404.
2120 Thus the implementation was completely non-functional even before this change.</p>
2121 <p>See <a href="https://github.com/WoltLab/WCF/pull/3781">WoltLab/WCF#3781</a> for details.</p>
2122 <h2 id="search">Search<a class="headerlink" href="#search" title="Permanent link">#</a></h2>
2123 <p>The generic implementation in the <code>AbstractSearchEngine::parseSearchQuery()</code> method was dangerous, because it did not have knowledge about the search engine’s specifics.
2124 The implementation was completely removed: <code>AbstractSearchEngine::parseSearchQuery()</code> now always throws a <code>\BadMethodCallException</code>.</p>
2125 <p>If you implemented a custom search engine and relied on this method, you can inline the previous implementation to preserve existing behavior.
2126 You should take the time to verify the rewritten queries against the manual of the search engine to make sure it cannot generate malformed queries or security issues.</p>
2127 <p>See <a href="https://github.com/WoltLab/WCF/issues/3815">WoltLab/WCF#3815</a> for details.</p>
2128 <h2 id="styles">Styles<a class="headerlink" href="#styles" title="Permanent link">#</a></h2>
2129 <p>The <code>StyleCompiler</code> class is marked <code>final</code> now.
2130 The internal SCSS compiler object being stored in the <code>$compiler</code> property was a design issue that leaked compiler state across multiple compiled styles, possibly causing misgenerated stylesheets.
2131 As the removal of the <code>$compiler</code> property effectively broke compatibility within the <code>StyleCompiler</code> and as the <code>StyleCompiler</code> never was meant to be extended, it was marked final.</p>
2132 <p>See <a href="https://github.com/WoltLab/WCF/pull/3929">WoltLab/WCF#3929</a> for details.</p>
2133 <h2 id="tags">Tags<a class="headerlink" href="#tags" title="Permanent link">#</a></h2>
2134 <p>Use of the <code>wcf1_tag_to_object.languageID</code> column is deprecated.
2135 The <code>languageID</code> column is redundant, because its value can be derived from the <code>tagID</code>.
2136 With WoltLab Suite 5.4, it will no longer be part of any indices, allowing more efficient index usage in the general case.</p>
2137 <p>If you need to filter the contents of <code>wcf1_tag_to_object</code> by language, you should perform an <code>INNER JOIN wcf1_tag tag ON tag.tagID = tag_to_object.tagID</code> and filter on <code>wcf1_tag.languageID</code>.</p>
2138 <p>See <a href="https://github.com/WoltLab/WCF/pull/3904">WoltLab/WCF#3904</a> for details.</p>
2139 <h2 id="avatars">Avatars<a class="headerlink" href="#avatars" title="Permanent link">#</a></h2>
2140 <p>The <code>ISafeFormatAvatar</code> interface was added to properly support fallback image types for use in emails.
2141 If your custom <code>IUserAvatar</code> implementation supports image types without broad support (i.e. anything other than PNG, JPEG, and GIF), then you should implement the <code>ISafeFormatAvatar</code> interface to return a fallback PNG, JPEG, or GIF image.</p>
2142 <p>See <a href="https://github.com/WoltLab/WCF/pull/4001">WoltLab/WCF#4001</a> for details.</p>
2143
2144
2145
2146
2147 <hr>
2148 <div class="md-source-date">
2149   <small>
2150
2151       Last update: 2021-03-15
2152
2153   </small>
2154 </div>
2155
2156
2157
2158
2159
2160
2161
2162
2163             </article>
2164           </div>
2165         </div>
2166
2167       </main>
2168
2169
2170 <footer class="md-footer">
2171
2172     <nav class="md-footer__inner md-grid" aria-label="Footer">
2173
2174         <a href="../../../package/database-php-api/" class="md-footer__link md-footer__link--prev" rel="prev">
2175           <div class="md-footer__button md-icon">
2176             <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>
2177           </div>
2178           <div class="md-footer__title">
2179             <div class="md-ellipsis">
2180               <span class="md-footer__direction">
2181                 Previous
2182               </span>
2183               Database PHP API
2184             </div>
2185           </div>
2186         </a>
2187
2188
2189         <a href="../session/" class="md-footer__link md-footer__link--next" rel="next">
2190           <div class="md-footer__title">
2191             <div class="md-ellipsis">
2192               <span class="md-footer__direction">
2193                 Next
2194               </span>
2195               Session Handling and Authentication
2196             </div>
2197           </div>
2198           <div class="md-footer__button md-icon">
2199             <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>
2200           </div>
2201         </a>
2202
2203     </nav>
2204
2205   <div class="md-footer-meta md-typeset">
2206     <div class="md-footer-meta__inner md-grid">
2207       <div class="md-footer-copyright">
2208
2209           <div class="md-footer-copyright__highlight">
2210             Copyright © 2020 WoltLab GmbH
2211           </div>
2212
2213         Made with
2214         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2215           Material for MkDocs
2216         </a>
2217
2218       </div>
2219       <div class="md-footer-copyright">
2220         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2221         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2222 </div>
2223     </div>
2224   </div>
2225 </footer>
2226
2227     </div>
2228     <div class="md-dialog" data-md-component="dialog">
2229       <div class="md-dialog__inner md-typeset"></div>
2230     </div>
2231     <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>
2232
2233
2234       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2235
2236
2237   </body>
2238 </html>