latest/migration/wcf21/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="#wcf-21x-php" class="md-skip">
  64           Skip to content
  65         </a>
  66
  67     </div>
  68     <div data-md-component="announce">
  69
  70         <aside class="md-announce">
  71           <div class="md-announce__inner md-grid md-typeset">
  72
  73     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  74
  75           </div>
  76         </aside>
  77
  78     </div>
  79
  80       <header class="md-header" data-md-component="header">
  81   <nav class="md-header__inner md-grid" aria-label="Header">
  82     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  83
  84   <img src="../../../assets/logo.png" alt="logo">
  85
  86     </a>
  87     <label class="md-header__button md-icon" for="__drawer">
  88       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  89     </label>
  90     <div class="md-header__title" data-md-component="header-title">
  91       <div class="md-header__ellipsis">
  92         <div class="md-header__topic">
  93           <span class="md-ellipsis">
  94             WoltLab Suite Documentation
  95           </span>
  96         </div>
  97         <div class="md-header__topic" data-md-component="header-topic">
  98           <span class="md-ellipsis">
  99
 100               PHP API
 101
 102           </span>
 103         </div>
 104       </div>
 105     </div>
 106
 107
 108
 109       <label class="md-header__button md-icon" for="__search">
 110         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 111       </label>
 112
 113 <div class="md-search" data-md-component="search" role="dialog">
 114   <label class="md-search__overlay" for="__search"></label>
 115   <div class="md-search__inner" role="search">
 116     <form class="md-search__form" name="search">
 117       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
 118       <label class="md-search__icon md-icon" for="__search">
 119         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
 120         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
 121       </label>
 122       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 123         <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
 124       </button>
 125     </form>
 126     <div class="md-search__output">
 127       <div class="md-search__scrollwrap" data-md-scrollfix>
 128         <div class="md-search-result" data-md-component="search-result">
 129           <div class="md-search-result__meta">
 130             Initializing search
 131           </div>
 132           <ol class="md-search-result__list"></ol>
 133         </div>
 134       </div>
 135     </div>
 136   </div>
 137 </div>
 138
 139
 140       <div class="md-header__source">
 141
 142 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 143   <div class="md-source__icon md-icon">
 144
 145     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 146   </div>
 147   <div class="md-source__repository">
 148     GitHub
 149   </div>
 150 </a>
 151       </div>
 152
 153   </nav>
 154 </header>
 155
 156     <div class="md-container" data-md-component="container">
 157
 158
 159
 160
 161       <main class="md-main" data-md-component="main">
 162         <div class="md-main__inner md-grid">
 163
 164
 165
 166               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 167                 <div class="md-sidebar__scrollwrap">
 168                   <div class="md-sidebar__inner">
 169
 170
 171
 172 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 173   <label class="md-nav__title" for="__drawer">
 174     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 175
 176   <img src="../../../assets/logo.png" alt="logo">
 177
 178     </a>
 179     WoltLab Suite Documentation
 180   </label>
 181
 182     <div class="md-nav__source">
 183
 184 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 185   <div class="md-source__icon md-icon">
 186
 187     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 188   </div>
 189   <div class="md-source__repository">
 190     GitHub
 191   </div>
 192 </a>
 193     </div>
 194
 195   <ul class="md-nav__list" data-md-scrollfix>
 196
 197
 198
 199
 200
 201
 202
 203
 204     <li class="md-nav__item">
 205       <a href="../../../getting-started/" class="md-nav__link">
 206         Getting Started
 207       </a>
 208     </li>
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220     <li class="md-nav__item md-nav__item--nested">
 221
 222
 223         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 224
 225       <label class="md-nav__link" for="__nav_2">
 226         PHP API
 227         <span class="md-nav__icon md-icon"></span>
 228       </label>
 229       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 230         <label class="md-nav__title" for="__nav_2">
 231           <span class="md-nav__icon md-icon"></span>
 232           PHP API
 233         </label>
 234         <ul class="md-nav__list" data-md-scrollfix>
 235
 236
 237
 238
 239
 240     <li class="md-nav__item">
 241       <a href="../../../php/pages/" class="md-nav__link">
 242         Pages
 243       </a>
 244     </li>
 245
 246
 247
 248
 249
 250
 251
 252     <li class="md-nav__item">
 253       <a href="../../../php/database-objects/" class="md-nav__link">
 254         Database Objects
 255       </a>
 256     </li>
 257
 258
 259
 260
 261
 262
 263
 264     <li class="md-nav__item">
 265       <a href="../../../php/database-access/" class="md-nav__link">
 266         Database Access
 267       </a>
 268     </li>
 269
 270
 271
 272
 273
 274
 275
 276     <li class="md-nav__item">
 277       <a href="../../../php/exceptions/" class="md-nav__link">
 278         Exceptions
 279       </a>
 280     </li>
 281
 282
 283
 284
 285
 286
 287
 288
 289     <li class="md-nav__item md-nav__item--nested">
 290
 291
 292         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 293
 294       <label class="md-nav__link" for="__nav_2_5">
 295         API
 296         <span class="md-nav__icon md-icon"></span>
 297       </label>
 298       <nav class="md-nav" aria-label="API" data-md-level="2">
 299         <label class="md-nav__title" for="__nav_2_5">
 300           <span class="md-nav__icon md-icon"></span>
 301           API
 302         </label>
 303         <ul class="md-nav__list" data-md-scrollfix>
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item md-nav__item--nested">
 311
 312
 313         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
 314
 315       <label class="md-nav__link" for="__nav_2_5_1">
 316         Caches
 317         <span class="md-nav__icon md-icon"></span>
 318       </label>
 319       <nav class="md-nav" aria-label="Caches" data-md-level="3">
 320         <label class="md-nav__title" for="__nav_2_5_1">
 321           <span class="md-nav__icon md-icon"></span>
 322           Caches
 323         </label>
 324         <ul class="md-nav__list" data-md-scrollfix>
 325
 326
 327
 328
 329
 330     <li class="md-nav__item">
 331       <a href="../../../php/api/caches/" class="md-nav__link">
 332         Overview
 333       </a>
 334     </li>
 335
 336
 337
 338
 339
 340
 341
 342     <li class="md-nav__item">
 343       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 344         Persistent Caches
 345       </a>
 346     </li>
 347
 348
 349
 350
 351
 352
 353
 354     <li class="md-nav__item">
 355       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 356         Runtime Caches
 357       </a>
 358     </li>
 359
 360
 361
 362         </ul>
 363       </nav>
 364     </li>
 365
 366
 367
 368
 369
 370
 371
 372     <li class="md-nav__item">
 373       <a href="../../../php/api/comments/" class="md-nav__link">
 374         Comments
 375       </a>
 376     </li>
 377
 378
 379
 380
 381
 382
 383
 384     <li class="md-nav__item">
 385       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 386         Cronjobs
 387       </a>
 388     </li>
 389
 390
 391
 392
 393
 394
 395
 396     <li class="md-nav__item">
 397       <a href="../../../php/api/events/" class="md-nav__link">
 398         Events
 399       </a>
 400     </li>
 401
 402
 403
 404
 405
 406
 407
 408
 409     <li class="md-nav__item md-nav__item--nested">
 410
 411
 412         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 413
 414       <label class="md-nav__link" for="__nav_2_5_5">
 415         Form Builder
 416         <span class="md-nav__icon md-icon"></span>
 417       </label>
 418       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 419         <label class="md-nav__title" for="__nav_2_5_5">
 420           <span class="md-nav__icon md-icon"></span>
 421           Form Builder
 422         </label>
 423         <ul class="md-nav__list" data-md-scrollfix>
 424
 425
 426
 427
 428
 429     <li class="md-nav__item">
 430       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 431         Overview
 432       </a>
 433     </li>
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 443         Structure
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item">
 454       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 455         Fields
 456       </a>
 457     </li>
 458
 459
 460
 461
 462
 463
 464
 465     <li class="md-nav__item">
 466       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 467         Validation and Data
 468       </a>
 469     </li>
 470
 471
 472
 473
 474
 475
 476
 477     <li class="md-nav__item">
 478       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 479         Dependencies
 480       </a>
 481     </li>
 482
 483
 484
 485         </ul>
 486       </nav>
 487     </li>
 488
 489
 490
 491
 492
 493
 494
 495     <li class="md-nav__item">
 496       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 497         Package Installation Plugins
 498       </a>
 499     </li>
 500
 501
 502
 503
 504
 505
 506
 507     <li class="md-nav__item">
 508       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 509         User Activity Points
 510       </a>
 511     </li>
 512
 513
 514
 515
 516
 517
 518
 519     <li class="md-nav__item">
 520       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 521         User Notifications
 522       </a>
 523     </li>
 524
 525
 526
 527
 528
 529
 530
 531     <li class="md-nav__item">
 532       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 533         Sitemaps
 534       </a>
 535     </li>
 536
 537
 538
 539         </ul>
 540       </nav>
 541     </li>
 542
 543
 544
 545
 546
 547
 548
 549     <li class="md-nav__item">
 550       <a href="../../../php/code-style/" class="md-nav__link">
 551         Code Style
 552       </a>
 553     </li>
 554
 555
 556
 557
 558
 559
 560
 561     <li class="md-nav__item">
 562       <a href="../../../php/apps/" class="md-nav__link">
 563         Apps
 564       </a>
 565     </li>
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../../php/gdpr/" class="md-nav__link">
 575         GDPR
 576       </a>
 577     </li>
 578
 579
 580
 581         </ul>
 582       </nav>
 583     </li>
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595     <li class="md-nav__item md-nav__item--nested">
 596
 597
 598         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 599
 600       <label class="md-nav__link" for="__nav_3">
 601         Languages, Templates & CSS
 602         <span class="md-nav__icon md-icon"></span>
 603       </label>
 604       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 605         <label class="md-nav__title" for="__nav_3">
 606           <span class="md-nav__icon md-icon"></span>
 607           Languages, Templates & CSS
 608         </label>
 609         <ul class="md-nav__list" data-md-scrollfix>
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../../view/languages/" class="md-nav__link">
 617         Languages
 618       </a>
 619     </li>
 620
 621
 622
 623
 624
 625
 626
 627     <li class="md-nav__item">
 628       <a href="../../../view/templates/" class="md-nav__link">
 629         Templates
 630       </a>
 631     </li>
 632
 633
 634
 635
 636
 637
 638
 639     <li class="md-nav__item">
 640       <a href="../../../view/template-plugins/" class="md-nav__link">
 641         Template Plugins
 642       </a>
 643     </li>
 644
 645
 646
 647
 648
 649
 650
 651     <li class="md-nav__item">
 652       <a href="../../../view/css/" class="md-nav__link">
 653         CSS
 654       </a>
 655     </li>
 656
 657
 658
 659         </ul>
 660       </nav>
 661     </li>
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673     <li class="md-nav__item md-nav__item--nested">
 674
 675
 676         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 677
 678       <label class="md-nav__link" for="__nav_4">
 679         TypeScript and JavaScript API
 680         <span class="md-nav__icon md-icon"></span>
 681       </label>
 682       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 683         <label class="md-nav__title" for="__nav_4">
 684           <span class="md-nav__icon md-icon"></span>
 685           TypeScript and JavaScript API
 686         </label>
 687         <ul class="md-nav__list" data-md-scrollfix>
 688
 689
 690
 691
 692
 693     <li class="md-nav__item">
 694       <a href="../../../javascript/general-usage/" class="md-nav__link">
 695         General Usage
 696       </a>
 697     </li>
 698
 699
 700
 701
 702
 703
 704
 705     <li class="md-nav__item">
 706       <a href="../../../javascript/typescript/" class="md-nav__link">
 707         TypeScript
 708       </a>
 709     </li>
 710
 711
 712
 713
 714
 715
 716
 717
 718     <li class="md-nav__item md-nav__item--nested">
 719
 720
 721         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 722
 723       <label class="md-nav__link" for="__nav_4_3">
 724         New API
 725         <span class="md-nav__icon md-icon"></span>
 726       </label>
 727       <nav class="md-nav" aria-label="New API" data-md-level="2">
 728         <label class="md-nav__title" for="__nav_4_3">
 729           <span class="md-nav__icon md-icon"></span>
 730           New API
 731         </label>
 732         <ul class="md-nav__list" data-md-scrollfix>
 733
 734
 735
 736
 737
 738     <li class="md-nav__item">
 739       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 740         Writing a module
 741       </a>
 742     </li>
 743
 744
 745
 746
 747
 748
 749
 750     <li class="md-nav__item">
 751       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 752         Data Structures
 753       </a>
 754     </li>
 755
 756
 757
 758
 759
 760
 761
 762     <li class="md-nav__item">
 763       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 764         Core Functions
 765       </a>
 766     </li>
 767
 768
 769
 770
 771
 772
 773
 774     <li class="md-nav__item">
 775       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 776         DOM
 777       </a>
 778     </li>
 779
 780
 781
 782
 783
 784
 785
 786     <li class="md-nav__item">
 787       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 788         Event Handling
 789       </a>
 790     </li>
 791
 792
 793
 794
 795
 796
 797
 798     <li class="md-nav__item">
 799       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 800         Ajax
 801       </a>
 802     </li>
 803
 804
 805
 806
 807
 808
 809
 810     <li class="md-nav__item">
 811       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 812         Dialogs
 813       </a>
 814     </li>
 815
 816
 817
 818
 819
 820
 821
 822     <li class="md-nav__item">
 823       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 824         Browser and Screen Sizes
 825       </a>
 826     </li>
 827
 828
 829
 830
 831
 832
 833
 834     <li class="md-nav__item">
 835       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 836         User Interface
 837       </a>
 838     </li>
 839
 840
 841
 842         </ul>
 843       </nav>
 844     </li>
 845
 846
 847
 848
 849
 850
 851
 852     <li class="md-nav__item">
 853       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 854         Legacy API
 855       </a>
 856     </li>
 857
 858
 859
 860
 861
 862
 863
 864     <li class="md-nav__item">
 865       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 866         Helper Functions
 867       </a>
 868     </li>
 869
 870
 871
 872
 873
 874
 875
 876     <li class="md-nav__item">
 877       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 878         Code Snippets
 879       </a>
 880     </li>
 881
 882
 883
 884         </ul>
 885       </nav>
 886     </li>
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898     <li class="md-nav__item md-nav__item--nested">
 899
 900
 901         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 902
 903       <label class="md-nav__link" for="__nav_5">
 904         Package Components
 905         <span class="md-nav__icon md-icon"></span>
 906       </label>
 907       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 908         <label class="md-nav__title" for="__nav_5">
 909           <span class="md-nav__icon md-icon"></span>
 910           Package Components
 911         </label>
 912         <ul class="md-nav__list" data-md-scrollfix>
 913
 914
 915
 916
 917
 918     <li class="md-nav__item">
 919       <a href="../../../package/package-xml/" class="md-nav__link">
 920         package.xml
 921       </a>
 922     </li>
 923
 924
 925
 926
 927
 928
 929
 930
 931     <li class="md-nav__item md-nav__item--nested">
 932
 933
 934         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
 935
 936       <label class="md-nav__link" for="__nav_5_2">
 937         PIPs
 938         <span class="md-nav__icon md-icon"></span>
 939       </label>
 940       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 941         <label class="md-nav__title" for="__nav_5_2">
 942           <span class="md-nav__icon md-icon"></span>
 943           PIPs
 944         </label>
 945         <ul class="md-nav__list" data-md-scrollfix>
 946
 947
 948
 949
 950
 951     <li class="md-nav__item">
 952       <a href="../../../package/pip/" class="md-nav__link">
 953         Overview
 954       </a>
 955     </li>
 956
 957
 958
 959
 960
 961
 962
 963     <li class="md-nav__item">
 964       <a href="../../../package/pip/acl-option/" class="md-nav__link">
 965         aclOption
 966       </a>
 967     </li>
 968
 969
 970
 971
 972
 973
 974
 975     <li class="md-nav__item">
 976       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
 977         acpMenu
 978       </a>
 979     </li>
 980
 981
 982
 983
 984
 985
 986
 987     <li class="md-nav__item">
 988       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
 989         acpSearchProvider
 990       </a>
 991     </li>
 992
 993
 994
 995
 996
 997
 998
 999     <li class="md-nav__item">
