6.0/package/pip/acp-search-provider/index.html

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