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