5.4/migration/wsc52/php/index.html

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