5.4/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     <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         TypeScript and JavaScript API
 617         <span class="md-nav__icon md-icon"></span>
 618       </label>
 619       <nav class="md-nav" aria-label="TypeScript and 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           TypeScript and 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     <li class="md-nav__item">
 643       <a href="../../../javascript/typescript/" class="md-nav__link">
 644         TypeScript
 645       </a>
 646     </li>
 647
 648
 649
 650
 651
 652
 653
 654
 655     <li class="md-nav__item md-nav__item--nested">
 656
 657
 658         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 659
 660       <label class="md-nav__link" for="__nav_4_3">
 661         New API
 662         <span class="md-nav__icon md-icon"></span>
 663       </label>
 664       <nav class="md-nav" aria-label="New API" data-md-level="2">
 665         <label class="md-nav__title" for="__nav_4_3">
 666           <span class="md-nav__icon md-icon"></span>
 667           New API
 668         </label>
 669         <ul class="md-nav__list" data-md-scrollfix>
 670
 671
 672
 673
 674
 675     <li class="md-nav__item">
 676       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 677         Writing a module
 678       </a>
 679     </li>
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item">
 688       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 689         Data Structures
 690       </a>
 691     </li>
 692
 693
 694
 695
 696
 697
 698
 699     <li class="md-nav__item">
 700       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 701         Core Functions
 702       </a>
 703     </li>
 704
 705
 706
 707
 708
 709
 710
 711     <li class="md-nav__item">
 712       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 713         DOM
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 725         Event Handling
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735     <li class="md-nav__item">
 736       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 737         Ajax
 738       </a>
 739     </li>
 740
 741
 742
 743
 744
 745
 746
 747     <li class="md-nav__item">
 748       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 749         Dialogs
 750       </a>
 751     </li>
 752
 753
 754
 755
 756
 757
 758
 759     <li class="md-nav__item">
 760       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 761         Browser and Screen Sizes
 762       </a>
 763     </li>
 764
 765
 766
 767
 768
 769
 770
 771     <li class="md-nav__item">
 772       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 773         User Interface
 774       </a>
 775     </li>
 776
 777
 778
 779         </ul>
 780       </nav>
 781     </li>
 782
 783
 784
 785
 786
 787
 788
 789     <li class="md-nav__item">
 790       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 791         Legacy API
 792       </a>
 793     </li>
 794
 795
 796
 797
 798
 799
 800
 801     <li class="md-nav__item">
 802       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 803         Helper Functions
 804       </a>
 805     </li>
 806
 807
 808
 809
 810
 811
 812
 813     <li class="md-nav__item">
 814       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 815         Code Snippets
 816       </a>
 817     </li>
 818
 819
 820
 821         </ul>
 822       </nav>
 823     </li>
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835     <li class="md-nav__item md-nav__item--nested">
 836
 837
 838         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 839
 840       <label class="md-nav__link" for="__nav_5">
 841         Package Components
 842         <span class="md-nav__icon md-icon"></span>
 843       </label>
 844       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 845         <label class="md-nav__title" for="__nav_5">
 846           <span class="md-nav__icon md-icon"></span>
 847           Package Components
 848         </label>
 849         <ul class="md-nav__list" data-md-scrollfix>
 850
 851
 852
 853
 854
 855     <li class="md-nav__item">
 856       <a href="../../../package/package-xml/" class="md-nav__link">
 857         package.xml
 858       </a>
 859     </li>
 860
 861
 862
 863
 864
 865
 866
 867
 868     <li class="md-nav__item md-nav__item--nested">
 869
 870
 871         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
 872
 873       <label class="md-nav__link" for="__nav_5_2">
 874         PIPs
 875         <span class="md-nav__icon md-icon"></span>
 876       </label>
 877       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 878         <label class="md-nav__title" for="__nav_5_2">
 879           <span class="md-nav__icon md-icon"></span>
 880           PIPs
 881         </label>
 882         <ul class="md-nav__list" data-md-scrollfix>
 883
 884
 885
 886
 887
 888     <li class="md-nav__item">
 889       <a href="../../../package/pip/" class="md-nav__link">
 890         Overview
 891       </a>
 892     </li>
 893
 894
 895
 896
 897
 898
 899
 900     <li class="md-nav__item">
 901       <a href="../../../package/pip/acl-option/" class="md-nav__link">
 902         aclOption
 903       </a>
 904     </li>
 905
 906
 907
 908
 909
 910
 911
 912     <li class="md-nav__item">
 913       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
 914         acpMenu
 915       </a>
 916     </li>
 917
 918
 919
 920
 921
 922
 923
 924     <li class="md-nav__item">
 925       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
 926         acpSearchProvider
 927       </a>
 928     </li>
 929
 930
 931
 932
 933
 934
 935
 936     <li class="md-nav__item">
 937       <a href="../../../package/pip/acp-template/" class="md-nav__link">
 938         acpTemplate
 939       </a>
 940     </li>
 941
 942
 943
 944
 945
 946
 947
 948     <li class="md-nav__item">
 949       <a href="../../../package/pip/bbcode/" class="md-nav__link">
 950         bbcode
 951       </a>
 952     </li>
 953
 954
 955
 956
 957
 958
 959
 960     <li class="md-nav__item">
 961       <a href="../../../package/pip/box/" class="md-nav__link">
 962         box
 963       </a>
 964     </li>
 965
 966
 967
 968
 969
 970
 971
 972     <li class="md-nav__item">
 973       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
 974         clipboardAction
 975       </a>
 976     </li>
 977
 978
 979
 980
 981
 982
 983
 984     <li class="md-nav__item">
 985       <a href="../../../package/pip/core-object/" class="md-nav__link">
 986         coreObject
 987       </a>
 988     </li>
 989
 990
 991
 992
 993
 994
 995
 996     <li class="md-nav__item">
 997       <a href="../../../package/pip/cronjob/" class="md-nav__link">
 998         cronjob
 999       </a>
