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