6.0/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         <link rel="canonical" href="https://docs.woltlab.com/6.0/migration/wcf21/php/">
  12
  13
  14         <link rel="prev" href="../../wsc30/package/">
  15
  16
  17         <link rel="next" href="../templates/">
  18
  19       <link rel="icon" href="../../../assets/default.favicon.ico">
  20       <meta name="generator" content="mkdocs-1.5.1, mkdocs-material-9.1.21">
  21
  22
  23
  24         <title>PHP API - WoltLab Suite Documentation</title>
  25
  26
  27
  28       <link rel="stylesheet" href="../../../assets/stylesheets/main.eebd395e.min.css">
  29
  30
  31         <link rel="stylesheet" href="../../../assets/stylesheets/palette.ecc896b0.min.css">
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  42
  43     <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  44
  45
  46
  47
  48
  49
  50   </head>
  51
  52
  53
  54
  55
  56
  57
  58     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  59
  60
  61
  62     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  63     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  64     <label class="md-overlay" for="__drawer"></label>
  65     <div data-md-component="skip">
  66
  67
  68         <a href="#wcf-21x-php" class="md-skip">
  69           Skip to content
  70         </a>
  71
  72     </div>
  73     <div data-md-component="announce">
  74
  75         <aside class="md-banner">
  76           <div class="md-banner__inner md-grid md-typeset">
  77
  78
  79     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  80
  81           </div>
  82
  83         </aside>
  84
  85     </div>
  86
  87       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  88
  89       </div>
  90
  91
  92
  93
  94
  95
  96 <header class="md-header md-header--shadow" data-md-component="header">
  97   <nav class="md-header__inner md-grid" aria-label="Header">
  98     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  99
 100   <img src="../../../assets/logo.png" alt="logo">
 101
 102     </a>
 103     <label class="md-header__button md-icon" for="__drawer">
 104       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 105     </label>
 106     <div class="md-header__title" data-md-component="header-title">
 107       <div class="md-header__ellipsis">
 108         <div class="md-header__topic">
 109           <span class="md-ellipsis">
 110             WoltLab Suite Documentation
 111           </span>
 112         </div>
 113         <div class="md-header__topic" data-md-component="header-topic">
 114           <span class="md-ellipsis">
 115
 116               PHP API
 117
 118           </span>
 119         </div>
 120       </div>
 121     </div>
 122
 123
 124
 125
 126
 127       <label class="md-header__button md-icon" for="__search">
 128         <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>
 129       </label>
 130       <div class="md-search" data-md-component="search" role="dialog">
 131   <label class="md-search__overlay" for="__search"></label>
 132   <div class="md-search__inner" role="search">
 133     <form class="md-search__form" name="search">
 134       <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" required>
 135       <label class="md-search__icon md-icon" for="__search">
 136         <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>
 137         <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>
 138       </label>
 139       <nav class="md-search__options" aria-label="Search">
 140
 141         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 142           <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>
 143         </button>
 144       </nav>
 145
 146     </form>
 147     <div class="md-search__output">
 148       <div class="md-search__scrollwrap" data-md-scrollfix>
 149         <div class="md-search-result" data-md-component="search-result">
 150           <div class="md-search-result__meta">
 151             Initializing search
 152           </div>
 153           <ol class="md-search-result__list" role="presentation"></ol>
 154         </div>
 155       </div>
 156     </div>
 157   </div>
 158 </div>
 159
 160
 161       <div class="md-header__source">
 162         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 163   <div class="md-source__icon md-icon">
 164
 165     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
 166   </div>
 167   <div class="md-source__repository">
 168     GitHub
 169   </div>
 170 </a>
 171       </div>
 172
 173   </nav>
 174
 175 </header>
 176
 177     <div class="md-container" data-md-component="container">
 178
 179
 180
 181
 182
 183
 184       <main class="md-main" data-md-component="main">
 185         <div class="md-main__inner md-grid">
 186
 187
 188
 189               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 190                 <div class="md-sidebar__scrollwrap">
 191                   <div class="md-sidebar__inner">
 192
 193
 194
 195 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 196   <label class="md-nav__title" for="__drawer">
 197     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 198
 199   <img src="../../../assets/logo.png" alt="logo">
 200
 201     </a>
 202     WoltLab Suite Documentation
 203   </label>
 204
 205     <div class="md-nav__source">
 206       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 207   <div class="md-source__icon md-icon">
 208
 209     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
 210   </div>
 211   <div class="md-source__repository">
 212     GitHub
 213   </div>
 214 </a>
 215     </div>
 216
 217   <ul class="md-nav__list" data-md-scrollfix>
 218
 219
 220
 221
 222
 223
 224
 225
 226     <li class="md-nav__item">
 227       <a href="../../../getting-started/" class="md-nav__link">
 228         Getting Started
 229       </a>
 230     </li>
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242     <li class="md-nav__item md-nav__item--nested">
 243
 244
 245
 246
 247       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 248
 249
 250
 251         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 252           PHP API
 253           <span class="md-nav__icon md-icon"></span>
 254         </label>
 255
 256       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 257         <label class="md-nav__title" for="__nav_2">
 258           <span class="md-nav__icon md-icon"></span>
 259           PHP API
 260         </label>
 261         <ul class="md-nav__list" data-md-scrollfix>
 262
 263
 264
 265
 266
 267
 268     <li class="md-nav__item">
 269       <a href="../../../php/pages/" class="md-nav__link">
 270         Pages
 271       </a>
 272     </li>
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282     <li class="md-nav__item">
 283       <a href="../../../php/database-objects/" class="md-nav__link">
 284         Database Objects
 285       </a>
 286     </li>
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296     <li class="md-nav__item">
 297       <a href="../../../php/database-access/" class="md-nav__link">
 298         Database Access
 299       </a>
 300     </li>
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item">
 311       <a href="../../../php/exceptions/" class="md-nav__link">
 312         Exceptions
 313       </a>
 314     </li>
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325     <li class="md-nav__item md-nav__item--nested">
 326
 327
 328
 329
 330       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 331
 332
 333
 334         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 335           API
 336           <span class="md-nav__icon md-icon"></span>
 337         </label>
 338
 339       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 340         <label class="md-nav__title" for="__nav_2_5">
 341           <span class="md-nav__icon md-icon"></span>
 342           API
 343         </label>
 344         <ul class="md-nav__list" data-md-scrollfix>
 345
 346
 347
 348
 349
 350
 351
 352     <li class="md-nav__item md-nav__item--nested">
 353
 354
 355
 356
 357       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 358
 359
 360
 361         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 362           Caches
 363           <span class="md-nav__icon md-icon"></span>
 364         </label>
 365
 366       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 367         <label class="md-nav__title" for="__nav_2_5_1">
 368           <span class="md-nav__icon md-icon"></span>
 369           Caches
 370         </label>
 371         <ul class="md-nav__list" data-md-scrollfix>
 372
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../../php/api/caches/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392     <li class="md-nav__item">
 393       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 394         Persistent Caches
 395       </a>
 396     </li>
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406     <li class="md-nav__item">
 407       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 408         Runtime Caches
 409       </a>
 410     </li>
 411
 412
 413
 414
 415         </ul>
 416       </nav>
 417     </li>
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427     <li class="md-nav__item">
 428       <a href="../../../php/api/comments/" class="md-nav__link">
 429         Comments
 430       </a>
 431     </li>
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 443         Cronjobs
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455     <li class="md-nav__item">
 456       <a href="../../../php/api/events/" class="md-nav__link">
 457         Events
 458       </a>
 459     </li>
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470     <li class="md-nav__item md-nav__item--nested">
 471
 472
 473
 474
 475       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 476
 477
 478
 479         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 480           Form Builder
 481           <span class="md-nav__icon md-icon"></span>
 482         </label>
 483
 484       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 485         <label class="md-nav__title" for="__nav_2_5_5">
 486           <span class="md-nav__icon md-icon"></span>
 487           Form Builder
 488         </label>
 489         <ul class="md-nav__list" data-md-scrollfix>
 490
 491
 492
 493
 494
 495
 496     <li class="md-nav__item">
 497       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 498         Overview
 499       </a>
 500     </li>
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 512         Structure
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524     <li class="md-nav__item">
 525       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 526         Fields
 527       </a>
 528     </li>
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538     <li class="md-nav__item">
 539       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 540         Validation and Data
 541       </a>
 542     </li>
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552     <li class="md-nav__item">
 553       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 554         Dependencies
 555       </a>
 556     </li>
 557
 558
 559
 560
 561         </ul>
 562       </nav>
 563     </li>
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 575         Package Installation Plugins
 576       </a>
 577     </li>
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587     <li class="md-nav__item">
 588       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 589         User Activity Points
 590       </a>
 591     </li>
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601     <li class="md-nav__item">
 602       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 603         User Notifications
 604       </a>
 605     </li>
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 617         Sitemaps
 618       </a>
 619     </li>
 620
 621
 622
 623
 624         </ul>
 625       </nav>
 626     </li>
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636     <li class="md-nav__item">
 637       <a href="../../../php/code-style/" class="md-nav__link">
 638         Code Style
 639       </a>
 640     </li>
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650     <li class="md-nav__item">
 651       <a href="../../../php/apps/" class="md-nav__link">
 652         Apps
 653       </a>
 654     </li>
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664     <li class="md-nav__item">
 665       <a href="../../../php/gdpr/" class="md-nav__link">
 666         GDPR
 667       </a>
 668     </li>
 669
 670
 671
 672
 673         </ul>
 674       </nav>
 675     </li>
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item md-nav__item--nested">
 688
 689
 690
 691
 692       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 693
 694
 695
 696         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 697           Languages, Templates & CSS
 698           <span class="md-nav__icon md-icon"></span>
 699         </label>
 700
 701       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 702         <label class="md-nav__title" for="__nav_3">
 703           <span class="md-nav__icon md-icon"></span>
 704           Languages, Templates & CSS
 705         </label>
 706         <ul class="md-nav__list" data-md-scrollfix>
 707
 708
 709
 710
 711
 712
 713     <li class="md-nav__item">
 714       <a href="../../../view/languages/" class="md-nav__link">
 715         Languages
 716       </a>
 717     </li>
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727     <li class="md-nav__item">
 728       <a href="../../../view/templates/" class="md-nav__link">
 729         Templates
 730       </a>
 731     </li>
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741     <li class="md-nav__item">
 742       <a href="../../../view/template-modifiers/" class="md-nav__link">
 743         Template Modifiers
 744       </a>
 745     </li>
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755     <li class="md-nav__item">
 756       <a href="../../../view/template-plugins/" class="md-nav__link">
 757         Template Plugins
 758       </a>
 759     </li>
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769     <li class="md-nav__item">
 770       <a href="../../../view/css/" class="md-nav__link">
 771         CSS
 772       </a>
 773     </li>
 774
 775
 776
 777
 778         </ul>
 779       </nav>
 780     </li>
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792     <li class="md-nav__item md-nav__item--nested">
 793
 794
 795
 796
 797       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
 798
 799
 800
 801         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
 802           TypeScript and JavaScript API
 803           <span class="md-nav__icon md-icon"></span>
 804         </label>
 805
 806       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
 807         <label class="md-nav__title" for="__nav_4">
 808           <span class="md-nav__icon md-icon"></span>
 809           TypeScript and JavaScript API
 810         </label>
 811         <ul class="md-nav__list" data-md-scrollfix>
 812
 813
 814
 815
 816
 817
 818     <li class="md-nav__item">
 819       <a href="../../../javascript/general-usage/" class="md-nav__link">
 820         General Usage
 821       </a>
 822     </li>
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832     <li class="md-nav__item">
 833       <a href="../../../javascript/typescript/" class="md-nav__link">
 834         TypeScript
 835       </a>
 836     </li>
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847     <li class="md-nav__item md-nav__item--nested">
 848
 849
 850
 851
 852       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
 853
 854
 855
 856         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
 857           Components
 858           <span class="md-nav__icon md-icon"></span>
 859         </label>
 860
 861       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
 862         <label class="md-nav__title" for="__nav_4_3">
 863           <span class="md-nav__icon md-icon"></span>
 864           Components
 865         </label>
 866         <ul class="md-nav__list" data-md-scrollfix>
 867
 868
 869
 870
 871
 872
 873     <li class="md-nav__item">
 874       <a href="../../../javascript/components_ckeditor5/" class="md-nav__link">
 875         CKEditor 5
 876       </a>
 877     </li>
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887     <li class="md-nav__item">
 888       <a href="../../../javascript/components_confirmation/" class="md-nav__link">
 889         Confirmation
 890       </a>
 891     </li>
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901     <li class="md-nav__item">
 902       <a href="../../../javascript/components_dialog/" class="md-nav__link">
 903         Dialog
 904       </a>
 905     </li>
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915     <li class="md-nav__item">
 916       <a href="../../../javascript/components_google_maps/" class="md-nav__link">
 917         Google Maps
 918       </a>
 919     </li>
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929     <li class="md-nav__item">
 930       <a href="../../../javascript/components_pagination/" class="md-nav__link">
 931         Pagination
 932       </a>
 933     </li>
 934
 935
 936
 937
 938         </ul>
 939       </nav>
 940     </li>
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951     <li class="md-nav__item md-nav__item--nested">
 952
 953
 954
 955
 956       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
 957
 958
 959
 960         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
 961           New API
 962           <span class="md-nav__icon md-icon"></span>
 963         </label>
 964
 965       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
 966         <label class="md-nav__title" for="__nav_4_4">
 967           <span class="md-nav__icon md-icon"></span>
 968           New API
 969         </label>
 970         <ul class="md-nav__list" data-md-scrollfix>
 971
 972
 973
 974
 975
 976
 977     <li class="md-nav__item">
 978       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 979         Writing a module
 980       </a>
 981     </li>
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991     <li class="md-nav__item">
 992       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 993         Core Functions
 994       </a>
 995     </li>
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005     <li class="md-nav__item">
1006       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
1007         DOM
1008       </a>
1009     </li>
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019     <li class="md-nav__item">
1020       <a href="../../../javascript/new-api_events/" class="md-nav__link">
1021         Event Handling
1022       </a>
1023     </li>
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033     <li class="md-nav__item">
1034       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1035         Ajax
1036       </a>
1037     </li>
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047     <li class="md-nav__item">
1048       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1049         Dialogs
1050       </a>
1051     </li>
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061     <li class="md-nav__item">
1062       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1063         Browser and Screen Sizes
1064       </a>
1065     </li>
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075     <li class="md-nav__item">
1076       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1077         User Interface
1078       </a>
1079     </li>
1080
1081
1082
1083
1084         </ul>
1085       </nav>
1086     </li>
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096     <li class="md-nav__item">
1097       <a href="../../../javascript/legacy-api/" class="md-nav__link">
1098         Legacy API
1099       </a>
1100     </li>
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110     <li class="md-nav__item">
1111       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1112         Code Snippets
1113       </a>
1114     </li>
1115
1116
1117
1118
1119         </ul>
1120       </nav>
1121     </li>
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133     <li class="md-nav__item md-nav__item--nested">
1134
1135
1136
1137
1138       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1139
1140
1141
1142         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1143           Package Components
1144           <span class="md-nav__icon md-icon"></span>
1145         </label>
1146
1147       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1148         <label class="md-nav__title" for="__nav_5">
1149           <span class="md-nav__icon md-icon"></span>
1150           Package Components
1151         </label>
1152         <ul class="md-nav__list" data-md-scrollfix>
1153
1154
1155
1156
1157
1158
1159     <li class="md-nav__item">
1160       <a href="../../../package/package-xml/" class="md-nav__link">
1161         package.xml
1162       </a>
1163     </li>
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174     <li class="md-nav__item md-nav__item--nested">
1175
1176
1177
1178
1179       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1180
1181
1182
1183         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1184           PIPs
1185           <span class="md-nav__icon md-icon"></span>
1186         </label>
1187
1188       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1189         <label class="md-nav__title" for="__nav_5_2">
1190           <span class="md-nav__icon md-icon"></span>
1191           PIPs
1192         </label>
1193         <ul class="md-nav__list" data-md-scrollfix>
1194
1195
1196
1197
1198
1199
1200     <li class="md-nav__item">
1201       <a href="../../../package/pip/" class="md-nav__link">
1202         Overview
1203       </a>
1204     </li>
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214     <li class="md-nav__item">
1215       <a href="../../../package/pip/acl-option/" class="md-nav__link">
1216         aclOption
1217       </a>
1218     </li>
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228     <li class="md-nav__item">
1229       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
1230         acpMenu
1231       </a>
1232     </li>
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242     <li class="md-nav__item">
1243       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
1244         acpSearchProvider
1245       </a>
1246     </li>
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256     <li class="md-nav__item">
1257       <a href="../../../package/pip/acp-template/" class="md-nav__link">
1258         acpTemplate
1259       </a>
1260     </li>
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270     <li class="md-nav__item">
1271       <a href="../../../package/pip/acp-template-delete/" class="md-nav__link">
1272         acpTemplateDelete
1273       </a>
1274     </li>
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284     <li class="md-nav__item">
1285       <a href="../../../package/pip/bbcode/" class="md-nav__link">
1286         bbcode
1287       </a>
1288     </li>
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298     <li class="md-nav__item">
1299       <a href="../../../package/pip/box/" class="md-nav__link">
1300         box
1301       </a>
1302     </li>
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312     <li class="md-nav__item">
1313       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1314         clipboardAction
1315       </a>
1316     </li>
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326     <li class="md-nav__item">
1327       <a href="../../../package/pip/core-object/" class="md-nav__link">
1328         coreObject
1329       </a>
1330     </li>
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340     <li class="md-nav__item">
1341       <a href="../../../package/pip/cronjob/" class="md-nav__link">
1342         cronjob
1343       </a>
1344     </li>
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354     <li class="md-nav__item">
1355       <a href="../../../package/pip/database/" class="md-nav__link">
1356         database
1357       </a>
1358     </li>
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368     <li class="md-nav__item">
1369       <a href="../../../package/pip/event-listener/" class="md-nav__link">
1370         eventListener
1371       </a>
1372     </li>
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382     <li class="md-nav__item">
1383       <a href="../../../package/pip/file/" class="md-nav__link">
1384         file
1385       </a>
1386     </li>
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396     <li class="md-nav__item">
1397       <a href="../../../package/pip/file-delete/" class="md-nav__link">
1398         fileDelete
1399       </a>
1400     </li>
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410     <li class="md-nav__item">
1411       <a href="../../../package/pip/language/" class="md-nav__link">
1412         language
1413       </a>
1414     </li>
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424     <li class="md-nav__item">
1425       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1426         mediaProvider
1427       </a>
1428     </li>
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438     <li class="md-nav__item">
1439       <a href="../../../package/pip/menu/" class="md-nav__link">
1440         menu
1441       </a>
1442     </li>
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452     <li class="md-nav__item">
1453       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1454         menuItem
1455       </a>
1456     </li>
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466     <li class="md-nav__item">
1467       <a href="../../../package/pip/object-type/" class="md-nav__link">
1468         objectType
1469       </a>
1470     </li>
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480     <li class="md-nav__item">
1481       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1482         objectTypeDefinition
1483       </a>
1484     </li>
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494     <li class="md-nav__item">
1495       <a href="../../../package/pip/option/" class="md-nav__link">
1496         option
1497       </a>
1498     </li>
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508     <li class="md-nav__item">
1509       <a href="../../../package/pip/page/" class="md-nav__link">
1510         page
1511       </a>
1512     </li>
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522     <li class="md-nav__item">
1523       <a href="../../../package/pip/pip/" class="md-nav__link">
1524         pip
1525       </a>
1526     </li>
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536     <li class="md-nav__item">
1537       <a href="../../../package/pip/script/" class="md-nav__link">
1538         script
1539       </a>
1540     </li>
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550     <li class="md-nav__item">
1551       <a href="../../../package/pip/smiley/" class="md-nav__link">
1552         smiley
1553       </a>
1554     </li>
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564     <li class="md-nav__item">
1565       <a href="../../../package/pip/sql/" class="md-nav__link">
1566         sql
1567       </a>
1568     </li>
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578     <li class="md-nav__item">
1579       <a href="../../../package/pip/style/" class="md-nav__link">
1580         style
1581       </a>
1582     </li>
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592     <li class="md-nav__item">
1593       <a href="../../../package/pip/template/" class="md-nav__link">
1594         template
1595       </a>
1596     </li>
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606     <li class="md-nav__item">
1607       <a href="../../../package/pip/template-delete/" class="md-nav__link">
1608         templateDelete
1609       </a>
1610     </li>
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620     <li class="md-nav__item">
1621       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1622         templateListener
1623       </a>
1624     </li>
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634     <li class="md-nav__item">
1635       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1636         userGroupOption
1637       </a>
1638     </li>
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648     <li class="md-nav__item">
1649       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1650         userMenu
1651       </a>
1652     </li>
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662     <li class="md-nav__item">
1663       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1664         userNotificationEvent
1665       </a>
1666     </li>
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676     <li class="md-nav__item">
1677       <a href="../../../package/pip/user-option/" class="md-nav__link">
1678         userOption
1679       </a>
1680     </li>
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690     <li class="md-nav__item">
1691       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1692         userProfileMenu
1693       </a>
1694     </li>
1695
1696
1697
1698
1699         </ul>
1700       </nav>
1701     </li>
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711     <li class="md-nav__item">
1712       <a href="../../../package/database-php-api/" class="md-nav__link">
1713         Database PHP API
1714       </a>
1715     </li>
1716
1717
1718
1719
1720         </ul>
1721       </nav>
1722     </li>
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1737
1738
1739
1740
1741       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
1742
1743
1744
1745         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1746           Migration
1747           <span class="md-nav__icon md-icon"></span>
1748         </label>
1749
1750       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
1751         <label class="md-nav__title" for="__nav_6">
1752           <span class="md-nav__icon md-icon"></span>
1753           Migration
1754         </label>
1755         <ul class="md-nav__list" data-md-scrollfix>
1756
1757
1758
1759
1760
1761
1762
1763     <li class="md-nav__item md-nav__item--nested">
1764
1765
1766
1767
1768       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1769
1770
1771
1772         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1773           From WoltLab Suite 5.5
1774           <span class="md-nav__icon md-icon"></span>
1775         </label>
1776
1777       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1778         <label class="md-nav__title" for="__nav_6_1">
1779           <span class="md-nav__icon md-icon"></span>
1780           From WoltLab Suite 5.5
1781         </label>
1782         <ul class="md-nav__list" data-md-scrollfix>
1783
1784
1785
1786
1787
1788
1789     <li class="md-nav__item">
1790       <a href="../../wsc55/php/" class="md-nav__link">
1791         PHP API
1792       </a>
1793     </li>
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803     <li class="md-nav__item">
1804       <a href="../../wsc55/javascript/" class="md-nav__link">
1805         TypeScript and JavaScript
1806       </a>
1807     </li>
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817     <li class="md-nav__item">
1818       <a href="../../wsc55/templates/" class="md-nav__link">
1819         Templates
1820       </a>
1821     </li>
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831     <li class="md-nav__item">
1832       <a href="../../wsc55/icons/" class="md-nav__link">
1833         Icons
1834       </a>
1835     </li>
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845     <li class="md-nav__item">
1846       <a href="../../wsc55/dialogs/" class="md-nav__link">
1847         Dialogs
1848       </a>
1849     </li>
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859     <li class="md-nav__item">
1860       <a href="../../wsc55/libraries/" class="md-nav__link">
1861         Third Party Libraries
1862       </a>
1863     </li>
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873     <li class="md-nav__item">
1874       <a href="../../wsc55/deprecations_removals/" class="md-nav__link">
1875         Deprecations and Removals
1876       </a>
1877     </li>
1878
1879
1880
1881
1882         </ul>
1883       </nav>
1884     </li>
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895     <li class="md-nav__item md-nav__item--nested">
1896
1897
1898
1899
1900       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
1901
1902
1903
1904         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
1905           From WoltLab Suite 5.4
1906           <span class="md-nav__icon md-icon"></span>
1907         </label>
1908
1909       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
1910         <label class="md-nav__title" for="__nav_6_2">
1911           <span class="md-nav__icon md-icon"></span>
1912           From WoltLab Suite 5.4
1913         </label>
1914         <ul class="md-nav__list" data-md-scrollfix>
1915
1916
1917
1918
1919
1920
1921     <li class="md-nav__item">
1922       <a href="../../wsc54/php/" class="md-nav__link">
1923         PHP API
1924       </a>
1925     </li>
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935     <li class="md-nav__item">
1936       <a href="../../wsc54/javascript/" class="md-nav__link">
1937         TypeScript and JavaScript
1938       </a>
1939     </li>
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949     <li class="md-nav__item">
1950       <a href="../../wsc54/templates/" class="md-nav__link">
1951         Templates
1952       </a>
1953     </li>
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963     <li class="md-nav__item">
1964       <a href="../../wsc54/libraries/" class="md-nav__link">
1965         Third Party Libraries
1966       </a>
1967     </li>
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977     <li class="md-nav__item">
1978       <a href="../../wsc54/deprecations_removals/" class="md-nav__link">
1979         Deprecations and Removals
1980       </a>
1981     </li>
1982
1983
1984
1985
1986         </ul>
1987       </nav>
1988     </li>
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999     <li class="md-nav__item md-nav__item--nested">
2000
2001
2002
2003
2004       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2005
2006
2007
2008         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2009           From WoltLab Suite 5.3
2010           <span class="md-nav__icon md-icon"></span>
2011         </label>
2012
2013       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2014         <label class="md-nav__title" for="__nav_6_3">
2015           <span class="md-nav__icon md-icon"></span>
2016           From WoltLab Suite 5.3
2017         </label>
2018         <ul class="md-nav__list" data-md-scrollfix>
2019
2020
2021
2022
2023
2024
2025     <li class="md-nav__item">
2026       <a href="../../wsc53/php/" class="md-nav__link">
2027         PHP API
2028       </a>
2029     </li>
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039     <li class="md-nav__item">
2040       <a href="../../wsc53/session/" class="md-nav__link">
2041         Session Handling and Authentication
2042       </a>
2043     </li>
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053     <li class="md-nav__item">
2054       <a href="../../wsc53/javascript/" class="md-nav__link">
2055         TypeScript and JavaScript
2056       </a>
2057     </li>
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067     <li class="md-nav__item">
2068       <a href="../../wsc53/templates/" class="md-nav__link">
2069         Templates
2070       </a>
2071     </li>
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081     <li class="md-nav__item">
2082       <a href="../../wsc53/libraries/" class="md-nav__link">
2083         Third Party Libraries
2084       </a>
2085     </li>
2086
2087
2088
2089
2090         </ul>
2091       </nav>
2092     </li>
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103     <li class="md-nav__item md-nav__item--nested">
2104
2105
2106
2107
2108       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2109
2110
2111
2112         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2113           From WoltLab Suite 5.2
2114           <span class="md-nav__icon md-icon"></span>
2115         </label>
2116
2117       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2118         <label class="md-nav__title" for="__nav_6_4">
2119           <span class="md-nav__icon md-icon"></span>
2120           From WoltLab Suite 5.2
2121         </label>
2122         <ul class="md-nav__list" data-md-scrollfix>
2123
2124
2125
2126
2127
2128
2129     <li class="md-nav__item">
2130       <a href="../../wsc52/php/" class="md-nav__link">
2131         PHP API
2132       </a>
2133     </li>
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143     <li class="md-nav__item">
2144       <a href="../../wsc52/templates/" class="md-nav__link">
2145         Templates and Languages
2146       </a>
2147     </li>
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157     <li class="md-nav__item">
2158       <a href="../../wsc52/libraries/" class="md-nav__link">
2159         Third Party Libraries
2160       </a>
2161     </li>
2162
2163
2164
2165
2166         </ul>
2167       </nav>
2168     </li>
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179     <li class="md-nav__item md-nav__item--nested">
2180
2181
2182
2183
2184       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2185
2186
2187
2188         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2189           From WoltLab Suite 3.1
2190           <span class="md-nav__icon md-icon"></span>
2191         </label>
2192
2193       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2194         <label class="md-nav__title" for="__nav_6_5">
2195           <span class="md-nav__icon md-icon"></span>
2196           From WoltLab Suite 3.1
2197         </label>
2198         <ul class="md-nav__list" data-md-scrollfix>
2199
2200
2201
2202
2203
2204
2205     <li class="md-nav__item">
2206       <a href="../../wsc31/php/" class="md-nav__link">
2207         PHP API
2208       </a>
2209     </li>
2210
2211
2212
2213
2214         </ul>
2215       </nav>
2216     </li>
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227     <li class="md-nav__item md-nav__item--nested">
2228
2229
2230
2231
2232       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2233
2234
2235
2236         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2237           From WoltLab Suite 3.0
2238           <span class="md-nav__icon md-icon"></span>
2239         </label>
2240
2241       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2242         <label class="md-nav__title" for="__nav_6_6">
2243           <span class="md-nav__icon md-icon"></span>
2244           From WoltLab Suite 3.0
2245         </label>
2246         <ul class="md-nav__list" data-md-scrollfix>
2247
2248
2249
2250
2251
2252
2253     <li class="md-nav__item">
2254       <a href="../../wsc30/php/" class="md-nav__link">
2255         PHP API
2256       </a>
2257     </li>
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267     <li class="md-nav__item">
2268       <a href="../../wsc30/javascript/" class="md-nav__link">
2269         JavaScript API
2270       </a>
2271     </li>
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281     <li class="md-nav__item">
2282       <a href="../../wsc30/templates/" class="md-nav__link">
2283         Templates
2284       </a>
2285     </li>
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295     <li class="md-nav__item">
2296       <a href="../../wsc30/css/" class="md-nav__link">
2297         CSS
2298       </a>
2299     </li>
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309     <li class="md-nav__item">
2310       <a href="../../wsc30/package/" class="md-nav__link">
2311         Package Components
2312       </a>
2313     </li>
2314
2315
2316
2317
2318         </ul>
2319       </nav>
2320     </li>
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
2334
2335
2336
2337
2338       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" checked>
2339
2340
2341
2342         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2343           From WCF 2.1
2344           <span class="md-nav__icon md-icon"></span>
2345         </label>
2346
2347       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="true">
2348         <label class="md-nav__title" for="__nav_6_7">
2349           <span class="md-nav__icon md-icon"></span>
2350           From WCF 2.1
2351         </label>
2352         <ul class="md-nav__list" data-md-scrollfix>
2353
2354
2355
2356
2357
2358
2359
2360
2361     <li class="md-nav__item md-nav__item--active">
2362
2363       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
2364
2365
2366
2367
2368
2369         <label class="md-nav__link md-nav__link--active" for="__toc">
2370           PHP API
2371           <span class="md-nav__icon md-icon"></span>
2372         </label>
2373
2374       <a href="./" class="md-nav__link md-nav__link--active">
2375         PHP API
2376       </a>
2377
2378
2379
2380 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2381
2382
2383
2384
2385
2386
2387     <label class="md-nav__title" for="__toc">
2388       <span class="md-nav__icon md-icon"></span>
2389       Table of contents
2390     </label>
2391     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2392
2393         <li class="md-nav__item">
2394   <a href="#message-processing" class="md-nav__link">
2395     Message Processing
2396   </a>
2397
2398     <nav class="md-nav" aria-label="Message Processing">
2399       <ul class="md-nav__list">
2400
2401           <li class="md-nav__item">
2402   <a href="#input-processing-for-storage" class="md-nav__link">
2403     Input Processing for Storage
2404   </a>
2405
2406 </li>
2407
2408           <li class="md-nav__item">
2409   <a href="#embedded-objects" class="md-nav__link">
2410     Embedded Objects
2411   </a>
2412
2413 </li>
2414
2415           <li class="md-nav__item">
2416   <a href="#rendering-the-message" class="md-nav__link">
2417     Rendering the Message
2418   </a>
2419
2420     <nav class="md-nav" aria-label="Rendering the Message">
2421       <ul class="md-nav__list">
2422
2423           <li class="md-nav__item">
2424   <a href="#simplified-output" class="md-nav__link">
2425     Simplified Output
2426   </a>
2427
2428 </li>
2429
2430           <li class="md-nav__item">
2431   <a href="#plaintext-output" class="md-nav__link">
2432     Plaintext Output
2433   </a>
2434
2435 </li>
2436
2437       </ul>
2438     </nav>
2439
2440 </li>
2441
2442           <li class="md-nav__item">
2443   <a href="#rebuilding-data" class="md-nav__link">
2444     Rebuilding Data
2445   </a>
2446
2447     <nav class="md-nav" aria-label="Rebuilding Data">
2448       <ul class="md-nav__list">
2449
2450           <li class="md-nav__item">
2451   <a href="#converting-from-bbcode" class="md-nav__link">
2452     Converting from BBCode
2453   </a>
2454
2455 </li>
2456
2457           <li class="md-nav__item">
2458   <a href="#extracting-embedded-objects" class="md-nav__link">
2459     Extracting Embedded Objects
2460   </a>
2461
2462 </li>
2463
2464       </ul>
2465     </nav>
2466
2467 </li>
2468
2469       </ul>
2470     </nav>
2471
2472 </li>
2473
2474         <li class="md-nav__item">
2475   <a href="#breadcrumbs-page-location" class="md-nav__link">
2476     Breadcrumbs / Page Location
2477   </a>
2478
2479 </li>
2480
2481         <li class="md-nav__item">
2482   <a href="#pages-and-forms" class="md-nav__link">
2483     Pages and Forms
2484   </a>
2485
2486 </li>
2487
2488         <li class="md-nav__item">
2489   <a href="#search" class="md-nav__link">
2490     Search
2491   </a>
2492
2493     <nav class="md-nav" aria-label="Search">
2494       <ul class="md-nav__list">
2495
2496           <li class="md-nav__item">
2497   <a href="#isearchableobjecttype" class="md-nav__link">
2498     ISearchableObjectType
2499   </a>
2500
2501 </li>
2502
2503           <li class="md-nav__item">
2504   <a href="#searchindexmanager" class="md-nav__link">
2505     SearchIndexManager
2506   </a>
2507
2508 </li>
2509
2510       </ul>
2511     </nav>
2512
2513 </li>
2514
2515     </ul>
2516
2517 </nav>
2518
2519     </li>
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529     <li class="md-nav__item">
2530       <a href="../templates/" class="md-nav__link">
2531         Templates
2532       </a>
2533     </li>
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543     <li class="md-nav__item">
2544       <a href="../css/" class="md-nav__link">
2545         CSS
2546       </a>
2547     </li>
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557     <li class="md-nav__item">
2558       <a href="../package/" class="md-nav__link">
2559         Package Components
2560       </a>
2561     </li>
2562
2563
2564
2565
2566         </ul>
2567       </nav>
2568     </li>
2569
2570
2571
2572
2573         </ul>
2574       </nav>
2575     </li>
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587     <li class="md-nav__item md-nav__item--nested">
2588
2589
2590
2591
2592       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2593
2594
2595
2596         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2597           Tutorials
2598           <span class="md-nav__icon md-icon"></span>
2599         </label>
2600
2601       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2602         <label class="md-nav__title" for="__nav_7">
2603           <span class="md-nav__icon md-icon"></span>
2604           Tutorials
2605         </label>
2606         <ul class="md-nav__list" data-md-scrollfix>
2607
2608
2609
2610
2611
2612
2613
2614     <li class="md-nav__item md-nav__item--nested">
2615
2616
2617
2618
2619       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2620
2621
2622
2623         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2624           Tutorial Series
2625           <span class="md-nav__icon md-icon"></span>
2626         </label>
2627
2628       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2629         <label class="md-nav__title" for="__nav_7_1">
2630           <span class="md-nav__icon md-icon"></span>
2631           Tutorial Series
2632         </label>
2633         <ul class="md-nav__list" data-md-scrollfix>
2634
2635
2636
2637
2638
2639
2640     <li class="md-nav__item">
2641       <a href="../../../tutorial/series/overview/" class="md-nav__link">
2642         Overview
2643       </a>
2644     </li>
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654     <li class="md-nav__item">
2655       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
2656         Part 1
2657       </a>
2658     </li>
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668     <li class="md-nav__item">
2669       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
2670         Part 2
2671       </a>
2672     </li>
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682     <li class="md-nav__item">
2683       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
2684         Part 3
2685       </a>
2686     </li>
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696     <li class="md-nav__item">
2697       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
2698         Part 4
2699       </a>
2700     </li>
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710     <li class="md-nav__item">
2711       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
2712         Part 5
2713       </a>
2714     </li>
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724     <li class="md-nav__item">
2725       <a href="../../../tutorial/series/part_6/" class="md-nav__link">
2726         Part 6
2727       </a>
2728     </li>
2729
2730
2731
2732
2733         </ul>
2734       </nav>
2735     </li>
2736
2737
2738
2739
2740         </ul>
2741       </nav>
2742     </li>
2743
2744
2745
2746   </ul>
2747 </nav>
2748                   </div>
2749                 </div>
2750               </div>
2751
2752
2753
2754               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2755                 <div class="md-sidebar__scrollwrap">
2756                   <div class="md-sidebar__inner">
2757
2758
2759 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2760
2761
2762
2763
2764
2765
2766     <label class="md-nav__title" for="__toc">
2767       <span class="md-nav__icon md-icon"></span>
2768       Table of contents
2769     </label>
2770     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2771
2772         <li class="md-nav__item">
2773   <a href="#message-processing" class="md-nav__link">
2774     Message Processing
2775   </a>
2776
2777     <nav class="md-nav" aria-label="Message Processing">
2778       <ul class="md-nav__list">
2779
2780           <li class="md-nav__item">
2781   <a href="#input-processing-for-storage" class="md-nav__link">
2782     Input Processing for Storage
2783   </a>
2784
2785 </li>
2786
2787           <li class="md-nav__item">
2788   <a href="#embedded-objects" class="md-nav__link">
2789     Embedded Objects
2790   </a>
2791
2792 </li>
2793
2794           <li class="md-nav__item">
2795   <a href="#rendering-the-message" class="md-nav__link">
2796     Rendering the Message
2797   </a>
2798
2799     <nav class="md-nav" aria-label="Rendering the Message">
2800       <ul class="md-nav__list">
2801
2802           <li class="md-nav__item">
2803   <a href="#simplified-output" class="md-nav__link">
2804     Simplified Output
2805   </a>
2806
2807 </li>
2808
2809           <li class="md-nav__item">
2810   <a href="#plaintext-output" class="md-nav__link">
2811     Plaintext Output
2812   </a>
2813
2814 </li>
2815
2816       </ul>
2817     </nav>
2818
2819 </li>
2820
2821           <li class="md-nav__item">
2822   <a href="#rebuilding-data" class="md-nav__link">
2823     Rebuilding Data
2824   </a>
2825
2826     <nav class="md-nav" aria-label="Rebuilding Data">
2827       <ul class="md-nav__list">
2828
2829           <li class="md-nav__item">
2830   <a href="#converting-from-bbcode" class="md-nav__link">
2831     Converting from BBCode
2832   </a>
2833
2834 </li>
2835
2836           <li class="md-nav__item">
2837   <a href="#extracting-embedded-objects" class="md-nav__link">
2838     Extracting Embedded Objects
2839   </a>
2840
2841 </li>
2842
2843       </ul>
2844     </nav>
2845
2846 </li>
2847
2848       </ul>
2849     </nav>
2850
2851 </li>
2852
2853         <li class="md-nav__item">
2854   <a href="#breadcrumbs-page-location" class="md-nav__link">
2855     Breadcrumbs / Page Location
2856   </a>
2857
2858 </li>
2859
2860         <li class="md-nav__item">
2861   <a href="#pages-and-forms" class="md-nav__link">
2862     Pages and Forms
2863   </a>
2864
2865 </li>
2866
2867         <li class="md-nav__item">
2868   <a href="#search" class="md-nav__link">
2869     Search
2870   </a>
2871
2872     <nav class="md-nav" aria-label="Search">
2873       <ul class="md-nav__list">
2874
2875           <li class="md-nav__item">
2876   <a href="#isearchableobjecttype" class="md-nav__link">
2877     ISearchableObjectType
2878   </a>
2879
2880 </li>
2881
2882           <li class="md-nav__item">
2883   <a href="#searchindexmanager" class="md-nav__link">
2884     SearchIndexManager
2885   </a>
2886
2887 </li>
2888
2889       </ul>
2890     </nav>
2891
2892 </li>
2893
2894     </ul>
2895
2896 </nav>
2897                   </div>
2898                 </div>
2899               </div>
2900
2901
2902
2903             <div class="md-content" data-md-component="content">
2904               <article class="md-content__inner md-typeset">
2905
2906
2907
2908
2909
2910
2911
2912 <h1 id="wcf-21x-php">WCF 2.1.x - PHP<a class="headerlink" href="#wcf-21x-php" title="Permanent link">#</a></h1>
2913 <h2 id="message-processing">Message Processing<a class="headerlink" href="#message-processing" title="Permanent link">#</a></h2>
2914 <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>
2915 <h3 id="input-processing-for-storage">Input Processing for Storage<a class="headerlink" href="#input-processing-for-storage" title="Permanent link">#</a></h3>
2916 <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>
2917 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2918 <span class="normal">2</span>
2919 <span class="normal">3</span>
2920 <span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2921 <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>
2922 <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>
2923 <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>
2924 </code></pre></div></td></tr></table></div>
2925 <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>
2926 <h3 id="embedded-objects">Embedded Objects<a class="headerlink" href="#embedded-objects" title="Permanent link">#</a></h3>
2927 <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>
2928 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2929 <span class="normal"> 2</span>
2930 <span class="normal"> 3</span>
2931 <span class="normal"> 4</span>
2932 <span class="normal"> 5</span>
2933 <span class="normal"> 6</span>
2934 <span class="normal"> 7</span>
2935 <span class="normal"> 8</span>
2936 <span class="normal"> 9</span>
2937 <span class="normal">10</span>
2938 <span class="normal">11</span>
2939 <span class="normal">12</span>
2940 <span class="normal">13</span>
2941 <span class="normal">14</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2942 <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>
2943 <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>
2944 <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>
2945
2946 <span class="c1">// at this point the message is saved to database and the created object</span>
2947 <span class="c1">// `$example` is a `DatabaseObject` with the id column `$exampleID`</span>
2948
2949 <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>
2950 <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>
2951     <span class="c1">// there is at least one embedded object, this is also the point at which you</span>
2952     <span class="c1">// would set `hasEmbeddedObjects` to true (if implemented by your type)</span>
2953     <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>
2954 <span class="p">}</span>
2955 </code></pre></div></td></tr></table></div>
2956 <h3 id="rendering-the-message">Rendering the Message<a class="headerlink" href="#rendering-the-message" title="Permanent link">#</a></h3>
2957 <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>
2958 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2959 <span class="normal">2</span>
2960 <span class="normal">3</span>
2961 <span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2962 <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>
2963 <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>
2964 <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>
2965 </code></pre></div></td></tr></table></div>
2966 <h4 id="simplified-output">Simplified Output<a class="headerlink" href="#simplified-output" title="Permanent link">#</a></h4>
2967 <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>
2968 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2969 <span class="normal">2</span>
2970 <span class="normal">3</span>
2971 <span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2972 <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>
2973 <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>
2974 <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>
2975 </code></pre></div></td></tr></table></div>
2976 <h4 id="plaintext-output">Plaintext Output<a class="headerlink" href="#plaintext-output" title="Permanent link">#</a></h4>
2977 <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>
2978 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2979 <span class="normal">2</span>
2980 <span class="normal">3</span>
2981 <span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2982 <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>
2983 <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>
2984 <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>
2985 </code></pre></div></td></tr></table></div>
2986 <h3 id="rebuilding-data">Rebuilding Data<a class="headerlink" href="#rebuilding-data" title="Permanent link">#</a></h3>
2987 <h4 id="converting-from-bbcode">Converting from BBCode<a class="headerlink" href="#converting-from-bbcode" title="Permanent link">#</a></h4>
2988 <div class="admonition warning">
2989 <p class="admonition-title">Enabling message conversion for HTML messages is undefined and yields unexpected results.</p>
2990 </div>
2991 <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>
2992 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2993 <span class="normal">2</span>
2994 <span class="normal">3</span>
2995 <span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2996 <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>
2997 <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>
2998 <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>
2999 </code></pre></div></td></tr></table></div>
3000 <h4 id="extracting-embedded-objects">Extracting Embedded Objects<a class="headerlink" href="#extracting-embedded-objects" title="Permanent link">#</a></h4>
3001 <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>
3002 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3003 <span class="normal">2</span>
3004 <span class="normal">3</span>
3005 <span class="normal">4</span>
3006 <span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3007 <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>
3008 <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>
3009
3010 <span class="c1">// invoke `MessageEmbeddedObjectManager::registerObjects` here</span>
3011 </code></pre></div></td></tr></table></div>
3012 <h2 id="breadcrumbs-page-location">Breadcrumbs / Page Location<a class="headerlink" href="#breadcrumbs-page-location" title="Permanent link">#</a></h2>
3013 <div class="admonition warning">
3014 <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>
3015 </div>
3016 <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>
3017 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
3018 <span class="normal">2</span>
3019 <span class="normal">3</span>
3020 <span class="normal">4</span>
3021 <span class="normal">5</span>
3022 <span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3023 <span class="c1">// before</span>
3024 <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>
3025
3026 <span class="c1">// after</span>
3027 <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>
3028 </code></pre></div></td></tr></table></div>
3029 <h2 id="pages-and-forms">Pages and Forms<a class="headerlink" href="#pages-and-forms" title="Permanent link">#</a></h2>
3030 <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>
3031 <h2 id="search">Search<a class="headerlink" href="#search" title="Permanent link">#</a></h2>
3032 <h3 id="isearchableobjecttype">ISearchableObjectType<a class="headerlink" href="#isearchableobjecttype" title="Permanent link">#</a></h3>
3033 <p>Added the <code>setLocation()</code> method that is used to set the current page location based on the search result.</p>
3034 <h3 id="searchindexmanager">SearchIndexManager<a class="headerlink" href="#searchindexmanager" title="Permanent link">#</a></h3>
3035 <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>
3036
3037   <hr>
3038 <div class="md-source-file">
3039   <small>
3040
3041       Last update:
3042       2021-01-08
3043
3044   </small>
3045 </div>
3046
3047
3048
3049
3050
3051
3052               </article>
3053             </div>
3054
3055
3056         </div>
3057
3058       </main>
3059
3060         <footer class="md-footer">
3061
3062   <div class="md-footer-meta md-typeset">
3063     <div class="md-footer-meta__inner md-grid">
3064       <div class="md-copyright">
3065
3066     <div class="md-copyright__highlight">
3067       Copyright © 2020 WoltLab GmbH
3068     </div>
3069
3070
3071     Made with
3072     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3073       Material for MkDocs
3074     </a>
3075
3076 </div>
3077
3078         <div class="md-copyright">
3079         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
3080         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
3081 </div>
3082
3083     </div>
3084   </div>
3085 </footer>
3086
3087     </div>
3088     <div class="md-dialog" data-md-component="dialog">
3089       <div class="md-dialog__inner md-typeset"></div>
3090     </div>
3091
3092     <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.74e28a9f.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
3093
3094
3095       <script src="../../../assets/javascripts/bundle.220ee61c.min.js"></script>
3096
3097
3098   </body>
3099 </html>