1000     </li>
1001
1002
1003
1004
1005
1006
1007
1008     <li class="md-nav__item">
1009       <a href="../../../package/pip/event-listener/" class="md-nav__link">
1010         eventListener
1011       </a>
1012     </li>
1013
1014
1015
1016
1017
1018
1019
1020     <li class="md-nav__item">
1021       <a href="../../../package/pip/file/" class="md-nav__link">
1022         file
1023       </a>
1024     </li>
1025
1026
1027
1028
1029
1030
1031
1032     <li class="md-nav__item">
1033       <a href="../../../package/pip/language/" class="md-nav__link">
1034         language
1035       </a>
1036     </li>
1037
1038
1039
1040
1041
1042
1043
1044     <li class="md-nav__item">
1045       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1046         mediaProvider
1047       </a>
1048     </li>
1049
1050
1051
1052
1053
1054
1055
1056     <li class="md-nav__item">
1057       <a href="../../../package/pip/menu/" class="md-nav__link">
1058         menu
1059       </a>
1060     </li>
1061
1062
1063
1064
1065
1066
1067
1068     <li class="md-nav__item">
1069       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1070         menuItem
1071       </a>
1072     </li>
1073
1074
1075
1076
1077
1078
1079
1080     <li class="md-nav__item">
1081       <a href="../../../package/pip/object-type/" class="md-nav__link">
1082         objectType
1083       </a>
1084     </li>
1085
1086
1087
1088
1089
1090
1091
1092     <li class="md-nav__item">
1093       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1094         objectTypeDefinition
1095       </a>
1096     </li>
1097
1098
1099
1100
1101
1102
1103
1104     <li class="md-nav__item">
1105       <a href="../../../package/pip/option/" class="md-nav__link">
1106         option
1107       </a>
1108     </li>
1109
1110
1111
1112
1113
1114
1115
1116     <li class="md-nav__item">
1117       <a href="../../../package/pip/page/" class="md-nav__link">
1118         page
1119       </a>
1120     </li>
1121
1122
1123
1124
1125
1126
1127
1128     <li class="md-nav__item">
1129       <a href="../../../package/pip/pip/" class="md-nav__link">
1130         pip
1131       </a>
1132     </li>
1133
1134
1135
1136
1137
1138
1139
1140     <li class="md-nav__item">
1141       <a href="../../../package/pip/script/" class="md-nav__link">
1142         script
1143       </a>
1144     </li>
1145
1146
1147
1148
1149
1150
1151
1152     <li class="md-nav__item">
1153       <a href="../../../package/pip/smiley/" class="md-nav__link">
1154         smiley
1155       </a>
1156     </li>
1157
1158
1159
1160
1161
1162
1163
1164     <li class="md-nav__item">
1165       <a href="../../../package/pip/sql/" class="md-nav__link">
1166         sql
1167       </a>
1168     </li>
1169
1170
1171
1172
1173
1174
1175
1176     <li class="md-nav__item">
1177       <a href="../../../package/pip/style/" class="md-nav__link">
1178         style
1179       </a>
1180     </li>
1181
1182
1183
1184
1185
1186
1187
1188     <li class="md-nav__item">
1189       <a href="../../../package/pip/template/" class="md-nav__link">
1190         template
1191       </a>
1192     </li>
1193
1194
1195
1196
1197
1198
1199
1200     <li class="md-nav__item">
1201       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1202         templateListener
1203       </a>
1204     </li>
1205
1206
1207
1208
1209
1210
1211
1212     <li class="md-nav__item">
1213       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1214         userGroupOption
1215       </a>
1216     </li>
1217
1218
1219
1220
1221
1222
1223
1224     <li class="md-nav__item">
1225       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1226         userMenu
1227       </a>
1228     </li>
1229
1230
1231
1232
1233
1234
1235
1236     <li class="md-nav__item">
1237       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1238         userNotificationEvent
1239       </a>
1240     </li>
1241
1242
1243
1244
1245
1246
1247
1248     <li class="md-nav__item">
1249       <a href="../../../package/pip/user-option/" class="md-nav__link">
1250         userOption
1251       </a>
1252     </li>
1253
1254
1255
1256
1257
1258
1259
1260     <li class="md-nav__item">
1261       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1262         userProfileMenu
1263       </a>
1264     </li>
1265
1266
1267
1268         </ul>
1269       </nav>
1270     </li>
1271
1272
1273
1274
1275
1276
1277
1278     <li class="md-nav__item">
1279       <a href="../../../package/database-php-api/" class="md-nav__link">
1280         Database PHP API
1281       </a>
1282     </li>
1283
1284
1285
1286         </ul>
1287       </nav>
1288     </li>
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1303
1304
1305         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
1306
1307       <label class="md-nav__link" for="__nav_6">
1308         Migration
1309         <span class="md-nav__icon md-icon"></span>
1310       </label>
1311       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1312         <label class="md-nav__title" for="__nav_6">
1313           <span class="md-nav__icon md-icon"></span>
1314           Migration
1315         </label>
1316         <ul class="md-nav__list" data-md-scrollfix>
1317
1318
1319
1320
1321
1322
1323     <li class="md-nav__item md-nav__item--nested">
1324
1325
1326         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1327
1328       <label class="md-nav__link" for="__nav_6_1">
1329         Migrating from WSC 5.3
1330         <span class="md-nav__icon md-icon"></span>
1331       </label>
1332       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1333         <label class="md-nav__title" for="__nav_6_1">
1334           <span class="md-nav__icon md-icon"></span>
1335           Migrating from WSC 5.3
1336         </label>
1337         <ul class="md-nav__list" data-md-scrollfix>
1338
1339
1340
1341
1342
1343     <li class="md-nav__item">
1344       <a href="../../wsc53/php/" class="md-nav__link">
1345         PHP API
1346       </a>
1347     </li>
1348
1349
1350
1351
1352
1353
1354
1355     <li class="md-nav__item">
1356       <a href="../../wsc53/session/" class="md-nav__link">
1357         Session Handling and Authentication
1358       </a>
1359     </li>
1360
1361
1362
1363
1364
1365
1366
1367     <li class="md-nav__item">
1368       <a href="../../wsc53/javascript/" class="md-nav__link">
1369         TypeScript and JavaScript
1370       </a>
1371     </li>
1372
1373
1374
1375
1376
1377
1378
1379     <li class="md-nav__item">
1380       <a href="../../wsc53/templates/" class="md-nav__link">
1381         Templates
1382       </a>
1383     </li>
1384
1385
1386
1387
1388
1389
1390
1391     <li class="md-nav__item">
1392       <a href="../../wsc53/libraries/" class="md-nav__link">
1393         Third Party Libraries
1394       </a>
1395     </li>
1396
1397
1398
1399         </ul>
1400       </nav>
1401     </li>
1402
1403
1404
1405
1406
1407
1408
1409
1410     <li class="md-nav__item md-nav__item--nested">
1411
1412
1413         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1414
1415       <label class="md-nav__link" for="__nav_6_2">
1416         Migrating from WSC 5.2
1417         <span class="md-nav__icon md-icon"></span>
1418       </label>
1419       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1420         <label class="md-nav__title" for="__nav_6_2">
1421           <span class="md-nav__icon md-icon"></span>
1422           Migrating from WSC 5.2
1423         </label>
1424         <ul class="md-nav__list" data-md-scrollfix>
1425
1426
1427
1428
1429
1430     <li class="md-nav__item">
1431       <a href="../../wsc52/php/" class="md-nav__link">
1432         PHP API
1433       </a>
1434     </li>
1435
1436
1437
1438
1439
1440
1441
1442     <li class="md-nav__item">
1443       <a href="../../wsc52/templates/" class="md-nav__link">
1444         Templates and Languages
1445       </a>
1446     </li>
1447
1448
1449
1450
1451
1452
1453
1454     <li class="md-nav__item">
1455       <a href="../../wsc52/libraries/" class="md-nav__link">
1456         Third Party Libraries
1457       </a>
1458     </li>
1459
1460
1461
1462         </ul>
1463       </nav>
1464     </li>
1465
1466
1467
1468
1469
1470
1471
1472
1473     <li class="md-nav__item md-nav__item--nested">
1474
1475
1476         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1477
1478       <label class="md-nav__link" for="__nav_6_3">
1479         Migrating from WSC 3.1
1480         <span class="md-nav__icon md-icon"></span>
1481       </label>
1482       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1483         <label class="md-nav__title" for="__nav_6_3">
1484           <span class="md-nav__icon md-icon"></span>
1485           Migrating from WSC 3.1
1486         </label>
1487         <ul class="md-nav__list" data-md-scrollfix>
1488
1489
1490
1491
1492
1493     <li class="md-nav__item">
1494       <a href="../../wsc31/php/" class="md-nav__link">
1495         PHP API
1496       </a>
1497     </li>
1498
1499
1500
1501         </ul>
1502       </nav>
1503     </li>
1504
1505
1506
1507
1508
1509
1510
1511
1512     <li class="md-nav__item md-nav__item--nested">
1513
1514
1515         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1516
1517       <label class="md-nav__link" for="__nav_6_4">
1518         Migrating from WSC 3.0
1519         <span class="md-nav__icon md-icon"></span>
1520       </label>
1521       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1522         <label class="md-nav__title" for="__nav_6_4">
1523           <span class="md-nav__icon md-icon"></span>
1524           Migrating from WSC 3.0
1525         </label>
1526         <ul class="md-nav__list" data-md-scrollfix>
1527
1528
1529
1530
1531
1532     <li class="md-nav__item">
1533       <a href="../../wsc30/php/" class="md-nav__link">
1534         PHP API
1535       </a>
1536     </li>
1537
1538
1539
1540
1541
1542
1543
1544     <li class="md-nav__item">
1545       <a href="../../wsc30/javascript/" class="md-nav__link">
1546         JavaScript API
1547       </a>
1548     </li>
1549
1550
1551
1552
1553
1554
1555
1556     <li class="md-nav__item">
1557       <a href="../../wsc30/templates/" class="md-nav__link">
1558         Templates
1559       </a>
1560     </li>
1561
1562
1563
1564
1565
1566
1567
1568     <li class="md-nav__item">
1569       <a href="../../wsc30/css/" class="md-nav__link">
1570         CSS
1571       </a>
1572     </li>
1573
1574
1575
1576
1577
1578
1579
1580     <li class="md-nav__item">
1581       <a href="../../wsc30/package/" class="md-nav__link">
1582         Package Components
1583       </a>
1584     </li>
1585
1586
1587
1588         </ul>
1589       </nav>
1590     </li>
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1602
1603
1604         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" checked>
1605
1606       <label class="md-nav__link" for="__nav_6_5">
1607         Migrating from WCF 2.1
1608         <span class="md-nav__icon md-icon"></span>
1609       </label>
1610       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1611         <label class="md-nav__title" for="__nav_6_5">
1612           <span class="md-nav__icon md-icon"></span>
1613           Migrating from WCF 2.1
1614         </label>
1615         <ul class="md-nav__list" data-md-scrollfix>
1616
1617
1618
1619
1620
1621
1622
1623     <li class="md-nav__item md-nav__item--active">
1624
1625       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1626
1627
1628
1629
1630         <label class="md-nav__link md-nav__link--active" for="__toc">
1631           PHP API
1632           <span class="md-nav__icon md-icon"></span>
1633         </label>
1634
1635       <a href="./" class="md-nav__link md-nav__link--active">
1636         PHP API
1637       </a>
1638
1639
1640 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1641
1642
1643
1644
1645
1646     <label class="md-nav__title" for="__toc">
1647       <span class="md-nav__icon md-icon"></span>
1648       Table of contents
1649     </label>
1650     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1651
1652         <li class="md-nav__item">
1653   <a href="#message-processing" class="md-nav__link">
1654     Message Processing
1655   </a>
1656
1657     <nav class="md-nav" aria-label="Message Processing">
1658       <ul class="md-nav__list">
1659
1660           <li class="md-nav__item">
1661   <a href="#input-processing-for-storage" class="md-nav__link">
1662     Input Processing for Storage
1663   </a>
1664
1665 </li>
1666
1667           <li class="md-nav__item">
1668   <a href="#embedded-objects" class="md-nav__link">
1669     Embedded Objects
1670   </a>
1671
1672 </li>
1673
1674           <li class="md-nav__item">
1675   <a href="#rendering-the-message" class="md-nav__link">
1676     Rendering the Message
1677   </a>
1678
1679     <nav class="md-nav" aria-label="Rendering the Message">
1680       <ul class="md-nav__list">
1681
1682           <li class="md-nav__item">
1683   <a href="#simplified-output" class="md-nav__link">
1684     Simplified Output
1685   </a>
1686
1687 </li>
1688
1689           <li class="md-nav__item">
1690   <a href="#plaintext-output" class="md-nav__link">
1691     Plaintext Output
1692   </a>
1693
1694 </li>
1695
1696       </ul>
1697     </nav>
1698
1699 </li>
1700
1701           <li class="md-nav__item">
1702   <a href="#rebuilding-data" class="md-nav__link">
1703     Rebuilding Data
1704   </a>
1705
1706     <nav class="md-nav" aria-label="Rebuilding Data">
1707       <ul class="md-nav__list">
1708
1709           <li class="md-nav__item">
1710   <a href="#converting-from-bbcode" class="md-nav__link">
1711     Converting from BBCode
1712   </a>
1713
1714 </li>
1715
1716           <li class="md-nav__item">
1717   <a href="#extracting-embedded-objects" class="md-nav__link">
1718     Extracting Embedded Objects
1719   </a>
1720
1721 </li>
1722
1723       </ul>
1724     </nav>
1725
1726 </li>
1727
1728       </ul>
1729     </nav>
1730
1731 </li>
1732
1733         <li class="md-nav__item">
1734   <a href="#breadcrumbs-page-location" class="md-nav__link">
1735     Breadcrumbs / Page Location
1736   </a>
1737
1738 </li>
1739
1740         <li class="md-nav__item">
1741   <a href="#pages-and-forms" class="md-nav__link">
1742     Pages and Forms
1743   </a>
1744
1745 </li>
1746
1747         <li class="md-nav__item">
1748   <a href="#search" class="md-nav__link">
1749     Search
1750   </a>
1751
1752     <nav class="md-nav" aria-label="Search">
1753       <ul class="md-nav__list">
1754
1755           <li class="md-nav__item">
1756   <a href="#isearchableobjecttype" class="md-nav__link">
1757     ISearchableObjectType
1758   </a>
1759
1760 </li>
1761
1762           <li class="md-nav__item">
1763   <a href="#searchindexmanager" class="md-nav__link">
1764     SearchIndexManager
1765   </a>
1766
1767 </li>
1768
1769       </ul>
1770     </nav>
1771
1772 </li>
1773
1774     </ul>
1775
1776 </nav>
1777
1778     </li>
1779
1780
1781
1782
1783
1784
1785
1786     <li class="md-nav__item">
1787       <a href="../templates/" class="md-nav__link">
1788         Templates
1789       </a>
1790     </li>
1791
1792
1793
1794
1795
1796
1797
1798     <li class="md-nav__item">
1799       <a href="../css/" class="md-nav__link">
1800         CSS
1801       </a>
1802     </li>
1803
1804
1805
1806
1807
1808
1809
1810     <li class="md-nav__item">
1811       <a href="../package/" class="md-nav__link">
1812         Package Components
1813       </a>
1814     </li>
1815
1816
1817
1818         </ul>
1819       </nav>
1820     </li>
1821
1822
1823
1824         </ul>
1825       </nav>
1826     </li>
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838     <li class="md-nav__item md-nav__item--nested">
1839
1840
1841         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1842
1843       <label class="md-nav__link" for="__nav_7">
1844         Tutorials
1845         <span class="md-nav__icon md-icon"></span>
1846       </label>
1847       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1848         <label class="md-nav__title" for="__nav_7">
1849           <span class="md-nav__icon md-icon"></span>
1850           Tutorials
1851         </label>
1852         <ul class="md-nav__list" data-md-scrollfix>
1853
1854
1855
1856
1857
1858
1859     <li class="md-nav__item md-nav__item--nested">
1860
1861
1862         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1863
1864       <label class="md-nav__link" for="__nav_7_1">
1865         Tutorial Series
1866         <span class="md-nav__icon md-icon"></span>
1867       </label>
1868       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1869         <label class="md-nav__title" for="__nav_7_1">
1870           <span class="md-nav__icon md-icon"></span>
1871           Tutorial Series
1872         </label>
1873         <ul class="md-nav__list" data-md-scrollfix>
1874
1875
1876
1877
1878
1879     <li class="md-nav__item">
1880       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1881         Overview
1882       </a>
1883     </li>
1884
1885
1886
1887
1888
1889
1890
1891     <li class="md-nav__item">
1892       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1893         Part 1
1894       </a>
1895     </li>
1896
1897
1898
1899
1900
1901
1902
1903     <li class="md-nav__item">
1904       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1905         Part 2
1906       </a>
1907     </li>
1908
1909
1910
1911
1912
1913
1914
1915     <li class="md-nav__item">
1916       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1917         Part 3
1918       </a>
1919     </li>
1920
1921
1922
1923         </ul>
1924       </nav>
1925     </li>
1926
1927
1928
1929         </ul>
1930       </nav>
1931     </li>
1932
1933
1934
1935   </ul>
1936 </nav>
1937                   </div>
1938                 </div>
1939               </div>
1940
1941
1942
1943               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1944                 <div class="md-sidebar__scrollwrap">
1945                   <div class="md-sidebar__inner">
1946
1947 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1948
1949
1950
1951
1952
1953     <label class="md-nav__title" for="__toc">
1954       <span class="md-nav__icon md-icon"></span>
1955       Table of contents
1956     </label>
1957     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1958
1959         <li class="md-nav__item">
1960   <a href="#message-processing" class="md-nav__link">
1961     Message Processing
1962   </a>
1963
1964     <nav class="md-nav" aria-label="Message Processing">
1965       <ul class="md-nav__list">
1966
1967           <li class="md-nav__item">
1968   <a href="#input-processing-for-storage" class="md-nav__link">
1969     Input Processing for Storage
1970   </a>
1971
1972 </li>
1973
1974           <li class="md-nav__item">
1975   <a href="#embedded-objects" class="md-nav__link">
1976     Embedded Objects
1977   </a>
1978
1979 </li>
1980
1981           <li class="md-nav__item">
1982   <a href="#rendering-the-message" class="md-nav__link">
1983     Rendering the Message
1984   </a>
1985
1986     <nav class="md-nav" aria-label="Rendering the Message">
1987       <ul class="md-nav__list">
1988
1989           <li class="md-nav__item">
1990   <a href="#simplified-output" class="md-nav__link">
1991     Simplified Output
1992   </a>
1993
1994 </li>
1995
1996           <li class="md-nav__item">
1997   <a href="#plaintext-output" class="md-nav__link">
1998     Plaintext Output
1999   </a>
2000
2001 </li>
2002
2003       </ul>
2004     </nav>
2005
2006 </li>
2007
2008           <li class="md-nav__item">
2009   <a href="#rebuilding-data" class="md-nav__link">
2010     Rebuilding Data
2011   </a>
2012
2013     <nav class="md-nav" aria-label="Rebuilding Data">
2014       <ul class="md-nav__list">
2015
2016           <li class="md-nav__item">
2017   <a href="#converting-from-bbcode" class="md-nav__link">
2018     Converting from BBCode
2019   </a>
2020
2021 </li>
2022
2023           <li class="md-nav__item">
2024   <a href="#extracting-embedded-objects" class="md-nav__link">
2025     Extracting Embedded Objects
2026   </a>
2027
2028 </li>
2029
2030       </ul>
2031     </nav>
2032
2033 </li>
2034
2035       </ul>
2036     </nav>
2037
2038 </li>
2039
2040         <li class="md-nav__item">
2041   <a href="#breadcrumbs-page-location" class="md-nav__link">
2042     Breadcrumbs / Page Location
2043   </a>
2044
2045 </li>
2046
2047         <li class="md-nav__item">
2048   <a href="#pages-and-forms" class="md-nav__link">
2049     Pages and Forms
2050   </a>
2051
2052 </li>
2053
2054         <li class="md-nav__item">
2055   <a href="#search" class="md-nav__link">
2056     Search
2057   </a>
2058
2059     <nav class="md-nav" aria-label="Search">
2060       <ul class="md-nav__list">
2061
2062           <li class="md-nav__item">
2063   <a href="#isearchableobjecttype" class="md-nav__link">
2064     ISearchableObjectType
2065   </a>
2066
2067 </li>
2068
2069           <li class="md-nav__item">
2070   <a href="#searchindexmanager" class="md-nav__link">
2071     SearchIndexManager
2072   </a>
2073
2074 </li>
2075
2076       </ul>
2077     </nav>
2078
2079 </li>
2080
2081     </ul>
2082
2083 </nav>
2084                   </div>
2085                 </div>
2086               </div>
2087
2088
2089           <div class="md-content" data-md-component="content">
2090             <article class="md-content__inner md-typeset">
2091
2092
2093                   <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">
2094                     <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>
2095                   </a>
2096
2097
2098                 <h1 id="wcf-21x-php">WCF 2.1.x - PHP<a class="headerlink" href="#wcf-21x-php" title="Permanent link">#</a></h1>
2099 <h2 id="message-processing">Message Processing<a class="headerlink" href="#message-processing" title="Permanent link">#</a></h2>
2100 <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>
2101 <h3 id="input-processing-for-storage">Input Processing for Storage<a class="headerlink" href="#input-processing-for-storage" title="Permanent link">#</a></h3>
2102 <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>
2103 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2104 <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>
2105 <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>
2106 <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>
2107 </code></pre></div>
2108 <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>
2109 <h3 id="embedded-objects">Embedded Objects<a class="headerlink" href="#embedded-objects" title="Permanent link">#</a></h3>
2110 <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>
2111 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2112 <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>
2113 <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>
2114 <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>
2115
2116 <span class="c1">// at this point the message is saved to database and the created object</span>
2117 <span class="c1">// `$example` is a `DatabaseObject` with the id column `$exampleID`</span>
2118
2119 <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>
2120 <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>
2121     <span class="c1">// there is at least one embedded object, this is also the point at which you</span>
2122     <span class="c1">// would set `hasEmbeddedObjects` to true (if implemented by your type)</span>
2123     <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>
2124 <span class="p">}</span>
2125 </code></pre></div>
2126 <h3 id="rendering-the-message">Rendering the Message<a class="headerlink" href="#rendering-the-message" title="Permanent link">#</a></h3>
2127 <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>
2128 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2129 <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>
2130 <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>
2131 <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>
2132 </code></pre></div>
2133 <h4 id="simplified-output">Simplified Output<a class="headerlink" href="#simplified-output" title="Permanent link">#</a></h4>
2134 <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>
2135 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2136 <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>
2137 <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>
2138 <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>
2139 </code></pre></div>
2140 <h4 id="plaintext-output">Plaintext Output<a class="headerlink" href="#plaintext-output" title="Permanent link">#</a></h4>
2141 <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>
2142 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2143 <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>
2144 <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>
2145 <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>
2146 </code></pre></div>
2147 <h3 id="rebuilding-data">Rebuilding Data<a class="headerlink" href="#rebuilding-data" title="Permanent link">#</a></h3>
2148 <h4 id="converting-from-bbcode">Converting from BBCode<a class="headerlink" href="#converting-from-bbcode" title="Permanent link">#</a></h4>
2149 <div class="admonition warning">
2150 <p class="admonition-title">Enabling message conversion for HTML messages is undefined and yields unexpected results.</p>
2151 </div>
2152 <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>
2153 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2154 <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>
2155 <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>
2156 <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>
2157 </code></pre></div>
2158 <h4 id="extracting-embedded-objects">Extracting Embedded Objects<a class="headerlink" href="#extracting-embedded-objects" title="Permanent link">#</a></h4>
2159 <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>
2160 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2161 <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>
2162 <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>
2163
2164 <span class="c1">// invoke `MessageEmbeddedObjectManager::registerObjects` here</span>
2165 </code></pre></div>
2166 <h2 id="breadcrumbs-page-location">Breadcrumbs / Page Location<a class="headerlink" href="#breadcrumbs-page-location" title="Permanent link">#</a></h2>
2167 <div class="admonition warning">
2168 <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>
2169 </div>
2170 <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>
2171 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2172 <span class="c1">// before</span>
2173 <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>
2174
2175 <span class="c1">// after</span>
2176 <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>
2177 </code></pre></div>
2178 <h2 id="pages-and-forms">Pages and Forms<a class="headerlink" href="#pages-and-forms" title="Permanent link">#</a></h2>
2179 <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>
2180 <h2 id="search">Search<a class="headerlink" href="#search" title="Permanent link">#</a></h2>
2181 <h3 id="isearchableobjecttype">ISearchableObjectType<a class="headerlink" href="#isearchableobjecttype" title="Permanent link">#</a></h3>
2182 <p>Added the <code>setLocation()</code> method that is used to set the current page location based on the search result.</p>
2183 <h3 id="searchindexmanager">SearchIndexManager<a class="headerlink" href="#searchindexmanager" title="Permanent link">#</a></h3>
2184 <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>
2185
2186
2187
2188
2189 <hr>
2190 <div class="md-source-date">
2191   <small>
2192
2193       Last update: 2021-01-08
2194
2195   </small>
2196 </div>
2197
2198
2199
2200
2201
2202
2203
2204
2205             </article>
2206           </div>
2207         </div>
2208
2209       </main>
2210
2211
2212 <footer class="md-footer">
2213
2214     <nav class="md-footer__inner md-grid" aria-label="Footer">
2215
2216         <a href="../../wsc30/package/" class="md-footer__link md-footer__link--prev" rel="prev">
2217           <div class="md-footer__button md-icon">
2218             <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>
2219           </div>
2220           <div class="md-footer__title">
2221             <div class="md-ellipsis">
2222               <span class="md-footer__direction">
2223                 Previous
2224               </span>
2225               Package Components
2226             </div>
2227           </div>
2228         </a>
2229
2230
2231         <a href="../templates/" class="md-footer__link md-footer__link--next" rel="next">
2232           <div class="md-footer__title">
2233             <div class="md-ellipsis">
2234               <span class="md-footer__direction">
2235                 Next
2236               </span>
2237               Templates
2238             </div>
2239           </div>
2240           <div class="md-footer__button md-icon">
2241             <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>
2242           </div>
2243         </a>
2244
2245     </nav>
2246
2247   <div class="md-footer-meta md-typeset">
2248     <div class="md-footer-meta__inner md-grid">
2249       <div class="md-footer-copyright">
2250
2251           <div class="md-footer-copyright__highlight">
2252             Copyright © 2020 WoltLab GmbH
2253           </div>
2254
2255         Made with
2256         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2257           Material for MkDocs
2258         </a>
2259
2260       </div>
2261       <div class="md-footer-copyright">
2262         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2263         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2264 </div>
2265     </div>
2266   </div>
2267 </footer>
2268
2269     </div>
2270     <div class="md-dialog" data-md-component="dialog">
2271       <div class="md-dialog__inner md-typeset"></div>
2272     </div>
2273     <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>
2274
2275
2276       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2277
2278
2279   </body>
2280 </html>