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