latest/migration/wsc53/php/index.html

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