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