6.0/migration/wsc54/php/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11         <link rel="canonical" href="https://docs.woltlab.com/6.0/migration/wsc54/php/">
  12
  13
  14         <link rel="prev" href="../../wsc55/deprecations_removals/">
  15
  16
  17         <link rel="next" href="../javascript/">
  18
  19       <link rel="icon" href="../../../assets/default.favicon.ico">
  20       <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.15">
  21
  22
  23
  24         <title>PHP API - WoltLab Suite Documentation</title>
  25
  26
  27
  28       <link rel="stylesheet" href="../../../assets/stylesheets/main.26e3688c.min.css">
  29
  30
  31         <link rel="stylesheet" href="../../../assets/stylesheets/palette.ecc896b0.min.css">
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  42
  43     <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  44
  45
  46
  47
  48
  49
  50   </head>
  51
  52
  53
  54
  55
  56
  57
  58     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  59
  60
  61
  62     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  63     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  64     <label class="md-overlay" for="__drawer"></label>
  65     <div data-md-component="skip">
  66
  67
  68         <a href="#migrating-from-woltlab-suite-54-php" class="md-skip">
  69           Skip to content
  70         </a>
  71
  72     </div>
  73     <div data-md-component="announce">
  74
  75         <aside class="md-banner">
  76           <div class="md-banner__inner md-grid md-typeset">
  77
  78
  79     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  80
  81           </div>
  82
  83         </aside>
  84
  85     </div>
  86
  87       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  88
  89       </div>
  90
  91
  92
  93
  94
  95
  96 <header class="md-header md-header--shadow" data-md-component="header">
  97   <nav class="md-header__inner md-grid" aria-label="Header">
  98     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  99
 100   <img src="../../../assets/logo.png" alt="logo">
 101
 102     </a>
 103     <label class="md-header__button md-icon" for="__drawer">
 104       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 105     </label>
 106     <div class="md-header__title" data-md-component="header-title">
 107       <div class="md-header__ellipsis">
 108         <div class="md-header__topic">
 109           <span class="md-ellipsis">
 110             WoltLab Suite Documentation
 111           </span>
 112         </div>
 113         <div class="md-header__topic" data-md-component="header-topic">
 114           <span class="md-ellipsis">
 115
 116               PHP API
 117
 118           </span>
 119         </div>
 120       </div>
 121     </div>
 122
 123
 124
 125
 126
 127       <label class="md-header__button md-icon" for="__search">
 128         <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>
 129       </label>
 130       <div class="md-search" data-md-component="search" role="dialog">
 131   <label class="md-search__overlay" for="__search"></label>
 132   <div class="md-search__inner" role="search">
 133     <form class="md-search__form" name="search">
 134       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
 135       <label class="md-search__icon md-icon" for="__search">
 136         <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>
 137         <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>
 138       </label>
 139       <nav class="md-search__options" aria-label="Search">
 140
 141         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 142           <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>
 143         </button>
 144       </nav>
 145
 146     </form>
 147     <div class="md-search__output">
 148       <div class="md-search__scrollwrap" data-md-scrollfix>
 149         <div class="md-search-result" data-md-component="search-result">
 150           <div class="md-search-result__meta">
 151             Initializing search
 152           </div>
 153           <ol class="md-search-result__list" role="presentation"></ol>
 154         </div>
 155       </div>
 156     </div>
 157   </div>
 158 </div>
 159
 160
 161       <div class="md-header__source">
 162         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 163   <div class="md-source__icon md-icon">
 164
 165     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 166   </div>
 167   <div class="md-source__repository">
 168     GitHub
 169   </div>
 170 </a>
 171       </div>
 172
 173   </nav>
 174
 175 </header>
 176
 177     <div class="md-container" data-md-component="container">
 178
 179
 180
 181
 182
 183
 184       <main class="md-main" data-md-component="main">
 185         <div class="md-main__inner md-grid">
 186
 187
 188
 189               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 190                 <div class="md-sidebar__scrollwrap">
 191                   <div class="md-sidebar__inner">
 192
 193
 194
 195 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 196   <label class="md-nav__title" for="__drawer">
 197     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 198
 199   <img src="../../../assets/logo.png" alt="logo">
 200
 201     </a>
 202     WoltLab Suite Documentation
 203   </label>
 204
 205     <div class="md-nav__source">
 206       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 207   <div class="md-source__icon md-icon">
 208
 209     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 210   </div>
 211   <div class="md-source__repository">
 212     GitHub
 213   </div>
 214 </a>
 215     </div>
 216
 217   <ul class="md-nav__list" data-md-scrollfix>
 218
 219
 220
 221
 222
 223
 224
 225
 226     <li class="md-nav__item">
 227       <a href="../../../getting-started/" class="md-nav__link">
 228         Getting Started
 229       </a>
 230     </li>
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242     <li class="md-nav__item md-nav__item--nested">
 243
 244
 245
 246
 247       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 248
 249
 250
 251         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 252           PHP API
 253           <span class="md-nav__icon md-icon"></span>
 254         </label>
 255
 256       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 257         <label class="md-nav__title" for="__nav_2">
 258           <span class="md-nav__icon md-icon"></span>
 259           PHP API
 260         </label>
 261         <ul class="md-nav__list" data-md-scrollfix>
 262
 263
 264
 265
 266
 267
 268     <li class="md-nav__item">
 269       <a href="../../../php/pages/" class="md-nav__link">
 270         Pages
 271       </a>
 272     </li>
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282     <li class="md-nav__item">
 283       <a href="../../../php/database-objects/" class="md-nav__link">
 284         Database Objects
 285       </a>
 286     </li>
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296     <li class="md-nav__item">
 297       <a href="../../../php/database-access/" class="md-nav__link">
 298         Database Access
 299       </a>
 300     </li>
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item">
 311       <a href="../../../php/exceptions/" class="md-nav__link">
 312         Exceptions
 313       </a>
 314     </li>
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325     <li class="md-nav__item md-nav__item--nested">
 326
 327
 328
 329
 330       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 331
 332
 333
 334         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 335           API
 336           <span class="md-nav__icon md-icon"></span>
 337         </label>
 338
 339       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 340         <label class="md-nav__title" for="__nav_2_5">
 341           <span class="md-nav__icon md-icon"></span>
 342           API
 343         </label>
 344         <ul class="md-nav__list" data-md-scrollfix>
 345
 346
 347
 348
 349
 350
 351
 352     <li class="md-nav__item md-nav__item--nested">
 353
 354
 355
 356
 357       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 358
 359
 360
 361         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 362           Caches
 363           <span class="md-nav__icon md-icon"></span>
 364         </label>
 365
 366       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 367         <label class="md-nav__title" for="__nav_2_5_1">
 368           <span class="md-nav__icon md-icon"></span>
 369           Caches
 370         </label>
 371         <ul class="md-nav__list" data-md-scrollfix>
 372
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../../php/api/caches/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392     <li class="md-nav__item">
 393       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 394         Persistent Caches
 395       </a>
 396     </li>
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406     <li class="md-nav__item">
 407       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 408         Runtime Caches
 409       </a>
 410     </li>
 411
 412
 413
 414
 415         </ul>
 416       </nav>
 417     </li>
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427     <li class="md-nav__item">
 428       <a href="../../../php/api/comments/" class="md-nav__link">
 429         Comments
 430       </a>
 431     </li>
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 443         Cronjobs
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455     <li class="md-nav__item">
 456       <a href="../../../php/api/events/" class="md-nav__link">
 457         Events
 458       </a>
 459     </li>
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470     <li class="md-nav__item md-nav__item--nested">
 471
 472
 473
 474
 475       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 476
 477
 478
 479         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 480           Form Builder
 481           <span class="md-nav__icon md-icon"></span>
 482         </label>
 483
 484       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 485         <label class="md-nav__title" for="__nav_2_5_5">
 486           <span class="md-nav__icon md-icon"></span>
 487           Form Builder
 488         </label>
 489         <ul class="md-nav__list" data-md-scrollfix>
 490
 491
 492
 493
 494
 495
 496     <li class="md-nav__item">
 497       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 498         Overview
 499       </a>
 500     </li>
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 512         Structure
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524     <li class="md-nav__item">
 525       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 526         Fields
 527       </a>
 528     </li>
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538     <li class="md-nav__item">
 539       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 540         Validation and Data
 541       </a>
 542     </li>
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552     <li class="md-nav__item">
 553       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 554         Dependencies
 555       </a>
 556     </li>
 557
 558
 559
 560
 561         </ul>
 562       </nav>
 563     </li>
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 575         Package Installation Plugins
 576       </a>
 577     </li>
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587     <li class="md-nav__item">
 588       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 589         User Activity Points
 590       </a>
 591     </li>
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601     <li class="md-nav__item">
 602       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 603         User Notifications
 604       </a>
 605     </li>
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 617         Sitemaps
 618       </a>
 619     </li>
 620
 621
 622
 623
 624         </ul>
 625       </nav>
 626     </li>
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636     <li class="md-nav__item">
 637       <a href="../../../php/code-style/" class="md-nav__link">
 638         Code Style
 639       </a>
 640     </li>
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650     <li class="md-nav__item">
 651       <a href="../../../php/apps/" class="md-nav__link">
 652         Apps
 653       </a>
 654     </li>
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664     <li class="md-nav__item">
 665       <a href="../../../php/gdpr/" class="md-nav__link">
 666         GDPR
 667       </a>
 668     </li>
 669
 670
 671
 672
 673         </ul>
 674       </nav>
 675     </li>
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item md-nav__item--nested">
 688
 689
 690
 691
 692       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 693
 694
 695
 696         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 697           Languages, Templates & CSS
 698           <span class="md-nav__icon md-icon"></span>
 699         </label>
 700
 701       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 702         <label class="md-nav__title" for="__nav_3">
 703           <span class="md-nav__icon md-icon"></span>
 704           Languages, Templates & CSS
 705         </label>
 706         <ul class="md-nav__list" data-md-scrollfix>
 707
 708
 709
 710
 711
 712
 713     <li class="md-nav__item">
 714       <a href="../../../view/languages/" class="md-nav__link">
 715         Languages
 716       </a>
 717     </li>
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727     <li class="md-nav__item">
 728       <a href="../../../view/templates/" class="md-nav__link">
 729         Templates
 730       </a>
 731     </li>
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741     <li class="md-nav__item">
 742       <a href="../../../view/template-modifiers/" class="md-nav__link">
 743         Template Modifiers
 744       </a>
 745     </li>
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755     <li class="md-nav__item">
 756       <a href="../../../view/template-plugins/" class="md-nav__link">
 757         Template Plugins
 758       </a>
 759     </li>
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769     <li class="md-nav__item">
 770       <a href="../../../view/css/" class="md-nav__link">
 771         CSS
 772       </a>
 773     </li>
 774
 775
 776
 777
 778         </ul>
 779       </nav>
 780     </li>
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792     <li class="md-nav__item md-nav__item--nested">
 793
 794
 795
 796
 797       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
 798
 799
 800
 801         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
 802           TypeScript and JavaScript API
 803           <span class="md-nav__icon md-icon"></span>
 804         </label>
 805
 806       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
 807         <label class="md-nav__title" for="__nav_4">
 808           <span class="md-nav__icon md-icon"></span>
 809           TypeScript and JavaScript API
 810         </label>
 811         <ul class="md-nav__list" data-md-scrollfix>
 812
 813
 814
 815
 816
 817
 818     <li class="md-nav__item">
 819       <a href="../../../javascript/general-usage/" class="md-nav__link">
 820         General Usage
 821       </a>
 822     </li>
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832     <li class="md-nav__item">
 833       <a href="../../../javascript/typescript/" class="md-nav__link">
 834         TypeScript
 835       </a>
 836     </li>
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847     <li class="md-nav__item md-nav__item--nested">
 848
 849
 850
 851
 852       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
 853
 854
 855
 856         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
 857           Components
 858           <span class="md-nav__icon md-icon"></span>
 859         </label>
 860
 861       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
 862         <label class="md-nav__title" for="__nav_4_3">
 863           <span class="md-nav__icon md-icon"></span>
 864           Components
 865         </label>
 866         <ul class="md-nav__list" data-md-scrollfix>
 867
 868
 869
 870
 871
 872
 873     <li class="md-nav__item">
 874       <a href="../../../javascript/components_confirmation/" class="md-nav__link">
 875         Confirmation
 876       </a>
 877     </li>
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887     <li class="md-nav__item">
 888       <a href="../../../javascript/components_dialog/" class="md-nav__link">
 889         Dialog
 890       </a>
 891     </li>
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901     <li class="md-nav__item">
 902       <a href="../../../javascript/components_google_maps/" class="md-nav__link">
 903         Google Maps
 904       </a>
 905     </li>
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915     <li class="md-nav__item">
 916       <a href="../../../javascript/components_pagination/" class="md-nav__link">
 917         Pagination
 918       </a>
 919     </li>
 920
 921
 922
 923
 924         </ul>
 925       </nav>
 926     </li>
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937     <li class="md-nav__item md-nav__item--nested">
 938
 939
 940
 941
 942       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
 943
 944
 945
 946         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
 947           New API
 948           <span class="md-nav__icon md-icon"></span>
 949         </label>
 950
 951       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
 952         <label class="md-nav__title" for="__nav_4_4">
 953           <span class="md-nav__icon md-icon"></span>
 954           New API
 955         </label>
 956         <ul class="md-nav__list" data-md-scrollfix>
 957
 958
 959
 960
 961
 962
 963     <li class="md-nav__item">
 964       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 965         Writing a module
 966       </a>
 967     </li>
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977     <li class="md-nav__item">
 978       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 979         Core Functions
 980       </a>
 981     </li>
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991     <li class="md-nav__item">
 992       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 993         DOM
 994       </a>
 995     </li>
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005     <li class="md-nav__item">
1006       <a href="../../../javascript/new-api_events/" class="md-nav__link">
1007         Event Handling
1008       </a>
1009     </li>
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019     <li class="md-nav__item">
1020       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1021         Ajax
1022       </a>
1023     </li>
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033     <li class="md-nav__item">
1034       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1035         Dialogs
1036       </a>
1037     </li>
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047     <li class="md-nav__item">
1048       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1049         Browser and Screen Sizes
1050       </a>
1051     </li>
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061     <li class="md-nav__item">
1062       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1063         User Interface
1064       </a>
1065     </li>
1066
1067
1068
1069
1070         </ul>
1071       </nav>
1072     </li>
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082     <li class="md-nav__item">
1083       <a href="../../../javascript/legacy-api/" class="md-nav__link">
1084         Legacy API
1085       </a>
1086     </li>
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096     <li class="md-nav__item">
1097       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1098         Code Snippets
1099       </a>
1100     </li>
1101
1102
1103
1104
1105         </ul>
1106       </nav>
1107     </li>
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119     <li class="md-nav__item md-nav__item--nested">
1120
1121
1122
1123
1124       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1125
1126
1127
1128         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1129           Package Components
1130           <span class="md-nav__icon md-icon"></span>
1131         </label>
1132
1133       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1134         <label class="md-nav__title" for="__nav_5">
1135           <span class="md-nav__icon md-icon"></span>
1136           Package Components
1137         </label>
1138         <ul class="md-nav__list" data-md-scrollfix>
1139
1140
1141
1142
1143
1144
1145     <li class="md-nav__item">
1146       <a href="../../../package/package-xml/" class="md-nav__link">
1147         package.xml
1148       </a>
1149     </li>
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160     <li class="md-nav__item md-nav__item--nested">
1161
1162
1163
1164
1165       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1166
1167
1168
1169         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1170           PIPs
1171           <span class="md-nav__icon md-icon"></span>
1172         </label>
1173
1174       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1175         <label class="md-nav__title" for="__nav_5_2">
1176           <span class="md-nav__icon md-icon"></span>
1177           PIPs
1178         </label>
1179         <ul class="md-nav__list" data-md-scrollfix>
1180
1181
1182
1183
1184
1185
1186     <li class="md-nav__item">
1187       <a href="../../../package/pip/" class="md-nav__link">
1188         Overview
1189       </a>
1190     </li>
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200     <li class="md-nav__item">
1201       <a href="../../../package/pip/acl-option/" class="md-nav__link">
1202         aclOption
1203       </a>
1204     </li>
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214     <li class="md-nav__item">
1215       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
1216         acpMenu
1217       </a>
1218     </li>
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228     <li class="md-nav__item">
1229       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
1230         acpSearchProvider
1231       </a>
1232     </li>
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242     <li class="md-nav__item">
1243       <a href="../../../package/pip/acp-template/" class="md-nav__link">
1244         acpTemplate
1245       </a>
1246     </li>
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256     <li class="md-nav__item">
1257       <a href="../../../package/pip/acp-template-delete/" class="md-nav__link">
1258         acpTemplateDelete
1259       </a>
1260     </li>
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270     <li class="md-nav__item">
1271       <a href="../../../package/pip/bbcode/" class="md-nav__link">
1272         bbcode
1273       </a>
1274     </li>
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284     <li class="md-nav__item">
1285       <a href="../../../package/pip/box/" class="md-nav__link">
1286         box
1287       </a>
1288     </li>
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298     <li class="md-nav__item">
1299       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1300         clipboardAction
1301       </a>
1302     </li>
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312     <li class="md-nav__item">
1313       <a href="../../../package/pip/core-object/" class="md-nav__link">
1314         coreObject
1315       </a>
1316     </li>
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326     <li class="md-nav__item">
1327       <a href="../../../package/pip/cronjob/" class="md-nav__link">
1328         cronjob
1329       </a>
1330     </li>
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340     <li class="md-nav__item">
1341       <a href="../../../package/pip/database/" class="md-nav__link">
1342         database
1343       </a>
1344     </li>
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354     <li class="md-nav__item">
1355       <a href="../../../package/pip/event-listener/" class="md-nav__link">
1356         eventListener
1357       </a>
1358     </li>
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368     <li class="md-nav__item">
1369       <a href="../../../package/pip/file/" class="md-nav__link">
1370         file
1371       </a>
1372     </li>
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382     <li class="md-nav__item">
1383       <a href="../../../package/pip/file-delete/" class="md-nav__link">
1384         fileDelete
1385       </a>
1386     </li>
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396     <li class="md-nav__item">
1397       <a href="../../../package/pip/language/" class="md-nav__link">
1398         language
1399       </a>
1400     </li>
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410     <li class="md-nav__item">
1411       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1412         mediaProvider
1413       </a>
1414     </li>
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424     <li class="md-nav__item">
1425       <a href="../../../package/pip/menu/" class="md-nav__link">
1426         menu
1427       </a>
1428     </li>
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438     <li class="md-nav__item">
1439       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1440         menuItem
1441       </a>
1442     </li>
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452     <li class="md-nav__item">
1453       <a href="../../../package/pip/object-type/" class="md-nav__link">
1454         objectType
1455       </a>
1456     </li>
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466     <li class="md-nav__item">
1467       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1468         objectTypeDefinition
1469       </a>
1470     </li>
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480     <li class="md-nav__item">
1481       <a href="../../../package/pip/option/" class="md-nav__link">
1482         option
1483       </a>
1484     </li>
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494     <li class="md-nav__item">
1495       <a href="../../../package/pip/page/" class="md-nav__link">
1496         page
1497       </a>
1498     </li>
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508     <li class="md-nav__item">
1509       <a href="../../../package/pip/pip/" class="md-nav__link">
1510         pip
1511       </a>
1512     </li>
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522     <li class="md-nav__item">
1523       <a href="../../../package/pip/script/" class="md-nav__link">
1524         script
1525       </a>
1526     </li>
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536     <li class="md-nav__item">
1537       <a href="../../../package/pip/smiley/" class="md-nav__link">
1538         smiley
1539       </a>
1540     </li>
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550     <li class="md-nav__item">
1551       <a href="../../../package/pip/sql/" class="md-nav__link">
1552         sql
1553       </a>
1554     </li>
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564     <li class="md-nav__item">
1565       <a href="../../../package/pip/style/" class="md-nav__link">
1566         style
1567       </a>
1568     </li>
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578     <li class="md-nav__item">
1579       <a href="../../../package/pip/template/" class="md-nav__link">
1580         template
1581       </a>
1582     </li>
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592     <li class="md-nav__item">
1593       <a href="../../../package/pip/template-delete/" class="md-nav__link">
1594         templateDelete
1595       </a>
1596     </li>
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606     <li class="md-nav__item">
1607       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1608         templateListener
1609       </a>
1610     </li>
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620     <li class="md-nav__item">
1621       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1622         userGroupOption
1623       </a>
1624     </li>
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634     <li class="md-nav__item">
1635       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1636         userMenu
1637       </a>
1638     </li>
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648     <li class="md-nav__item">
1649       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1650         userNotificationEvent
1651       </a>
1652     </li>
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662     <li class="md-nav__item">
1663       <a href="../../../package/pip/user-option/" class="md-nav__link">
1664         userOption
1665       </a>
1666     </li>
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676     <li class="md-nav__item">
1677       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1678         userProfileMenu
1679       </a>
1680     </li>
1681
1682
1683
1684
1685         </ul>
1686       </nav>
1687     </li>
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697     <li class="md-nav__item">
1698       <a href="../../../package/database-php-api/" class="md-nav__link">
1699         Database PHP API
1700       </a>
1701     </li>
1702
1703
1704
1705
1706         </ul>
1707       </nav>
1708     </li>
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1723
1724
1725
1726
1727       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
1728
1729
1730
1731         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1732           Migration
1733           <span class="md-nav__icon md-icon"></span>
1734         </label>
1735
1736       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
1737         <label class="md-nav__title" for="__nav_6">
1738           <span class="md-nav__icon md-icon"></span>
1739           Migration
1740         </label>
1741         <ul class="md-nav__list" data-md-scrollfix>
1742
1743
1744
1745
1746
1747
1748
1749     <li class="md-nav__item md-nav__item--nested">
1750
1751
1752
1753
1754       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1755
1756
1757
1758         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1759           From WoltLab Suite 5.5
1760           <span class="md-nav__icon md-icon"></span>
1761         </label>
1762
1763       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1764         <label class="md-nav__title" for="__nav_6_1">
1765           <span class="md-nav__icon md-icon"></span>
1766           From WoltLab Suite 5.5
1767         </label>
1768         <ul class="md-nav__list" data-md-scrollfix>
1769
1770
1771
1772
1773
1774
1775     <li class="md-nav__item">
1776       <a href="../../wsc55/php/" class="md-nav__link">
1777         PHP API
1778       </a>
1779     </li>
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789     <li class="md-nav__item">
1790       <a href="../../wsc55/javascript/" class="md-nav__link">
1791         TypeScript and JavaScript
1792       </a>
1793     </li>
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803     <li class="md-nav__item">
1804       <a href="../../wsc55/templates/" class="md-nav__link">
1805         Templates
1806       </a>
1807     </li>
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817     <li class="md-nav__item">
1818       <a href="../../wsc55/icons/" class="md-nav__link">
1819         Icons
1820       </a>
1821     </li>
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831     <li class="md-nav__item">
1832       <a href="../../wsc55/dialogs/" class="md-nav__link">
1833         Dialogs
1834       </a>
1835     </li>
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845     <li class="md-nav__item">
1846       <a href="../../wsc55/libraries/" class="md-nav__link">
1847         Third Party Libraries
1848       </a>
1849     </li>
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859     <li class="md-nav__item">
1860       <a href="../../wsc55/deprecations_removals/" class="md-nav__link">
1861         Deprecations and Removals
1862       </a>
1863     </li>
1864
1865
1866
1867
1868         </ul>
1869       </nav>
1870     </li>
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1884
1885
1886
1887
1888       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" checked>
1889
1890
1891
1892         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
1893           From WoltLab Suite 5.4
1894           <span class="md-nav__icon md-icon"></span>
1895         </label>
1896
1897       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="true">
1898         <label class="md-nav__title" for="__nav_6_2">
1899           <span class="md-nav__icon md-icon"></span>
1900           From WoltLab Suite 5.4
1901         </label>
1902         <ul class="md-nav__list" data-md-scrollfix>
1903
1904
1905
1906
1907
1908
1909
1910
1911     <li class="md-nav__item md-nav__item--active">
1912
1913       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1914
1915
1916
1917
1918
1919         <label class="md-nav__link md-nav__link--active" for="__toc">
1920           PHP API
1921           <span class="md-nav__icon md-icon"></span>
1922         </label>
1923
1924       <a href="./" class="md-nav__link md-nav__link--active">
1925         PHP API
1926       </a>
1927
1928
1929
1930 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1931
1932
1933
1934
1935
1936
1937     <label class="md-nav__title" for="__toc">
1938       <span class="md-nav__icon md-icon"></span>
1939       Table of contents
1940     </label>
1941     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1942
1943         <li class="md-nav__item">
1944   <a href="#initial-psr-7-support" class="md-nav__link">
1945     Initial PSR-7 support
1946   </a>
1947
1948     <nav class="md-nav" aria-label="Initial PSR-7 support">
1949       <ul class="md-nav__list">
1950
1951           <li class="md-nav__item">
1952   <a href="#recommended-changes-for-woltlab-suite-55" class="md-nav__link">
1953     Recommended changes for WoltLab Suite 5.5
1954   </a>
1955
1956     <nav class="md-nav" aria-label="Recommended changes for WoltLab Suite 5.5">
1957       <ul class="md-nav__list">
1958
1959           <li class="md-nav__item">
1960   <a href="#migrating-redirects" class="md-nav__link">
1961     Migrating Redirects
1962   </a>
1963
1964 </li>
1965
1966           <li class="md-nav__item">
1967   <a href="#migrating-json-responses" class="md-nav__link">
1968     Migrating JSON responses
1969   </a>
1970
1971 </li>
1972
1973       </ul>
1974     </nav>
1975
1976 </li>
1977
1978       </ul>
1979     </nav>
1980
1981 </li>
1982
1983         <li class="md-nav__item">
1984   <a href="#events" class="md-nav__link">
1985     Events
1986   </a>
1987
1988 </li>
1989
1990         <li class="md-nav__item">
1991   <a href="#authentication" class="md-nav__link">
1992     Authentication
1993   </a>
1994
1995 </li>
1996
1997         <li class="md-nav__item">
1998   <a href="#embedded-objects-in-comments" class="md-nav__link">
1999     Embedded Objects in Comments
2000   </a>
2001
2002 </li>
2003
2004         <li class="md-nav__item">
2005   <a href="#emails" class="md-nav__link">
2006     Emails
2007   </a>
2008
2009     <nav class="md-nav" aria-label="Emails">
2010       <ul class="md-nav__list">
2011
2012           <li class="md-nav__item">
2013   <a href="#mailbox" class="md-nav__link">
2014     Mailbox
2015   </a>
2016
2017 </li>
2018
2019           <li class="md-nav__item">
2020   <a href="#smtp" class="md-nav__link">
2021     SMTP
2022   </a>
2023
2024 </li>
2025
2026       </ul>
2027     </nav>
2028
2029 </li>
2030
2031         <li class="md-nav__item">
2032   <a href="#search" class="md-nav__link">
2033     Search
2034   </a>
2035
2036     <nav class="md-nav" aria-label="Search">
2037       <ul class="md-nav__list">
2038
2039           <li class="md-nav__item">
2040   <a href="#search-form" class="md-nav__link">
2041     Search Form
2042   </a>
2043
2044 </li>
2045
2046           <li class="md-nav__item">
2047   <a href="#exceptions" class="md-nav__link">
2048     Exceptions
2049   </a>
2050
2051 </li>
2052
2053       </ul>
2054     </nav>
2055
2056 </li>
2057
2058         <li class="md-nav__item">
2059   <a href="#package-installation-plugins" class="md-nav__link">
2060     Package Installation Plugins
2061   </a>
2062
2063     <nav class="md-nav" aria-label="Package Installation Plugins">
2064       <ul class="md-nav__list">
2065
2066           <li class="md-nav__item">
2067   <a href="#database" class="md-nav__link">
2068     Database
2069   </a>
2070
2071 </li>
2072
2073           <li class="md-nav__item">
2074   <a href="#file-deletion" class="md-nav__link">
2075     File Deletion
2076   </a>
2077
2078 </li>
2079
2080           <li class="md-nav__item">
2081   <a href="#language" class="md-nav__link">
2082     Language
2083   </a>
2084
2085 </li>
2086
2087       </ul>
2088     </nav>
2089
2090 </li>
2091
2092         <li class="md-nav__item">
2093   <a href="#board-and-thread-subscriptions" class="md-nav__link">
2094     Board and Thread Subscriptions
2095   </a>
2096
2097 </li>
2098
2099         <li class="md-nav__item">
2100   <a href="#miscellaneous-changes" class="md-nav__link">
2101     Miscellaneous Changes
2102   </a>
2103
2104     <nav class="md-nav" aria-label="Miscellaneous Changes">
2105       <ul class="md-nav__list">
2106
2107           <li class="md-nav__item">
2108   <a href="#view-counters" class="md-nav__link">
2109     View Counters
2110   </a>
2111
2112 </li>
2113
2114           <li class="md-nav__item">
2115   <a href="#form-builder" class="md-nav__link">
2116     Form Builder
2117   </a>
2118
2119 </li>
2120
2121       </ul>
2122     </nav>
2123
2124 </li>
2125
2126     </ul>
2127
2128 </nav>
2129
2130     </li>
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140     <li class="md-nav__item">
2141       <a href="../javascript/" class="md-nav__link">
2142         TypeScript and JavaScript
2143       </a>
2144     </li>
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154     <li class="md-nav__item">
2155       <a href="../templates/" class="md-nav__link">
2156         Templates
2157       </a>
2158     </li>
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168     <li class="md-nav__item">
2169       <a href="../libraries/" class="md-nav__link">
2170         Third Party Libraries
2171       </a>
2172     </li>
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182     <li class="md-nav__item">
2183       <a href="../deprecations_removals/" class="md-nav__link">
2184         Deprecations and Removals
2185       </a>
2186     </li>
2187
2188
2189
2190
2191         </ul>
2192       </nav>
2193     </li>
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204     <li class="md-nav__item md-nav__item--nested">
2205
2206
2207
2208
2209       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2210
2211
2212
2213         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2214           From WoltLab Suite 5.3
2215           <span class="md-nav__icon md-icon"></span>
2216         </label>
2217
2218       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2219         <label class="md-nav__title" for="__nav_6_3">
2220           <span class="md-nav__icon md-icon"></span>
2221           From WoltLab Suite 5.3
2222         </label>
2223         <ul class="md-nav__list" data-md-scrollfix>
2224
2225
2226
2227
2228
2229
2230     <li class="md-nav__item">
2231       <a href="../../wsc53/php/" class="md-nav__link">
2232         PHP API
2233       </a>
2234     </li>
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244     <li class="md-nav__item">
2245       <a href="../../wsc53/session/" class="md-nav__link">
2246         Session Handling and Authentication
2247       </a>
2248     </li>
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258     <li class="md-nav__item">
2259       <a href="../../wsc53/javascript/" class="md-nav__link">
2260         TypeScript and JavaScript
2261       </a>
2262     </li>
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272     <li class="md-nav__item">
2273       <a href="../../wsc53/templates/" class="md-nav__link">
2274         Templates
2275       </a>
2276     </li>
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286     <li class="md-nav__item">
2287       <a href="../../wsc53/libraries/" class="md-nav__link">
2288         Third Party Libraries
2289       </a>
2290     </li>
2291
2292
2293
2294
2295         </ul>
2296       </nav>
2297     </li>
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308     <li class="md-nav__item md-nav__item--nested">
2309
2310
2311
2312
2313       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2314
2315
2316
2317         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2318           From WoltLab Suite 5.2
2319           <span class="md-nav__icon md-icon"></span>
2320         </label>
2321
2322       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2323         <label class="md-nav__title" for="__nav_6_4">
2324           <span class="md-nav__icon md-icon"></span>
2325           From WoltLab Suite 5.2
2326         </label>
2327         <ul class="md-nav__list" data-md-scrollfix>
2328
2329
2330
2331
2332
2333
2334     <li class="md-nav__item">
2335       <a href="../../wsc52/php/" class="md-nav__link">
2336         PHP API
2337       </a>
2338     </li>
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348     <li class="md-nav__item">
2349       <a href="../../wsc52/templates/" class="md-nav__link">
2350         Templates and Languages
2351       </a>
2352     </li>
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362     <li class="md-nav__item">
2363       <a href="../../wsc52/libraries/" class="md-nav__link">
2364         Third Party Libraries
2365       </a>
2366     </li>
2367
2368
2369
2370
2371         </ul>
2372       </nav>
2373     </li>
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384     <li class="md-nav__item md-nav__item--nested">
2385
2386
2387
2388
2389       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2390
2391
2392
2393         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2394           From WoltLab Suite 3.1
2395           <span class="md-nav__icon md-icon"></span>
2396         </label>
2397
2398       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2399         <label class="md-nav__title" for="__nav_6_5">
2400           <span class="md-nav__icon md-icon"></span>
2401           From WoltLab Suite 3.1
2402         </label>
2403         <ul class="md-nav__list" data-md-scrollfix>
2404
2405
2406
2407
2408
2409
2410     <li class="md-nav__item">
2411       <a href="../../wsc31/php/" class="md-nav__link">
2412         PHP API
2413       </a>
2414     </li>
2415
2416
2417
2418
2419         </ul>
2420       </nav>
2421     </li>
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432     <li class="md-nav__item md-nav__item--nested">
2433
2434
2435
2436
2437       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2438
2439
2440
2441         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2442           From WoltLab Suite 3.0
2443           <span class="md-nav__icon md-icon"></span>
2444         </label>
2445
2446       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2447         <label class="md-nav__title" for="__nav_6_6">
2448           <span class="md-nav__icon md-icon"></span>
2449           From WoltLab Suite 3.0
2450         </label>
2451         <ul class="md-nav__list" data-md-scrollfix>
2452
2453
2454
2455
2456
2457
2458     <li class="md-nav__item">
2459       <a href="../../wsc30/php/" class="md-nav__link">
2460         PHP API
2461       </a>
2462     </li>
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472     <li class="md-nav__item">
2473       <a href="../../wsc30/javascript/" class="md-nav__link">
2474         JavaScript API
2475       </a>
2476     </li>
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486     <li class="md-nav__item">
2487       <a href="../../wsc30/templates/" class="md-nav__link">
2488         Templates
2489       </a>
2490     </li>
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500     <li class="md-nav__item">
2501       <a href="../../wsc30/css/" class="md-nav__link">
2502         CSS
2503       </a>
2504     </li>
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514     <li class="md-nav__item">
2515       <a href="../../wsc30/package/" class="md-nav__link">
2516         Package Components
2517       </a>
2518     </li>
2519
2520
2521
2522
2523         </ul>
2524       </nav>
2525     </li>
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536     <li class="md-nav__item md-nav__item--nested">
2537
2538
2539
2540
2541       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2542
2543
2544
2545         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2546           From WCF 2.1
2547           <span class="md-nav__icon md-icon"></span>
2548         </label>
2549
2550       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2551         <label class="md-nav__title" for="__nav_6_7">
2552           <span class="md-nav__icon md-icon"></span>
2553           From WCF 2.1
2554         </label>
2555         <ul class="md-nav__list" data-md-scrollfix>
2556
2557
2558
2559
2560
2561
2562     <li class="md-nav__item">
2563       <a href="../../wcf21/php/" class="md-nav__link">
2564         PHP API
2565       </a>
2566     </li>
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576     <li class="md-nav__item">
2577       <a href="../../wcf21/templates/" class="md-nav__link">
2578         Templates
2579       </a>
2580     </li>
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590     <li class="md-nav__item">
2591       <a href="../../wcf21/css/" class="md-nav__link">
2592         CSS
2593       </a>
2594     </li>
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604     <li class="md-nav__item">
2605       <a href="../../wcf21/package/" class="md-nav__link">
2606         Package Components
2607       </a>
2608     </li>
2609
2610
2611
2612
2613         </ul>
2614       </nav>
2615     </li>
2616
2617
2618
2619
2620         </ul>
2621       </nav>
2622     </li>
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634     <li class="md-nav__item md-nav__item--nested">
2635
2636
2637
2638
2639       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2640
2641
2642
2643         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2644           Tutorials
2645           <span class="md-nav__icon md-icon"></span>
2646         </label>
2647
2648       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2649         <label class="md-nav__title" for="__nav_7">
2650           <span class="md-nav__icon md-icon"></span>
2651           Tutorials
2652         </label>
2653         <ul class="md-nav__list" data-md-scrollfix>
2654
2655
2656
2657
2658
2659
2660
2661     <li class="md-nav__item md-nav__item--nested">
2662
2663
2664
2665
2666       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2667
2668
2669
2670         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2671           Tutorial Series
2672           <span class="md-nav__icon md-icon"></span>
2673         </label>
2674
2675       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2676         <label class="md-nav__title" for="__nav_7_1">
2677           <span class="md-nav__icon md-icon"></span>
2678           Tutorial Series
2679         </label>
2680         <ul class="md-nav__list" data-md-scrollfix>
2681
2682
2683
2684
2685
2686
2687     <li class="md-nav__item">
2688       <a href="../../../tutorial/series/overview/" class="md-nav__link">
2689         Overview
2690       </a>
2691     </li>
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701     <li class="md-nav__item">
2702       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2703         Part 1
2704       </a>
2705     </li>
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715     <li class="md-nav__item">
2716       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2717         Part 2
2718       </a>
2719     </li>
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729     <li class="md-nav__item">
2730       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2731         Part 3
2732       </a>
2733     </li>
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743     <li class="md-nav__item">
2744       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2745         Part 4
2746       </a>
2747     </li>
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757     <li class="md-nav__item">
2758       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2759         Part 5
2760       </a>
2761     </li>
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771     <li class="md-nav__item">
2772       <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2773         Part 6
2774       </a>
2775     </li>
2776
2777
2778
2779
2780         </ul>
2781       </nav>
2782     </li>
2783
2784
2785
2786
2787         </ul>
2788       </nav>
2789     </li>
2790
2791
2792
2793   </ul>
2794 </nav>
2795                   </div>
2796                 </div>
2797               </div>
2798
2799
2800
2801               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2802                 <div class="md-sidebar__scrollwrap">
2803                   <div class="md-sidebar__inner">
2804
2805
2806 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2807
2808
2809
2810
2811
2812
2813     <label class="md-nav__title" for="__toc">
2814       <span class="md-nav__icon md-icon"></span>
2815       Table of contents
2816     </label>
2817     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2818
2819         <li class="md-nav__item">
2820   <a href="#initial-psr-7-support" class="md-nav__link">
2821     Initial PSR-7 support
2822   </a>
2823
2824     <nav class="md-nav" aria-label="Initial PSR-7 support">
2825       <ul class="md-nav__list">
2826
2827           <li class="md-nav__item">
2828   <a href="#recommended-changes-for-woltlab-suite-55" class="md-nav__link">
2829     Recommended changes for WoltLab Suite 5.5
2830   </a>
2831
2832     <nav class="md-nav" aria-label="Recommended changes for WoltLab Suite 5.5">
2833       <ul class="md-nav__list">
2834
2835           <li class="md-nav__item">
2836   <a href="#migrating-redirects" class="md-nav__link">
2837     Migrating Redirects
2838   </a>
2839
2840 </li>
2841
2842           <li class="md-nav__item">
2843   <a href="#migrating-json-responses" class="md-nav__link">
2844     Migrating JSON responses
2845   </a>
2846
2847 </li>
2848
2849       </ul>
2850     </nav>
2851
2852 </li>
2853
2854       </ul>
2855     </nav>
2856
2857 </li>
2858
2859         <li class="md-nav__item">
2860   <a href="#events" class="md-nav__link">
2861     Events
2862   </a>
2863
2864 </li>
2865
2866         <li class="md-nav__item">
2867   <a href="#authentication" class="md-nav__link">
2868     Authentication
2869   </a>
2870
2871 </li>
2872
2873         <li class="md-nav__item">
2874   <a href="#embedded-objects-in-comments" class="md-nav__link">
2875     Embedded Objects in Comments
2876   </a>
2877
2878 </li>
2879
2880         <li class="md-nav__item">
2881   <a href="#emails" class="md-nav__link">
2882     Emails
2883   </a>
2884
2885     <nav class="md-nav" aria-label="Emails">
2886       <ul class="md-nav__list">
2887
2888           <li class="md-nav__item">
2889   <a href="#mailbox" class="md-nav__link">
2890     Mailbox
2891   </a>
2892
2893 </li>
2894
2895           <li class="md-nav__item">
2896   <a href="#smtp" class="md-nav__link">
2897     SMTP
2898   </a>
2899
2900 </li>
2901
2902       </ul>
2903     </nav>
2904
2905 </li>
2906
2907         <li class="md-nav__item">
2908   <a href="#search" class="md-nav__link">
2909     Search
2910   </a>
2911
2912     <nav class="md-nav" aria-label="Search">
2913       <ul class="md-nav__list">
2914
2915           <li class="md-nav__item">
2916   <a href="#search-form" class="md-nav__link">
2917     Search Form
2918   </a>
2919
2920 </li>
2921
2922           <li class="md-nav__item">
2923   <a href="#exceptions" class="md-nav__link">
2924     Exceptions
2925   </a>
2926
2927 </li>
2928
2929       </ul>
2930     </nav>
2931
2932 </li>
2933
2934         <li class="md-nav__item">
2935   <a href="#package-installation-plugins" class="md-nav__link">
2936     Package Installation Plugins
2937   </a>
2938
2939     <nav class="md-nav" aria-label="Package Installation Plugins">
2940       <ul class="md-nav__list">
2941
2942           <li class="md-nav__item">
2943   <a href="#database" class="md-nav__link">
2944     Database
2945   </a>
2946
2947 </li>
2948
2949           <li class="md-nav__item">
2950   <a href="#file-deletion" class="md-nav__link">
2951     File Deletion
2952   </a>
2953
2954 </li>
2955
2956           <li class="md-nav__item">
2957   <a href="#language" class="md-nav__link">
2958     Language
2959   </a>
2960
2961 </li>
2962
2963       </ul>
2964     </nav>
2965
2966 </li>
2967
2968         <li class="md-nav__item">
2969   <a href="#board-and-thread-subscriptions" class="md-nav__link">
2970     Board and Thread Subscriptions
2971   </a>
2972
2973 </li>
2974
2975         <li class="md-nav__item">
2976   <a href="#miscellaneous-changes" class="md-nav__link">
2977     Miscellaneous Changes
2978   </a>
2979
2980     <nav class="md-nav" aria-label="Miscellaneous Changes">
2981       <ul class="md-nav__list">
2982
2983           <li class="md-nav__item">
2984   <a href="#view-counters" class="md-nav__link">
2985     View Counters
2986   </a>
2987
2988 </li>
2989
2990           <li class="md-nav__item">
2991   <a href="#form-builder" class="md-nav__link">
2992     Form Builder
2993   </a>
2994
2995 </li>
2996
2997       </ul>
2998     </nav>
2999
3000 </li>
3001
3002     </ul>
3003
3004 </nav>
3005                   </div>
3006                 </div>
3007               </div>
3008
3009
3010
3011             <div class="md-content" data-md-component="content">
3012               <article class="md-content__inner md-typeset">
3013
3014
3015
3016
3017
3018
3019
3020 <h1 id="migrating-from-woltlab-suite-54-php">Migrating from WoltLab Suite 5.4 - PHP<a class="headerlink" href="#migrating-from-woltlab-suite-54-php" title="Permanent link">#</a></h1>
3021 <h2 id="initial-psr-7-support">Initial PSR-7 support<a class="headerlink" href="#initial-psr-7-support" title="Permanent link">#</a></h2>
3022 <p>WoltLab Suite will <em>incrementally</em> add support for object oriented request/response handling based off the <a href="https://www.php-fig.org/psr/psr-7/">PSR-7</a> and <a href="https://www.php-fig.org/psr/psr-15/">PSR-15</a> standards in the upcoming versions.</p>
3023 <p>WoltLab Suite 5.5 adds initial support by allowing to define the response using objects implementing the PSR-7 <code>ResponseInterface</code>.
3024 If a controller returns such a response object from its <code>__run()</code> method, this response will automatically emitted to the client.</p>
3025 <p>Any PSR-7 implementation is supported, but WoltLab Suite 5.5 ships with <a href="https://docs.laminas.dev/laminas-diactoros/">laminas-diactoros</a> as the recommended “batteries included” implementation of PSR-7.</p>
3026 <p>Support for PSR-7 requests and PSR-15 middlewares is expected to follow in future versions.</p>
3027 <p>See <a href="https://github.com/WoltLab/WCF/pull/4437">WoltLab/WCF#4437</a> for details.</p>
3028 <h3 id="recommended-changes-for-woltlab-suite-55">Recommended changes for WoltLab Suite 5.5<a class="headerlink" href="#recommended-changes-for-woltlab-suite-55" title="Permanent link">#</a></h3>
3029 <p>With the current support in WoltLab Suite 5.5 it is recommended to migrate the <code>*Action</code> classes to make use of PSR-7 responses.
3030 Control and data flow is typically fairly simple in <code>*Action</code> classes with most requests ending up in either a redirect or a JSON response, commonly followed by a call to <code>exit;</code>.</p>
3031 <p>Experimental support for <code>*Page</code> and <code>*Form</code> is available.
3032 It is recommended to wait for a future version before migrating these types of controllers.</p>
3033 <h4 id="migrating-redirects">Migrating Redirects<a class="headerlink" href="#migrating-redirects" title="Permanent link">#</a></h4>
3034 <p>Previously:</p>
3035 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">lib/action/ExampleRedirectAction.class.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3036 <span class="normal"> 2</span>
3037 <span class="normal"> 3</span>
3038 <span class="normal"> 4</span>
3039 <span class="normal"> 5</span>
3040 <span class="normal"> 6</span>
3041 <span class="normal"> 7</span>
3042 <span class="normal"> 8</span>
3043 <span class="normal"> 9</span>
3044 <span class="normal">10</span>
3045 <span class="normal">11</span>
3046 <span class="normal">12</span>
3047 <span class="normal">13</span>
3048 <span class="normal">14</span>
3049 <span class="normal">15</span>
3050 <span class="normal">16</span>
3051 <span class="normal">17</span>
3052 <span class="normal">18</span>
3053 <span class="normal">19</span>
3054 <span class="normal">20</span>
3055 <span class="normal">21</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3056
3057 <span class="k">namespace</span> <span class="nx">wcf\action</span><span class="p">;</span>
3058
3059 <span class="k">use</span> <span class="nx">wcf\system\request\LinkHandler</span><span class="p">;</span>
3060 <span class="k">use</span> <span class="nx">wcf\util\HeaderUtil</span><span class="p">;</span>
3061
3062 <span class="k">final</span> <span class="k">class</span> <span class="nc">ExampleRedirectAction</span> <span class="k">extends</span> <span class="nx">AbstractAction</span>
3063 <span class="p">{</span>
3064     <span class="k">public</span> <span class="k">function</span> <span class="nf">execute</span><span class="p">()</span>
3065     <span class="p">{</span>
3066         <span class="k">parent</span><span class="o">::</span><span class="na">execute</span><span class="p">();</span>
3067
3068         <span class="c1">// Redirect to the landing page.</span>
3069         <span class="nx">HeaderUtil</span><span class="o">::</span><span class="na">redirect</span><span class="p">(</span>
3070             <span class="nx">LinkHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="p">()</span>
3071         <span class="p">);</span>
3072
3073         <span class="k">exit</span><span class="p">;</span>
3074     <span class="p">}</span>
3075 <span class="p">}</span>
3076 </code></pre></div></td></tr></table></div>
3077 <p>Now:</p>
3078 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">lib/action/ExampleRedirectAction.class.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3079 <span class="normal"> 2</span>
3080 <span class="normal"> 3</span>
3081 <span class="normal"> 4</span>
3082 <span class="normal"> 5</span>
3083 <span class="normal"> 6</span>
3084 <span class="normal"> 7</span>
3085 <span class="normal"> 8</span>
3086 <span class="normal"> 9</span>
3087 <span class="normal">10</span>
3088 <span class="normal">11</span>
3089 <span class="normal">12</span>
3090 <span class="normal">13</span>
3091 <span class="normal">14</span>
3092 <span class="normal">15</span>
3093 <span class="normal">16</span>
3094 <span class="normal">17</span>
3095 <span class="normal">18</span>
3096 <span class="normal">19</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3097
3098 <span class="k">namespace</span> <span class="nx">wcf\action</span><span class="p">;</span>
3099
3100 <span class="k">use</span> <span class="nx">Laminas\Diactoros\Response\RedirectResponse</span><span class="p">;</span>
3101 <span class="k">use</span> <span class="nx">wcf\system\request\LinkHandler</span><span class="p">;</span>
3102
3103 <span class="k">final</span> <span class="k">class</span> <span class="nc">ExampleRedirectAction</span> <span class="k">extends</span> <span class="nx">AbstractAction</span>
3104 <span class="p">{</span>
3105     <span class="k">public</span> <span class="k">function</span> <span class="nf">execute</span><span class="p">()</span>
3106     <span class="p">{</span>
3107         <span class="k">parent</span><span class="o">::</span><span class="na">execute</span><span class="p">();</span>
3108
3109         <span class="c1">// Redirect to the landing page.</span>
3110         <span class="k">return</span> <span class="k">new</span> <span class="nx">RedirectResponse</span><span class="p">(</span>
3111             <span class="nx">LinkHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="p">()</span>
3112         <span class="p">);</span>
3113     <span class="p">}</span>
3114 <span class="p">}</span>
3115 </code></pre></div></td></tr></table></div>
3116 <h4 id="migrating-json-responses">Migrating JSON responses<a class="headerlink" href="#migrating-json-responses" title="Permanent link">#</a></h4>
3117 <p>Previously:</p>
3118 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">lib/action/ExampleJsonAction.class.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3119 <span class="normal"> 2</span>
3120 <span class="normal"> 3</span>
3121 <span class="normal"> 4</span>
3122 <span class="normal"> 5</span>
3123 <span class="normal"> 6</span>
3124 <span class="normal"> 7</span>
3125 <span class="normal"> 8</span>
3126 <span class="normal"> 9</span>
3127 <span class="normal">10</span>
3128 <span class="normal">11</span>
3129 <span class="normal">12</span>
3130 <span class="normal">13</span>
3131 <span class="normal">14</span>
3132 <span class="normal">15</span>
3133 <span class="normal">16</span>
3134 <span class="normal">17</span>
3135 <span class="normal">18</span>
3136 <span class="normal">19</span>
3137 <span class="normal">20</span>
3138 <span class="normal">21</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3139
3140 <span class="k">namespace</span> <span class="nx">wcf\action</span><span class="p">;</span>
3141
3142 <span class="k">use</span> <span class="nx">wcf\util\JSON</span><span class="p">;</span>
3143
3144 <span class="k">final</span> <span class="k">class</span> <span class="nc">ExampleJsonAction</span> <span class="k">extends</span> <span class="nx">AbstractAction</span>
3145 <span class="p">{</span>
3146     <span class="k">public</span> <span class="k">function</span> <span class="nf">execute</span><span class="p">()</span>
3147     <span class="p">{</span>
3148         <span class="k">parent</span><span class="o">::</span><span class="na">execute</span><span class="p">();</span>
3149
3150         <span class="nx">\header</span><span class="p">(</span><span class="s1">&#39;Content-type: application/json; charset=UTF-8&#39;</span><span class="p">);</span>
3151
3152         <span class="k">echo</span> <span class="nx">JSON</span><span class="o">::</span><span class="na">encode</span><span class="p">([</span>
3153             <span class="s1">&#39;foo&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;bar&#39;</span><span class="p">,</span>
3154         <span class="p">]);</span>
3155
3156         <span class="k">exit</span><span class="p">;</span>
3157     <span class="p">}</span>
3158 <span class="p">}</span>
3159 </code></pre></div></td></tr></table></div>
3160 <p>Now:</p>
3161 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">lib/action/ExampleJsonAction.class.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3162 <span class="normal"> 2</span>
3163 <span class="normal"> 3</span>
3164 <span class="normal"> 4</span>
3165 <span class="normal"> 5</span>
3166 <span class="normal"> 6</span>
3167 <span class="normal"> 7</span>
3168 <span class="normal"> 8</span>
3169 <span class="normal"> 9</span>
3170 <span class="normal">10</span>
3171 <span class="normal">11</span>
3172 <span class="normal">12</span>
3173 <span class="normal">13</span>
3174 <span class="normal">14</span>
3175 <span class="normal">15</span>
3176 <span class="normal">16</span>
3177 <span class="normal">17</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3178
3179 <span class="k">namespace</span> <span class="nx">wcf\action</span><span class="p">;</span>
3180
3181 <span class="k">use</span> <span class="nx">Laminas\Diactoros\Response\JsonResponse</span><span class="p">;</span>
3182
3183 <span class="k">final</span> <span class="k">class</span> <span class="nc">ExampleJsonAction</span> <span class="k">extends</span> <span class="nx">AbstractAction</span>
3184 <span class="p">{</span>
3185     <span class="k">public</span> <span class="k">function</span> <span class="nf">execute</span><span class="p">()</span>
3186     <span class="p">{</span>
3187         <span class="k">parent</span><span class="o">::</span><span class="na">execute</span><span class="p">();</span>
3188
3189         <span class="k">return</span> <span class="k">new</span> <span class="nx">JsonResponse</span><span class="p">([</span>
3190             <span class="s1">&#39;foo&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;bar&#39;</span><span class="p">,</span>
3191         <span class="p">]);</span>
3192     <span class="p">}</span>
3193 <span class="p">}</span>
3194 </code></pre></div></td></tr></table></div>
3195 <h2 id="events">Events<a class="headerlink" href="#events" title="Permanent link">#</a></h2>
3196 <p>Historically, events were tightly coupled with a single class, with the event object being an object of this class, expecting the event listener to consume public properties and method of the event object.
3197 The <code>$parameters</code> array was introduced due to limitations of this pattern, avoiding moving all the values that might be of interest to the event listener into the state of the object.
3198 Events were still tightly coupled with the class that fired the event and using the opaque parameters array prevented IDEs from assisting with autocompletion and typing.</p>
3199 <p>WoltLab Suite 5.5 introduces the concept of dedicated, reusable event classes.
3200 Any newly introduced event will receive a dedicated class, implementing the <code>wcf\system\event\IEvent</code> interface.
3201 These event classes may be fired from multiple locations, making them reusable to convey that a conceptual action happened, instead of a specific class doing something.
3202 An example for using the new event system could be a user logging in:
3203 Instead of listening on a the login form being submitted and the Facebook login action successfully running, an event <code>UserLoggedIn</code> might be fired whenever a user logs in, no matter how the login is performed.</p>
3204 <p>Additionally, these dedicated event classes will benefit from full IDE support.
3205 All the relevant values may be stored as real properties on the event object.</p>
3206 <p>Event classes should not have an <code>Event</code> suffix and should be stored in an <code>event</code> namespace in a matching location.
3207 Thus, the <code>UserLoggedIn</code> example might have a FQCN of <code>\wcf\system\user\authentication\event\UserLoggedIn</code>.</p>
3208 <p>Event listeners for events implementing <code>IEvent</code> need to follow <a href="https://www.php-fig.org/psr/psr-14/">PSR-14</a>, i.e. they need to be callable.
3209 In practice, this means that the event listener class needs to implement <code>__invoke()</code>.
3210 No interface has to be implemented in this case.</p>
3211 <p>Previously:</p>
3212 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3213 <span class="normal">2</span>
3214 <span class="normal">3</span>
3215 <span class="normal">4</span>
3216 <span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nv">$parameters</span> <span class="o">=</span> <span class="p">[</span>
3217     <span class="s1">&#39;value&#39;</span> <span class="o">=&gt;</span> <span class="nx">\random_int</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1024</span><span class="p">),</span>
3218 <span class="p">];</span>
3219
3220 <span class="nx">EventHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">fireAction</span><span class="p">(</span><span class="nv">$this</span><span class="p">,</span> <span class="s1">&#39;valueAvailable&#39;</span><span class="p">,</span> <span class="nv">$parameters</span><span class="p">);</span>
3221 </code></pre></div></td></tr></table></div>
3222 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">lib/system/event/listener/ValueDumpListener.class.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3223 <span class="normal"> 2</span>
3224 <span class="normal"> 3</span>
3225 <span class="normal"> 4</span>
3226 <span class="normal"> 5</span>
3227 <span class="normal"> 6</span>
3228 <span class="normal"> 7</span>
3229 <span class="normal"> 8</span>
3230 <span class="normal"> 9</span>
3231 <span class="normal">10</span>
3232 <span class="normal">11</span>
3233 <span class="normal">12</span>
3234 <span class="normal">13</span>
3235 <span class="normal">14</span>
3236 <span class="normal">15</span>
3237 <span class="normal">16</span>
3238 <span class="normal">17</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3239
3240 <span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span>
3241
3242 <span class="k">use</span> <span class="nx">wcf\form\ValueForm</span><span class="p">;</span>
3243
3244 <span class="k">final</span> <span class="k">class</span> <span class="nc">ValueDumpListener</span> <span class="k">implements</span> <span class="nx">IParameterizedEventListener</span>
3245 <span class="p">{</span>
3246     <span class="sd">/**</span>
3247 <span class="sd">     * @inheritDoc</span>
3248 <span class="sd">     * @param ValueForm $eventObj</span>
3249 <span class="sd">     */</span>
3250     <span class="k">public</span> <span class="k">function</span> <span class="nf">execute</span><span class="p">(</span><span class="nv">$eventObj</span><span class="p">,</span> <span class="nv">$className</span><span class="p">,</span> <span class="nv">$eventName</span><span class="p">,</span> <span class="k">array</span> <span class="o">&amp;</span><span class="nv">$parameters</span><span class="p">)</span>
3251     <span class="p">{</span>
3252         <span class="nb">var_dump</span><span class="p">(</span><span class="nv">$parameters</span><span class="p">[</span><span class="s1">&#39;value&#39;</span><span class="p">]);</span>
3253     <span class="p">}</span>
3254 <span class="p">}</span>
3255 </code></pre></div></td></tr></table></div>
3256 <p>Now:</p>
3257 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nx">EventHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">fire</span><span class="p">(</span><span class="k">new</span> <span class="nx">ValueAvailable</span><span class="p">(</span><span class="nx">\random_int</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1024</span><span class="p">)));</span>
3258 </code></pre></div></td></tr></table></div>
3259 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">lib/system/foo/event/ValueAvailable.class.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3260 <span class="normal"> 2</span>
3261 <span class="normal"> 3</span>
3262 <span class="normal"> 4</span>
3263 <span class="normal"> 5</span>
3264 <span class="normal"> 6</span>
3265 <span class="normal"> 7</span>
3266 <span class="normal"> 8</span>
3267 <span class="normal"> 9</span>
3268 <span class="normal">10</span>
3269 <span class="normal">11</span>
3270 <span class="normal">12</span>
3271 <span class="normal">13</span>
3272 <span class="normal">14</span>
3273 <span class="normal">15</span>
3274 <span class="normal">16</span>
3275 <span class="normal">17</span>
3276 <span class="normal">18</span>
3277 <span class="normal">19</span>
3278 <span class="normal">20</span>
3279 <span class="normal">21</span>
3280 <span class="normal">22</span>
3281 <span class="normal">23</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3282
3283 <span class="k">namespace</span> <span class="nx">wcf\system\foo\event</span><span class="p">;</span>
3284
3285 <span class="k">use</span> <span class="nx">wcf\system\event\IEvent</span><span class="p">;</span>
3286
3287 <span class="k">final</span> <span class="k">class</span> <span class="nc">ValueAvailable</span> <span class="k">implements</span> <span class="nx">IEvent</span>
3288 <span class="p">{</span>
3289     <span class="sd">/**</span>
3290 <span class="sd">     * @var int</span>
3291 <span class="sd">     */</span>
3292     <span class="k">private</span> <span class="nv">$value</span><span class="p">;</span>
3293
3294     <span class="k">public</span> <span class="k">function</span> <span class="fm">__construct</span><span class="p">(</span><span class="nx">int</span> <span class="nv">$value</span><span class="p">)</span>
3295     <span class="p">{</span>
3296         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">value</span> <span class="o">=</span> <span class="nv">$value</span><span class="p">;</span>
3297     <span class="p">}</span>
3298
3299     <span class="k">public</span> <span class="k">function</span> <span class="nf">getValue</span><span class="p">()</span><span class="o">:</span> <span class="nx">int</span>
3300     <span class="p">{</span>
3301         <span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">value</span><span class="p">;</span>
3302     <span class="p">}</span>
3303 <span class="p">}</span>
3304 </code></pre></div></td></tr></table></div>
3305 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">lib/system/event/listener/ValueDumpListener.class.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3306 <span class="normal"> 2</span>
3307 <span class="normal"> 3</span>
3308 <span class="normal"> 4</span>
3309 <span class="normal"> 5</span>
3310 <span class="normal"> 6</span>
3311 <span class="normal"> 7</span>
3312 <span class="normal"> 8</span>
3313 <span class="normal"> 9</span>
3314 <span class="normal">10</span>
3315 <span class="normal">11</span>
3316 <span class="normal">12</span>
3317 <span class="normal">13</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3318
3319 <span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span>
3320
3321 <span class="k">use</span> <span class="nx">wcf\system\foo\event\ValueAvailable</span><span class="p">;</span>
3322
3323 <span class="k">final</span> <span class="k">class</span> <span class="nc">ValueDumpListener</span>
3324 <span class="p">{</span>
3325     <span class="k">public</span> <span class="k">function</span> <span class="fm">__invoke</span><span class="p">(</span><span class="nx">ValueAvailable</span> <span class="nv">$event</span><span class="p">)</span><span class="o">:</span> <span class="nx">void</span>
3326     <span class="p">{</span>
3327         <span class="nx">\var_dump</span><span class="p">(</span><span class="nv">$event</span><span class="o">-&gt;</span><span class="na">getValue</span><span class="p">());</span>
3328     <span class="p">}</span>
3329 <span class="p">}</span>
3330 </code></pre></div></td></tr></table></div>
3331 <p>See <a href="https://github.com/WoltLab/WCF/pull/4000">WoltLab/WCF#4000</a> and <a href="https://github.com/WoltLab/WCF/pull/4265">WoltLab/WCF#4265</a> for details.</p>
3332 <h2 id="authentication">Authentication<a class="headerlink" href="#authentication" title="Permanent link">#</a></h2>
3333 <p>The <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/user/authentication/event/UserLoggedIn.class.php"><code>UserLoggedIn</code></a> event was added.
3334 You should fire this event if you implement a custom login process (e.g. when adding additional external authentication providers).</p>
3335 <p>Example:</p>
3336 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3337 <span class="normal">2</span>
3338 <span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nx">EventHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">fire</span><span class="p">(</span>
3339     <span class="k">new</span> <span class="nx">UserLoggedIn</span><span class="p">(</span><span class="nv">$user</span><span class="p">)</span>
3340 <span class="p">);</span>
3341 </code></pre></div></td></tr></table></div>
3342 <p>See <a href="https://github.com/WoltLab/WCF/pull/4356">WoltLab/WCF#4356</a> for details.</p>
3343 <h2 id="embedded-objects-in-comments">Embedded Objects in Comments<a class="headerlink" href="#embedded-objects-in-comments" title="Permanent link">#</a></h2>
3344 <p><a href="https://github.com/WoltLab/WCF/pull/4275">WoltLab/WCF#4275</a> added support for embedded objects like mentions for comments and comment responses.
3345 To properly render embedded objects whenever you are using comments in your packages, you have to use <code>ViewableCommentList</code>/<code>ViewableCommentResponseList</code> in these places or <code>ViewableCommentRuntimeCache</code>/<code>ViewableCommentResponseRuntimeCache</code>.
3346 While these runtime caches are only available since version 5.5, the viewable list classes have always been available so that changing <code>CommentList</code> to <code>ViewableCommentList</code>, for example, is a backwards-compatible change.</p>
3347 <h2 id="emails">Emails<a class="headerlink" href="#emails" title="Permanent link">#</a></h2>
3348 <h3 id="mailbox">Mailbox<a class="headerlink" href="#mailbox" title="Permanent link">#</a></h3>
3349 <p>The <code>Mailbox</code> and <code>UserMailbox</code> classes no longer store the passed <code>Language</code> and <code>User</code> objects, but the respective ID instead.
3350 This change reduces the size of the serialized email when stored in the background queue.</p>
3351 <p>If you inherit from the <code>Mailbox</code> or <code>UserMailbox</code> classes, you might experience issues if you directly access the <code>$this-&gt;language</code> or <code>$this-&gt;user</code> properties.
3352 Adjust your class to use composition instead of inheritance if possible.
3353 Use the <code>getLanguage()</code> or <code>getUser()</code> getters if using composition is not possible.</p>
3354 <p>See <a href="https://github.com/WoltLab/WCF/pull/4389">WoltLab/WCF#4389</a> for details.</p>
3355 <h3 id="smtp">SMTP<a class="headerlink" href="#smtp" title="Permanent link">#</a></h3>
3356 <p>The <code>SmtpEmailTransport</code> no longer supports a value of <code>may</code> for the <code>$starttls</code> property.</p>
3357 <p>Using the <code>may</code> value is unsafe as it allows for undetected MITM attacks.
3358 The use of <code>encrypt</code> is recommended, unless it is certain that the SMTP server does not support TLS.</p>
3359 <p>See <a href="https://github.com/WoltLab/WCF/pull/4398">WoltLab/WCF#4398</a> for details.</p>
3360 <h2 id="search">Search<a class="headerlink" href="#search" title="Permanent link">#</a></h2>
3361 <h3 id="search-form">Search Form<a class="headerlink" href="#search-form" title="Permanent link">#</a></h3>
3362 <p>After the overhaul of the search form, search providers are no longer bound to <code>SearchForm</code> and <code>SearchResultPage</code>.
3363 The interface <code>ISearchObjectType</code> and the abstract implementation <code>AbstractSearchableObjectType</code> have been replaced by <code>ISearchProvider</code> and <code>AbstractSearchProvider</code>.</p>
3364 <p>Please use <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/search/ArticleSearch.class.php"><code>ArticleSearch</code></a> as a template for your own implementation</p>
3365 <p>See <a href="https://github.com/WoltLab/WCF/pull/4605">WoltLab/WCF#4605</a> for details.</p>
3366 <h3 id="exceptions">Exceptions<a class="headerlink" href="#exceptions" title="Permanent link">#</a></h3>
3367 <p>A new <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/search/exception/SearchFailed.class.php"><code>wcf\system\search\exception\SearchFailed</code></a> exception was added.
3368 This exception should be thrown when executing the search query fails for (mostly) temporary reasons, such as a network partition to a remote service.
3369 It is not meant as a blanket exception to wrap everything.
3370 For example it must not be returned obvious programming errors, such as an access to an undefined variable (<code>ErrorException</code>).</p>
3371 <p>Catching the <code>SearchFailed</code> exception allows consuming code to gracefully handle search requests that are not essential for proceeding, without silencing other types of error.</p>
3372 <p>See <a href="https://github.com/WoltLab/WCF/issues/4476">WoltLab/WCF#4476</a> and <a href="https://github.com/WoltLab/WCF/pull/4483">WoltLab/WCF#4483</a> for details.</p>
3373 <h2 id="package-installation-plugins">Package Installation Plugins<a class="headerlink" href="#package-installation-plugins" title="Permanent link">#</a></h2>
3374 <h3 id="database">Database<a class="headerlink" href="#database" title="Permanent link">#</a></h3>
3375 <p>WoltLab Suite 5.5 changes the factory classes for common configurations of database columns within the PHP-based DDL API to contain a private constructor, preventing object creation.</p>
3376 <p>This change affects the following classes:</p>
3377 <ul>
3378 <li><code>DefaultFalseBooleanDatabaseTableColumn</code></li>
3379 <li><code>DefaultTrueBooleanDatabaseTableColumn</code></li>
3380 <li><code>NotNullInt10DatabaseTableColumn</code></li>
3381 <li><code>NotNullVarchar191DatabaseTableColumn</code></li>
3382 <li><code>NotNullVarchar255DatabaseTableColumn</code></li>
3383 <li>
3384 <p><code>ObjectIdDatabaseTableColumn</code></p>
3385 </li>
3386 <li>
3387 <p><code>DatabaseTablePrimaryIndex</code></p>
3388 </li>
3389 </ul>
3390 <p>The static <code>create()</code> method never returned an object of the factory class, but instead in object of the base type (e.g. <code>IntDatabaseTableColumn</code> for <code>NotNullInt10DatabaseTableColumn</code>).
3391 Constructing an object of these factory classes is considered a bug, as the class name implies a specific column configuration, that might or might not hold if the object is modified afterwards.</p>
3392 <p>See <a href="https://github.com/WoltLab/WCF/pull/4564">WoltLab/WCF#4564</a> for details.</p>
3393 <p>WoltLab Suite 5.5 adds the <code>IDefaultValueDatabaseTableColumn</code> interface which is used to check whether specifying a default value is legal.
3394 For backwards compatibility this interface is implemented by <code>AbstractDatabaseTableColumn</code>.
3395 You should explicitly add this interface to custom table column type classes to avoid breakage if the interface is removed from <code>AbstractDatabaseTableColumn</code> in a future version.
3396 Likewise you should explicitly check for the interface before attempting to access the methods related to the default value of a column.</p>
3397 <p>See <a href="https://github.com/WoltLab/WCF/pull/4733">WoltLab/WCF#4733</a> for details.</p>
3398 <h3 id="file-deletion">File Deletion<a class="headerlink" href="#file-deletion" title="Permanent link">#</a></h3>
3399 <p>Three new package installation plugins have been added to delete ACP templates with <a href="../../../package/pip/acp-template-delete/">acpTemplateDelete</a>, files with <a href="../../../package/pip/file-delete/">fileDelete</a>, and templates with <a href="../../../package/pip/template-delete/">templateDelete</a>.</p>
3400 <h3 id="language">Language<a class="headerlink" href="#language" title="Permanent link">#</a></h3>
3401 <p><a href="https://github.com/WoltLab/WCF/pull/4261">WoltLab/WCF#4261</a> has added support for deleting existing phrases with the <code>language</code> package installation plugin.</p>
3402 <p>The current structure of the language XML files</p>
3403 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">language/en.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/migration/wsc54/en_old.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3404 <span class="normal">2</span>
3405 <span class="normal">3</span>
3406 <span class="normal">4</span>
3407 <span class="normal">5</span>
3408 <span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
3409 <span class="nt">&lt;language</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/5.4/language.xsd&quot;</span><span class="w"> </span><span class="na">languagecode=</span><span class="s">&quot;en&quot;</span><span class="w"> </span><span class="na">languagename=</span><span class="s">&quot;English&quot;</span><span class="w"> </span><span class="na">countrycode=</span><span class="s">&quot;gb&quot;</span><span class="nt">&gt;</span>
3410 <span class="w">    </span><span class="nt">&lt;category</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;wcf.foo&quot;</span><span class="nt">&gt;</span>
3411 <span class="w">        </span><span class="nt">&lt;item</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;wcf.foo.bar&quot;</span><span class="nt">&gt;</span><span class="cp">&lt;![CDATA[Bar]]&gt;</span><span class="nt">&lt;/item&gt;</span>
3412 <span class="w">    </span><span class="nt">&lt;/category&gt;</span>
3413 <span class="nt">&lt;/language&gt;</span>
3414 </code></pre></div></td></tr></table></div>
3415 <p>is deprecated and should be replaced with the new structure with an explicit <code>&lt;import&gt;</code> element like in the other package installation plugins:</p>
3416 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">language/en.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/migration/wsc54/en_new.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3417 <span class="normal">2</span>
3418 <span class="normal">3</span>
3419 <span class="normal">4</span>
3420 <span class="normal">5</span>
3421 <span class="normal">6</span>
3422 <span class="normal">7</span>
3423 <span class="normal">8</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
3424 <span class="nt">&lt;language</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/5.4/language.xsd&quot;</span><span class="w"> </span><span class="na">languagecode=</span><span class="s">&quot;en&quot;</span><span class="w"> </span><span class="na">languagename=</span><span class="s">&quot;English&quot;</span><span class="w"> </span><span class="na">countrycode=</span><span class="s">&quot;gb&quot;</span><span class="nt">&gt;</span>
3425 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
3426 <span class="w">        </span><span class="nt">&lt;category</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;wcf.foo&quot;</span><span class="nt">&gt;</span>
3427 <span class="w">            </span><span class="nt">&lt;item</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;wcf.foo.bar&quot;</span><span class="nt">&gt;</span><span class="cp">&lt;![CDATA[Bar]]&gt;</span><span class="nt">&lt;/item&gt;</span>
3428 <span class="w">        </span><span class="nt">&lt;/category&gt;</span>
3429 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
3430 <span class="nt">&lt;/language&gt;</span>
3431 </code></pre></div></td></tr></table></div>
3432 <p>Additionally, to now also support deleting phrases with this package installation plugin, support for a <code>&lt;delete&gt;</code> element has been added:</p>
3433 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">language/en.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/migration/wsc54/en_new_with_delete.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3434 <span class="normal"> 2</span>
3435 <span class="normal"> 3</span>
3436 <span class="normal"> 4</span>
3437 <span class="normal"> 5</span>
3438 <span class="normal"> 6</span>
3439 <span class="normal"> 7</span>
3440 <span class="normal"> 8</span>
3441 <span class="normal"> 9</span>
3442 <span class="normal">10</span>
3443 <span class="normal">11</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
3444 <span class="nt">&lt;language</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/5.4/language.xsd&quot;</span><span class="w"> </span><span class="na">languagecode=</span><span class="s">&quot;en&quot;</span><span class="w"> </span><span class="na">languagename=</span><span class="s">&quot;English&quot;</span><span class="w"> </span><span class="na">countrycode=</span><span class="s">&quot;gb&quot;</span><span class="nt">&gt;</span>
3445 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
3446 <span class="w">        </span><span class="nt">&lt;category</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;wcf.foo&quot;</span><span class="nt">&gt;</span>
3447 <span class="w">            </span><span class="nt">&lt;item</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;wcf.foo.bar&quot;</span><span class="nt">&gt;</span><span class="cp">&lt;![CDATA[Bar]]&gt;</span><span class="nt">&lt;/item&gt;</span>
3448 <span class="w">        </span><span class="nt">&lt;/category&gt;</span>
3449 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
3450 <span class="w">    </span><span class="nt">&lt;delete&gt;</span>
3451 <span class="w">        </span><span class="nt">&lt;item</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;wcf.foo.barrr&quot;</span><span class="nt">/&gt;</span>
3452 <span class="w">    </span><span class="nt">&lt;/delete&gt;</span>
3453 <span class="nt">&lt;/language&gt;</span>
3454 </code></pre></div></td></tr></table></div>
3455 <p>Note that when deleting phrases, the category does not have to be specified because phrase identifiers are unique globally.</p>
3456 <div class="admonition warning">
3457 <p class="admonition-title">Mixing the old structure and the new structure is not supported and will result in an error message during the import!</p>
3458 </div>
3459 <h2 id="board-and-thread-subscriptions">Board and Thread Subscriptions<a class="headerlink" href="#board-and-thread-subscriptions" title="Permanent link">#</a></h2>
3460 <p>WoltLab Suite Forum 5.5 updates the subscription logic for boards and threads to properly support the ignoring of threads.
3461 See the <a href="../forum_subscriptions/">dedicated migration guide</a> for details.</p>
3462 <h2 id="miscellaneous-changes">Miscellaneous Changes<a class="headerlink" href="#miscellaneous-changes" title="Permanent link">#</a></h2>
3463 <h3 id="view-counters">View Counters<a class="headerlink" href="#view-counters" title="Permanent link">#</a></h3>
3464 <p>With WoltLab Suite 5.5 it is expected that view/download counters do not increase for disabled content.</p>
3465 <p>See <a href="https://github.com/WoltLab/WCF/pull/4374">WoltLab/WCF#4374</a> for details.</p>
3466 <h3 id="form-builder">Form Builder<a class="headerlink" href="#form-builder" title="Permanent link">#</a></h3>
3467 <ul>
3468 <li><a href="../../../php/api/form_builder/dependencies/#valueintervalformfielddependency"><code>ValueIntervalFormFieldDependency</code></a></li>
3469 <li><a href="../../../php/api/form_builder/form_fields/#colorformfield"><code>ColorFormField</code></a></li>
3470 <li><a href="../../../php/api/form_builder/form_fields/#multipleboardselectionformfield"><code>MultipleBoardSelectionFormField</code></a></li>
3471 </ul>
3472
3473   <hr>
3474 <div class="md-source-file">
3475   <small>
3476
3477       Last update:
3478       2022-10-28
3479
3480   </small>
3481 </div>
3482
3483
3484
3485
3486
3487
3488               </article>
3489             </div>
3490
3491
3492         </div>
3493
3494       </main>
3495
3496         <footer class="md-footer">
3497
3498   <div class="md-footer-meta md-typeset">
3499     <div class="md-footer-meta__inner md-grid">
3500       <div class="md-copyright">
3501
3502     <div class="md-copyright__highlight">
3503       Copyright © 2020 WoltLab GmbH
3504     </div>
3505
3506
3507     Made with
3508     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3509       Material for MkDocs
3510     </a>
3511
3512 </div>
3513
3514         <div class="md-copyright">
3515         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
3516         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
3517 </div>
3518
3519     </div>
3520   </div>
3521 </footer>
3522
3523     </div>
3524     <div class="md-dialog" data-md-component="dialog">
3525       <div class="md-dialog__inner md-typeset"></div>
3526     </div>
3527
3528     <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
3529
3530
3531       <script src="../../../assets/javascripts/bundle.b4d07000.min.js"></script>
3532
3533
3534   </body>
3535 </html>