5.4/migration/wsc30/php/index.html

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