1000       <a href="../../../package/pip/acp-template/" class="md-nav__link">
1001         acpTemplate
1002       </a>
1003     </li>
1004
1005
1006
1007
1008
1009
1010
1011     <li class="md-nav__item">
1012       <a href="../../../package/pip/bbcode/" class="md-nav__link">
1013         bbcode
1014       </a>
1015     </li>
1016
1017
1018
1019
1020
1021
1022
1023     <li class="md-nav__item">
1024       <a href="../../../package/pip/box/" class="md-nav__link">
1025         box
1026       </a>
1027     </li>
1028
1029
1030
1031
1032
1033
1034
1035     <li class="md-nav__item">
1036       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1037         clipboardAction
1038       </a>
1039     </li>
1040
1041
1042
1043
1044
1045
1046
1047     <li class="md-nav__item">
1048       <a href="../../../package/pip/core-object/" class="md-nav__link">
1049         coreObject
1050       </a>
1051     </li>
1052
1053
1054
1055
1056
1057
1058
1059     <li class="md-nav__item">
1060       <a href="../../../package/pip/cronjob/" class="md-nav__link">
1061         cronjob
1062       </a>
1063     </li>
1064
1065
1066
1067
1068
1069
1070
1071     <li class="md-nav__item">
1072       <a href="../../../package/pip/database/" class="md-nav__link">
1073         database
1074       </a>
1075     </li>
1076
1077
1078
1079
1080
1081
1082
1083     <li class="md-nav__item">
1084       <a href="../../../package/pip/event-listener/" class="md-nav__link">
1085         eventListener
1086       </a>
1087     </li>
1088
1089
1090
1091
1092
1093
1094
1095     <li class="md-nav__item">
1096       <a href="../../../package/pip/file/" class="md-nav__link">
1097         file
1098       </a>
1099     </li>
1100
1101
1102
1103
1104
1105
1106
1107     <li class="md-nav__item">
1108       <a href="../../../package/pip/language/" class="md-nav__link">
1109         language
1110       </a>
1111     </li>
1112
1113
1114
1115
1116
1117
1118
1119     <li class="md-nav__item">
1120       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1121         mediaProvider
1122       </a>
1123     </li>
1124
1125
1126
1127
1128
1129
1130
1131     <li class="md-nav__item">
1132       <a href="../../../package/pip/menu/" class="md-nav__link">
1133         menu
1134       </a>
1135     </li>
1136
1137
1138
1139
1140
1141
1142
1143     <li class="md-nav__item">
1144       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1145         menuItem
1146       </a>
1147     </li>
1148
1149
1150
1151
1152
1153
1154
1155     <li class="md-nav__item">
1156       <a href="../../../package/pip/object-type/" class="md-nav__link">
1157         objectType
1158       </a>
1159     </li>
1160
1161
1162
1163
1164
1165
1166
1167     <li class="md-nav__item">
1168       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1169         objectTypeDefinition
1170       </a>
1171     </li>
1172
1173
1174
1175
1176
1177
1178
1179     <li class="md-nav__item">
1180       <a href="../../../package/pip/option/" class="md-nav__link">
1181         option
1182       </a>
1183     </li>
1184
1185
1186
1187
1188
1189
1190
1191     <li class="md-nav__item">
1192       <a href="../../../package/pip/page/" class="md-nav__link">
1193         page
1194       </a>
1195     </li>
1196
1197
1198
1199
1200
1201
1202
1203     <li class="md-nav__item">
1204       <a href="../../../package/pip/pip/" class="md-nav__link">
1205         pip
1206       </a>
1207     </li>
1208
1209
1210
1211
1212
1213
1214
1215     <li class="md-nav__item">
1216       <a href="../../../package/pip/script/" class="md-nav__link">
1217         script
1218       </a>
1219     </li>
1220
1221
1222
1223
1224
1225
1226
1227     <li class="md-nav__item">
1228       <a href="../../../package/pip/smiley/" class="md-nav__link">
1229         smiley
1230       </a>
1231     </li>
1232
1233
1234
1235
1236
1237
1238
1239     <li class="md-nav__item">
1240       <a href="../../../package/pip/sql/" class="md-nav__link">
1241         sql
1242       </a>
1243     </li>
1244
1245
1246
1247
1248
1249
1250
1251     <li class="md-nav__item">
1252       <a href="../../../package/pip/style/" class="md-nav__link">
1253         style
1254       </a>
1255     </li>
1256
1257
1258
1259
1260
1261
1262
1263     <li class="md-nav__item">
1264       <a href="../../../package/pip/template/" class="md-nav__link">
1265         template
1266       </a>
1267     </li>
1268
1269
1270
1271
1272
1273
1274
1275     <li class="md-nav__item">
1276       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1277         templateListener
1278       </a>
1279     </li>
1280
1281
1282
1283
1284
1285
1286
1287     <li class="md-nav__item">
1288       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1289         userGroupOption
1290       </a>
1291     </li>
1292
1293
1294
1295
1296
1297
1298
1299     <li class="md-nav__item">
1300       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1301         userMenu
1302       </a>
1303     </li>
1304
1305
1306
1307
1308
1309
1310
1311     <li class="md-nav__item">
1312       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1313         userNotificationEvent
1314       </a>
1315     </li>
1316
1317
1318
1319
1320
1321
1322
1323     <li class="md-nav__item">
1324       <a href="../../../package/pip/user-option/" class="md-nav__link">
1325         userOption
1326       </a>
1327     </li>
1328
1329
1330
1331
1332
1333
1334
1335     <li class="md-nav__item">
1336       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1337         userProfileMenu
1338       </a>
1339     </li>
1340
1341
1342
1343         </ul>
1344       </nav>
1345     </li>
1346
1347
1348
1349
1350
1351
1352
1353     <li class="md-nav__item">
1354       <a href="../../../package/database-php-api/" class="md-nav__link">
1355         Database PHP API
1356       </a>
1357     </li>
1358
1359
1360
1361         </ul>
1362       </nav>
1363     </li>
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1378
1379
1380         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
1381
1382       <label class="md-nav__link" for="__nav_6">
1383         Migration
1384         <span class="md-nav__icon md-icon"></span>
1385       </label>
1386       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1387         <label class="md-nav__title" for="__nav_6">
1388           <span class="md-nav__icon md-icon"></span>
1389           Migration
1390         </label>
1391         <ul class="md-nav__list" data-md-scrollfix>
1392
1393
1394
1395
1396
1397
1398     <li class="md-nav__item md-nav__item--nested">
1399
1400
1401         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1402
1403       <label class="md-nav__link" for="__nav_6_1">
1404         Migrating from WSC 5.3
1405         <span class="md-nav__icon md-icon"></span>
1406       </label>
1407       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1408         <label class="md-nav__title" for="__nav_6_1">
1409           <span class="md-nav__icon md-icon"></span>
1410           Migrating from WSC 5.3
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="../../wsc53/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="../../wsc53/session/" class="md-nav__link">
1432         Session Handling and Authentication
1433       </a>
1434     </li>
1435
1436
1437
1438
1439
1440
1441
1442     <li class="md-nav__item">
1443       <a href="../../wsc53/javascript/" class="md-nav__link">
1444         TypeScript and JavaScript
1445       </a>
1446     </li>
1447
1448
1449
1450
1451
1452
1453
1454     <li class="md-nav__item">
1455       <a href="../../wsc53/templates/" class="md-nav__link">
1456         Templates
1457       </a>
1458     </li>
1459
1460
1461
1462
1463
1464
1465
1466     <li class="md-nav__item">
1467       <a href="../../wsc53/libraries/" class="md-nav__link">
1468         Third Party Libraries
1469       </a>
1470     </li>
1471
1472
1473
1474         </ul>
1475       </nav>
1476     </li>
1477
1478
1479
1480
1481
1482
1483
1484
1485     <li class="md-nav__item md-nav__item--nested">
1486
1487
1488         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1489
1490       <label class="md-nav__link" for="__nav_6_2">
1491         Migrating from WSC 5.2
1492         <span class="md-nav__icon md-icon"></span>
1493       </label>
1494       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1495         <label class="md-nav__title" for="__nav_6_2">
1496           <span class="md-nav__icon md-icon"></span>
1497           Migrating from WSC 5.2
1498         </label>
1499         <ul class="md-nav__list" data-md-scrollfix>
1500
1501
1502
1503
1504
1505     <li class="md-nav__item">
1506       <a href="../../wsc52/php/" class="md-nav__link">
1507         PHP API
1508       </a>
1509     </li>
1510
1511
1512
1513
1514
1515
1516
1517     <li class="md-nav__item">
1518       <a href="../../wsc52/templates/" class="md-nav__link">
1519         Templates and Languages
1520       </a>
1521     </li>
1522
1523
1524
1525
1526
1527
1528
1529     <li class="md-nav__item">
1530       <a href="../../wsc52/libraries/" class="md-nav__link">
1531         Third Party Libraries
1532       </a>
1533     </li>
1534
1535
1536
1537         </ul>
1538       </nav>
1539     </li>
1540
1541
1542
1543
1544
1545
1546
1547
1548     <li class="md-nav__item md-nav__item--nested">
1549
1550
1551         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1552
1553       <label class="md-nav__link" for="__nav_6_3">
1554         Migrating from WSC 3.1
1555         <span class="md-nav__icon md-icon"></span>
1556       </label>
1557       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1558         <label class="md-nav__title" for="__nav_6_3">
1559           <span class="md-nav__icon md-icon"></span>
1560           Migrating from WSC 3.1
1561         </label>
1562         <ul class="md-nav__list" data-md-scrollfix>
1563
1564
1565
1566
1567
1568     <li class="md-nav__item">
1569       <a href="../../wsc31/php/" class="md-nav__link">
1570         PHP API
1571       </a>
1572     </li>
1573
1574
1575
1576         </ul>
1577       </nav>
1578     </li>
1579
1580
1581
1582
1583
1584
1585
1586
1587     <li class="md-nav__item md-nav__item--nested">
1588
1589
1590         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1591
1592       <label class="md-nav__link" for="__nav_6_4">
1593         Migrating from WSC 3.0
1594         <span class="md-nav__icon md-icon"></span>
1595       </label>
1596       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1597         <label class="md-nav__title" for="__nav_6_4">
1598           <span class="md-nav__icon md-icon"></span>
1599           Migrating from WSC 3.0
1600         </label>
1601         <ul class="md-nav__list" data-md-scrollfix>
1602
1603
1604
1605
1606
1607     <li class="md-nav__item">
1608       <a href="../../wsc30/php/" class="md-nav__link">
1609         PHP API
1610       </a>
1611     </li>
1612
1613
1614
1615
1616
1617
1618
1619     <li class="md-nav__item">
1620       <a href="../../wsc30/javascript/" class="md-nav__link">
1621         JavaScript API
1622       </a>
1623     </li>
1624
1625
1626
1627
1628
1629
1630
1631     <li class="md-nav__item">
1632       <a href="../../wsc30/templates/" class="md-nav__link">
1633         Templates
1634       </a>
1635     </li>
1636
1637
1638
1639
1640
1641
1642
1643     <li class="md-nav__item">
1644       <a href="../../wsc30/css/" class="md-nav__link">
1645         CSS
1646       </a>
1647     </li>
1648
1649
1650
1651
1652
1653
1654
1655     <li class="md-nav__item">
1656       <a href="../../wsc30/package/" class="md-nav__link">
1657         Package Components
1658       </a>
1659     </li>
1660
1661
1662
1663         </ul>
1664       </nav>
1665     </li>
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1677
1678
1679         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" checked>
1680
1681       <label class="md-nav__link" for="__nav_6_5">
1682         Migrating from WCF 2.1
1683         <span class="md-nav__icon md-icon"></span>
1684       </label>
1685       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1686         <label class="md-nav__title" for="__nav_6_5">
1687           <span class="md-nav__icon md-icon"></span>
1688           Migrating from WCF 2.1
1689         </label>
1690         <ul class="md-nav__list" data-md-scrollfix>
1691
1692
1693
1694
1695
1696
1697
1698     <li class="md-nav__item md-nav__item--active">
1699
1700       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1701
1702
1703
1704
1705         <label class="md-nav__link md-nav__link--active" for="__toc">
1706           PHP API
1707           <span class="md-nav__icon md-icon"></span>
1708         </label>
1709
1710       <a href="./" class="md-nav__link md-nav__link--active">
1711         PHP API
1712       </a>
1713
1714
1715 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1716
1717
1718
1719
1720
1721     <label class="md-nav__title" for="__toc">
1722       <span class="md-nav__icon md-icon"></span>
1723       Table of contents
1724     </label>
1725     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1726
1727         <li class="md-nav__item">
1728   <a href="#message-processing" class="md-nav__link">
1729     Message Processing
1730   </a>
1731
1732     <nav class="md-nav" aria-label="Message Processing">
1733       <ul class="md-nav__list">
1734
1735           <li class="md-nav__item">
1736   <a href="#input-processing-for-storage" class="md-nav__link">
1737     Input Processing for Storage
1738   </a>
1739
1740 </li>
1741
1742           <li class="md-nav__item">
1743   <a href="#embedded-objects" class="md-nav__link">
1744     Embedded Objects
1745   </a>
1746
1747 </li>
1748
1749           <li class="md-nav__item">
1750   <a href="#rendering-the-message" class="md-nav__link">
1751     Rendering the Message
1752   </a>
1753
1754     <nav class="md-nav" aria-label="Rendering the Message">
1755       <ul class="md-nav__list">
1756
1757           <li class="md-nav__item">
1758   <a href="#simplified-output" class="md-nav__link">
1759     Simplified Output
1760   </a>
1761
1762 </li>
1763
1764           <li class="md-nav__item">
1765   <a href="#plaintext-output" class="md-nav__link">
1766     Plaintext Output
1767   </a>
1768
1769 </li>
1770
1771       </ul>
1772     </nav>
1773
1774 </li>
1775
1776           <li class="md-nav__item">
1777   <a href="#rebuilding-data" class="md-nav__link">
1778     Rebuilding Data
1779   </a>
1780
1781     <nav class="md-nav" aria-label="Rebuilding Data">
1782       <ul class="md-nav__list">
1783
1784           <li class="md-nav__item">
1785   <a href="#converting-from-bbcode" class="md-nav__link">
1786     Converting from BBCode
1787   </a>
1788
1789 </li>
1790
1791           <li class="md-nav__item">
1792   <a href="#extracting-embedded-objects" class="md-nav__link">
1793     Extracting Embedded Objects
1794   </a>
1795
1796 </li>
1797
1798       </ul>
1799     </nav>
1800
1801 </li>
1802
1803       </ul>
1804     </nav>
1805
1806 </li>
1807
1808         <li class="md-nav__item">
1809   <a href="#breadcrumbs-page-location" class="md-nav__link">
1810     Breadcrumbs / Page Location
1811   </a>
1812
1813 </li>
1814
1815         <li class="md-nav__item">
1816   <a href="#pages-and-forms" class="md-nav__link">
1817     Pages and Forms
1818   </a>
1819
1820 </li>
1821
1822         <li class="md-nav__item">
1823   <a href="#search" class="md-nav__link">
1824     Search
1825   </a>
1826
1827     <nav class="md-nav" aria-label="Search">
1828       <ul class="md-nav__list">
1829
1830           <li class="md-nav__item">
1831   <a href="#isearchableobjecttype" class="md-nav__link">
1832     ISearchableObjectType
1833   </a>
1834
1835 </li>
1836
1837           <li class="md-nav__item">
1838   <a href="#searchindexmanager" class="md-nav__link">
1839     SearchIndexManager
1840   </a>
1841
1842 </li>
1843
1844       </ul>
1845     </nav>
1846
1847 </li>
1848
1849     </ul>
1850
1851 </nav>
1852
1853     </li>
1854
1855
1856
1857
1858
1859
1860
1861     <li class="md-nav__item">
1862       <a href="../templates/" class="md-nav__link">
1863         Templates
1864       </a>
1865     </li>
1866
1867
1868
1869
1870
1871
1872
1873     <li class="md-nav__item">
1874       <a href="../css/" class="md-nav__link">
1875         CSS
1876       </a>
1877     </li>
1878
1879
1880
1881
1882
1883
1884
1885     <li class="md-nav__item">
1886       <a href="../package/" class="md-nav__link">
1887         Package Components
1888       </a>
1889     </li>
1890
1891
1892
1893         </ul>
1894       </nav>
1895     </li>
1896
1897
1898
1899         </ul>
1900       </nav>
1901     </li>
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913     <li class="md-nav__item md-nav__item--nested">
1914
1915
1916         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1917
1918       <label class="md-nav__link" for="__nav_7">
1919         Tutorials
1920         <span class="md-nav__icon md-icon"></span>
1921       </label>
1922       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1923         <label class="md-nav__title" for="__nav_7">
1924           <span class="md-nav__icon md-icon"></span>
1925           Tutorials
1926         </label>
1927         <ul class="md-nav__list" data-md-scrollfix>
1928
1929
1930
1931
1932
1933
1934     <li class="md-nav__item md-nav__item--nested">
1935
1936
1937         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1938
1939       <label class="md-nav__link" for="__nav_7_1">
1940         Tutorial Series
1941         <span class="md-nav__icon md-icon"></span>
1942       </label>
1943       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1944         <label class="md-nav__title" for="__nav_7_1">
1945           <span class="md-nav__icon md-icon"></span>
1946           Tutorial Series
1947         </label>
1948         <ul class="md-nav__list" data-md-scrollfix>
1949
1950
1951
1952
1953
1954     <li class="md-nav__item">
1955       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1956         Overview
1957       </a>
1958     </li>
1959
1960
1961
1962
1963
1964
1965
1966     <li class="md-nav__item">
1967       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1968         Part 1
1969       </a>
1970     </li>
1971
1972
1973
1974
1975
1976
1977
1978     <li class="md-nav__item">
1979       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1980         Part 2
1981       </a>
1982     </li>
1983
1984
1985
1986
1987
1988
1989
1990     <li class="md-nav__item">
1991       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1992         Part 3
1993       </a>
1994     </li>
1995
1996
1997
1998         </ul>
1999       </nav>
2000     </li>
2001
2002
2003
2004         </ul>
2005       </nav>
2006     </li>
2007
2008
2009
2010   </ul>
2011 </nav>
2012                   </div>
2013                 </div>
2014               </div>
2015
2016
2017
2018               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2019                 <div class="md-sidebar__scrollwrap">
2020                   <div class="md-sidebar__inner">
2021
2022 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2023
2024
2025
2026
2027
2028     <label class="md-nav__title" for="__toc">
2029       <span class="md-nav__icon md-icon"></span>
2030       Table of contents
2031     </label>
2032     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2033
2034         <li class="md-nav__item">
2035   <a href="#message-processing" class="md-nav__link">
2036     Message Processing
2037   </a>
2038
2039     <nav class="md-nav" aria-label="Message Processing">
2040       <ul class="md-nav__list">
2041
2042           <li class="md-nav__item">
2043   <a href="#input-processing-for-storage" class="md-nav__link">
2044     Input Processing for Storage
2045   </a>
2046
2047 </li>
2048
2049           <li class="md-nav__item">
2050   <a href="#embedded-objects" class="md-nav__link">
2051     Embedded Objects
2052   </a>
2053
2054 </li>
2055
2056           <li class="md-nav__item">
2057   <a href="#rendering-the-message" class="md-nav__link">
2058     Rendering the Message
2059   </a>
2060
2061     <nav class="md-nav" aria-label="Rendering the Message">
2062       <ul class="md-nav__list">
2063
2064           <li class="md-nav__item">
2065   <a href="#simplified-output" class="md-nav__link">
2066     Simplified Output
2067   </a>
2068
2069 </li>
2070
2071           <li class="md-nav__item">
2072   <a href="#plaintext-output" class="md-nav__link">
2073     Plaintext Output
2074   </a>
2075
2076 </li>
2077
2078       </ul>
2079     </nav>
2080
2081 </li>
2082
2083           <li class="md-nav__item">
2084   <a href="#rebuilding-data" class="md-nav__link">
2085     Rebuilding Data
2086   </a>
2087
2088     <nav class="md-nav" aria-label="Rebuilding Data">
2089       <ul class="md-nav__list">
2090
2091           <li class="md-nav__item">
2092   <a href="#converting-from-bbcode" class="md-nav__link">
2093     Converting from BBCode
2094   </a>
2095
2096 </li>
2097
2098           <li class="md-nav__item">
2099   <a href="#extracting-embedded-objects" class="md-nav__link">
2100     Extracting Embedded Objects
2101   </a>
2102
2103 </li>
2104
2105       </ul>
2106     </nav>
2107
2108 </li>
2109
2110       </ul>
2111     </nav>
2112
2113 </li>
2114
2115         <li class="md-nav__item">
2116   <a href="#breadcrumbs-page-location" class="md-nav__link">
2117     Breadcrumbs / Page Location
2118   </a>
2119
2120 </li>
2121
2122         <li class="md-nav__item">
2123   <a href="#pages-and-forms" class="md-nav__link">
2124     Pages and Forms
2125   </a>
2126
2127 </li>
2128
2129         <li class="md-nav__item">
2130   <a href="#search" class="md-nav__link">
2131     Search
2132   </a>
2133
2134     <nav class="md-nav" aria-label="Search">
2135       <ul class="md-nav__list">
2136
2137           <li class="md-nav__item">
2138   <a href="#isearchableobjecttype" class="md-nav__link">
2139     ISearchableObjectType
2140   </a>
2141
2142 </li>
2143
2144           <li class="md-nav__item">
2145   <a href="#searchindexmanager" class="md-nav__link">
2146     SearchIndexManager
2147   </a>
2148
2149 </li>
2150
2151       </ul>
2152     </nav>
2153
2154 </li>
2155
2156     </ul>
2157
2158 </nav>
2159                   </div>
2160                 </div>
2161               </div>
2162
2163
2164           <div class="md-content" data-md-component="content">
2165             <article class="md-content__inner md-typeset">
2166
2167
2168                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/migration/wcf21/php.md" title="Edit this page" class="md-content__button md-icon">
2169                     <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>
2170                   </a>
2171
2172
2173                 <h1 id="wcf-21x-php">WCF 2.1.x - PHP<a class="headerlink" href="#wcf-21x-php" title="Permanent link">#</a></h1>
2174 <h2 id="message-processing">Message Processing<a class="headerlink" href="#message-processing" title="Permanent link">#</a></h2>
2175 <p>WoltLab Suite 3.0 finally made the transition from raw bbcode to bbcode-flavored HTML, with many new features related to message processing being added. This change impacts both message validation and storing, requiring slightly different APIs to get the job done.</p>
2176 <h3 id="input-processing-for-storage">Input Processing for Storage<a class="headerlink" href="#input-processing-for-storage" title="Permanent link">#</a></h3>
2177 <p>The returned HTML is an intermediate representation with a maximum of meta data embedded into it, designed to be stored in the database. Some bbcodes are replaced during this process, for example <code>[b]…[/b]</code> becomes <code>&lt;strong&gt;…&lt;/strong&gt;</code>, while others are converted into a metacode tag for later processing.</p>
2178 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2179 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\input\HtmlInputProcessor</span><span class="p">();</span>
2180 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">(</span><span class="nv">$message</span><span class="p">,</span> <span class="nv">$messageObjectType</span><span class="p">,</span> <span class="nv">$messageObjectID</span><span class="p">);</span>
2181 <span class="nv">$html</span> <span class="o">=</span> <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">();</span>
2182 </code></pre></div>
2183 <p>The <code>$messageObjectID</code> can be zero if the element did not exist before, but it should be non-zero when saving an edited message.</p>
2184 <h3 id="embedded-objects">Embedded Objects<a class="headerlink" href="#embedded-objects" title="Permanent link">#</a></h3>
2185 <p>Embedded objects need to be registered after saving the message, but once again you can use the processor instance to do the job.</p>
2186 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2187 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\input\HtmlInputProcessor</span><span class="p">();</span>
2188 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">(</span><span class="nv">$message</span><span class="p">,</span> <span class="nv">$messageObjectType</span><span class="p">,</span> <span class="nv">$messageObjectID</span><span class="p">);</span>
2189 <span class="nv">$html</span> <span class="o">=</span> <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">();</span>
2190
2191 <span class="c1">// at this point the message is saved to database and the created object</span>
2192 <span class="c1">// `$example` is a `DatabaseObject` with the id column `$exampleID`</span>
2193
2194 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">setObjectID</span><span class="p">(</span><span class="nv">$example</span><span class="o">-&gt;</span><span class="na">exampleID</span><span class="p">);</span>
2195 <span class="k">if</span> <span class="p">(</span><span class="nx">\wcf\system\message\embedded\object\MessageEmbeddedObjectManager</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">registerObjects</span><span class="p">(</span><span class="nv">$processor</span><span class="p">))</span> <span class="p">{</span>
2196     <span class="c1">// there is at least one embedded object, this is also the point at which you</span>
2197     <span class="c1">// would set `hasEmbeddedObjects` to true (if implemented by your type)</span>
2198     <span class="p">(</span><span class="k">new</span> <span class="nx">\wcf\data\example\ExampleEditor</span><span class="p">(</span><span class="nv">$example</span><span class="p">))</span><span class="o">-&gt;</span><span class="na">update</span><span class="p">([</span><span class="s1">&#39;hasEmbeddedObjects&#39;</span> <span class="o">=&gt;</span> <span class="mi">1</span><span class="p">]);</span>
2199 <span class="p">}</span>
2200 </code></pre></div>
2201 <h3 id="rendering-the-message">Rendering the Message<a class="headerlink" href="#rendering-the-message" title="Permanent link">#</a></h3>
2202 <p>The output processor will parse the intermediate HTML and finalize the output for display. This step is highly dynamic and allows for bbcode evaluation and contextual output based on the viewer's permissions.</p>
2203 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2204 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\output\HtmlOutputProcessor</span><span class="p">();</span>
2205 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">(</span><span class="nv">$html</span><span class="p">,</span> <span class="nv">$messageObjectType</span><span class="p">,</span> <span class="nv">$messageObjectID</span><span class="p">);</span>
2206 <span class="nv">$renderedHtml</span> <span class="o">=</span> <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">();</span>
2207 </code></pre></div>
2208 <h4 id="simplified-output">Simplified Output<a class="headerlink" href="#simplified-output" title="Permanent link">#</a></h4>
2209 <p>At some point there can be the need of a simplified output HTML that includes only basic HTML formatting and reduces more sophisticated bbcodes into a simpler representation.</p>
2210 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2211 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\output\HtmlOutputProcessor</span><span class="p">();</span>
2212 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">setOutputType</span><span class="p">(</span><span class="s1">&#39;text/simplified-html&#39;</span><span class="p">);</span>
2213 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">(</span><span class="nx">…</span><span class="p">);</span>
2214 </code></pre></div>
2215 <h4 id="plaintext-output">Plaintext Output<a class="headerlink" href="#plaintext-output" title="Permanent link">#</a></h4>
2216 <p>The <code>text/plain</code> output type will strip down the simplified HTML into pure text, suitable for text-only output such as the plaintext representation of an email.</p>
2217 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2218 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\output\HtmlOutputProcessor</span><span class="p">();</span>
2219 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">setOutputType</span><span class="p">(</span><span class="s1">&#39;text/plain&#39;</span><span class="p">);</span>
2220 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">(</span><span class="nx">…</span><span class="p">);</span>
2221 </code></pre></div>
2222 <h3 id="rebuilding-data">Rebuilding Data<a class="headerlink" href="#rebuilding-data" title="Permanent link">#</a></h3>
2223 <h4 id="converting-from-bbcode">Converting from BBCode<a class="headerlink" href="#converting-from-bbcode" title="Permanent link">#</a></h4>
2224 <div class="admonition warning">
2225 <p class="admonition-title">Enabling message conversion for HTML messages is undefined and yields unexpected results.</p>
2226 </div>
2227 <p>Legacy message that still use raw bbcodes must be converted to be properly parsed by the html processors. This process is enabled by setting the fourth parameter of <code>process()</code> to <code>true</code>.</p>
2228 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2229 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\input\HtmlInputProcessor</span><span class="p">();</span>
2230 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">(</span><span class="nv">$html</span><span class="p">,</span> <span class="nv">$messageObjectType</span><span class="p">,</span> <span class="nv">$messageObjectID</span><span class="p">,</span> <span class="k">true</span><span class="p">);</span>
2231 <span class="nv">$renderedHtml</span> <span class="o">=</span> <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">();</span>
2232 </code></pre></div>
2233 <h4 id="extracting-embedded-objects">Extracting Embedded Objects<a class="headerlink" href="#extracting-embedded-objects" title="Permanent link">#</a></h4>
2234 <p>The <code>process()</code> method of the input processor is quite expensive, as it runs through the full message validation including the invocation of HTMLPurifier. This is perfectly fine when dealing with single messages, but when you're handling messages in bulk to extract their embedded objects, you're better of with <code>processEmbeddedContent()</code>. This method deconstructs the message, but skips all validation and expects the input to be perfectly valid, that is the output of a previous run of <code>process()</code> saved to storage.</p>
2235 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2236 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\input\HtmlInputProcessor</span><span class="p">();</span>
2237 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">processEmbeddedContent</span><span class="p">(</span><span class="nv">$html</span><span class="p">,</span> <span class="nv">$messageObjectType</span><span class="p">,</span> <span class="nv">$messageObjectID</span><span class="p">);</span>
2238
2239 <span class="c1">// invoke `MessageEmbeddedObjectManager::registerObjects` here</span>
2240 </code></pre></div>
2241 <h2 id="breadcrumbs-page-location">Breadcrumbs / Page Location<a class="headerlink" href="#breadcrumbs-page-location" title="Permanent link">#</a></h2>
2242 <div class="admonition warning">
2243 <p class="admonition-title">Breadcrumbs used to be added left to right, but parent locations are added from the bottom to the top, starting with the first ancestor and going upwards. In most cases you simply need to reverse the order.</p>
2244 </div>
2245 <p>Breadcrumbs used to be a lose collection of arbitrary links, but are now represented by actual page objects and the control has shifted over to the <code>PageLocationManager</code>.</p>
2246 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2247 <span class="c1">// before</span>
2248 <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getBreadcrumbs</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">add</span><span class="p">(</span><span class="k">new</span> <span class="nx">\wcf\system\breadcrumb\Breadcrumb</span><span class="p">(</span><span class="s1">&#39;title&#39;</span><span class="p">,</span> <span class="s1">&#39;link&#39;</span><span class="p">));</span>
2249
2250 <span class="c1">// after</span>
2251 <span class="nx">\wcf\system\page\PageLocationManager</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">addParentLocation</span><span class="p">(</span><span class="nv">$pageIdentifier</span><span class="p">,</span> <span class="nv">$pageObjectID</span><span class="p">,</span> <span class="nv">$object</span><span class="p">);</span>
2252 </code></pre></div>
2253 <h2 id="pages-and-forms">Pages and Forms<a class="headerlink" href="#pages-and-forms" title="Permanent link">#</a></h2>
2254 <p>The property <code>$activeMenuItem</code> has been deprecated for the front end and is no longer evaluated at runtime. Recognition of the active item is entirely based around the invoked controller class name and its definition in the page table. You need to properly <a href="../../../package/pip/page/">register your pages</a> for this feature to work.</p>
2255 <h2 id="search">Search<a class="headerlink" href="#search" title="Permanent link">#</a></h2>
2256 <h3 id="isearchableobjecttype">ISearchableObjectType<a class="headerlink" href="#isearchableobjecttype" title="Permanent link">#</a></h3>
2257 <p>Added the <code>setLocation()</code> method that is used to set the current page location based on the search result.</p>
2258 <h3 id="searchindexmanager">SearchIndexManager<a class="headerlink" href="#searchindexmanager" title="Permanent link">#</a></h3>
2259 <p>The methods <code>SearchIndexManager::add()</code> and <code>SearchIndexManager::update()</code> have been deprecated and forward their call to the new method <code>SearchIndexManager::set()</code>.</p>
2260
2261
2262
2263
2264 <hr>
2265 <div class="md-source-date">
2266   <small>
2267
2268       Last update: 2021-01-08
2269
2270   </small>
2271 </div>
2272
2273
2274
2275
2276
2277
2278
2279
2280             </article>
2281           </div>
2282         </div>
2283
2284       </main>
2285
2286
2287 <footer class="md-footer">
2288
2289     <nav class="md-footer__inner md-grid" aria-label="Footer">
2290
2291         <a href="../../wsc30/package/" class="md-footer__link md-footer__link--prev" rel="prev">
2292           <div class="md-footer__button md-icon">
2293             <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>
2294           </div>
2295           <div class="md-footer__title">
2296             <div class="md-ellipsis">
2297               <span class="md-footer__direction">
2298                 Previous
2299               </span>
2300               Package Components
2301             </div>
2302           </div>
2303         </a>
2304
2305
2306         <a href="../templates/" class="md-footer__link md-footer__link--next" rel="next">
2307           <div class="md-footer__title">
2308             <div class="md-ellipsis">
2309               <span class="md-footer__direction">
2310                 Next
2311               </span>
2312               Templates
2313             </div>
2314           </div>
2315           <div class="md-footer__button md-icon">
2316             <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>
2317           </div>
2318         </a>
2319
2320     </nav>
2321
2322   <div class="md-footer-meta md-typeset">
2323     <div class="md-footer-meta__inner md-grid">
2324       <div class="md-footer-copyright">
2325
2326           <div class="md-footer-copyright__highlight">
2327             Copyright © 2020 WoltLab GmbH
2328           </div>
2329
2330         Made with
2331         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2332           Material for MkDocs
2333         </a>
2334
2335       </div>
2336       <div class="md-footer-copyright">
2337         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2338         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2339 </div>
2340     </div>
2341   </div>
2342 </footer>
2343
2344     </div>
2345     <div class="md-dialog" data-md-component="dialog">
2346       <div class="md-dialog__inner md-typeset"></div>
2347     </div>
2348     <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>
2349
2350
2351       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2352
2353
2354   </body>
2355 </html>