3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"canonical" href=
"https://docs.woltlab.com/5.4/package/pip/acp-search-provider/">
14 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
15 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.2">
19 <title>acpSearchProvider - WoltLab Suite Documentation
</title>
23 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.6f955dcd.min.css">
26 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ef6f36e2.min.css">
30 <meta name=
"theme-color" content=
"#009485">
40 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
54 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
57 <script>function __prefix(e){return new URL(
"../../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
59 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
60 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
61 <label class=
"md-overlay" for=
"__drawer"></label>
62 <div data-md-component=
"skip">
65 <a href=
"#acp-search-provider-package-installation-plugin" class=
"md-skip">
70 <div data-md-component=
"announce">
72 <aside class=
"md-announce">
73 <div class=
"md-announce__inner md-grid md-typeset">
75 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
82 <header class=
"md-header" data-md-component=
"header">
83 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
84 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
86 <img src=
"../../../assets/logo.png" alt=
"logo">
89 <label class=
"md-header__button md-icon" for=
"__drawer">
90 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
92 <div class=
"md-header__title" data-md-component=
"header-title">
93 <div class=
"md-header__ellipsis">
94 <div class=
"md-header__topic">
95 <span class=
"md-ellipsis">
96 WoltLab Suite Documentation
99 <div class=
"md-header__topic" data-md-component=
"header-topic">
100 <span class=
"md-ellipsis">
111 <label class=
"md-header__button md-icon" for=
"__search">
112 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
115 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
116 <label class=
"md-search__overlay" for=
"__search"></label>
117 <div class=
"md-search__inner" role=
"search">
118 <form class=
"md-search__form" name=
"search">
119 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
120 <label class=
"md-search__icon md-icon" for=
"__search">
121 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
122 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
124 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
125 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
128 <div class=
"md-search__output">
129 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
130 <div class=
"md-search-result" data-md-component=
"search-result">
131 <div class=
"md-search-result__meta">
134 <ol class=
"md-search-result__list"></ol>
142 <div class=
"md-header__source">
144 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
145 <div class=
"md-source__icon md-icon">
147 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
149 <div class=
"md-source__repository">
158 <div class=
"md-container" data-md-component=
"container">
163 <main class=
"md-main" data-md-component=
"main">
164 <div class=
"md-main__inner md-grid">
168 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
169 <div class=
"md-sidebar__scrollwrap">
170 <div class=
"md-sidebar__inner">
174 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
175 <label class=
"md-nav__title" for=
"__drawer">
176 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
178 <img src=
"../../../assets/logo.png" alt=
"logo">
181 WoltLab Suite Documentation
184 <div class=
"md-nav__source">
186 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
187 <div class=
"md-source__icon md-icon">
189 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
191 <div class=
"md-source__repository">
197 <ul class=
"md-nav__list" data-md-scrollfix
>
206 <li class=
"md-nav__item">
207 <a href=
"../../../getting-started/" class=
"md-nav__link">
222 <li class=
"md-nav__item md-nav__item--nested">
225 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
227 <label class=
"md-nav__link" for=
"__nav_2">
229 <span class=
"md-nav__icon md-icon"></span>
231 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
232 <label class=
"md-nav__title" for=
"__nav_2">
233 <span class=
"md-nav__icon md-icon"></span>
236 <ul class=
"md-nav__list" data-md-scrollfix
>
242 <li class=
"md-nav__item">
243 <a href=
"../../../php/pages/" class=
"md-nav__link">
254 <li class=
"md-nav__item">
255 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
266 <li class=
"md-nav__item">
267 <a href=
"../../../php/database-access/" class=
"md-nav__link">
278 <li class=
"md-nav__item">
279 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
291 <li class=
"md-nav__item md-nav__item--nested">
294 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
296 <label class=
"md-nav__link" for=
"__nav_2_5">
298 <span class=
"md-nav__icon md-icon"></span>
300 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
301 <label class=
"md-nav__title" for=
"__nav_2_5">
302 <span class=
"md-nav__icon md-icon"></span>
305 <ul class=
"md-nav__list" data-md-scrollfix
>
312 <li class=
"md-nav__item md-nav__item--nested">
315 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
317 <label class=
"md-nav__link" for=
"__nav_2_5_1">
319 <span class=
"md-nav__icon md-icon"></span>
321 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
322 <label class=
"md-nav__title" for=
"__nav_2_5_1">
323 <span class=
"md-nav__icon md-icon"></span>
326 <ul class=
"md-nav__list" data-md-scrollfix
>
332 <li class=
"md-nav__item">
333 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
344 <li class=
"md-nav__item">
345 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
356 <li class=
"md-nav__item">
357 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
374 <li class=
"md-nav__item">
375 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
386 <li class=
"md-nav__item">
387 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
398 <li class=
"md-nav__item">
399 <a href=
"../../../php/api/events/" class=
"md-nav__link">
411 <li class=
"md-nav__item md-nav__item--nested">
414 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
416 <label class=
"md-nav__link" for=
"__nav_2_5_5">
418 <span class=
"md-nav__icon md-icon"></span>
420 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
421 <label class=
"md-nav__title" for=
"__nav_2_5_5">
422 <span class=
"md-nav__icon md-icon"></span>
425 <ul class=
"md-nav__list" data-md-scrollfix
>
431 <li class=
"md-nav__item">
432 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
443 <li class=
"md-nav__item">
444 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
455 <li class=
"md-nav__item">
456 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
467 <li class=
"md-nav__item">
468 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
479 <li class=
"md-nav__item">
480 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
497 <li class=
"md-nav__item">
498 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
499 Package Installation Plugins
509 <li class=
"md-nav__item">
510 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
521 <li class=
"md-nav__item">
522 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
533 <li class=
"md-nav__item">
534 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
551 <li class=
"md-nav__item">
552 <a href=
"../../../php/code-style/" class=
"md-nav__link">
563 <li class=
"md-nav__item">
564 <a href=
"../../../php/apps/" class=
"md-nav__link">
575 <li class=
"md-nav__item">
576 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
597 <li class=
"md-nav__item md-nav__item--nested">
600 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
602 <label class=
"md-nav__link" for=
"__nav_3">
603 Languages, Templates & CSS
604 <span class=
"md-nav__icon md-icon"></span>
606 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
607 <label class=
"md-nav__title" for=
"__nav_3">
608 <span class=
"md-nav__icon md-icon"></span>
609 Languages, Templates & CSS
611 <ul class=
"md-nav__list" data-md-scrollfix
>
617 <li class=
"md-nav__item">
618 <a href=
"../../../view/languages/" class=
"md-nav__link">
629 <li class=
"md-nav__item">
630 <a href=
"../../../view/templates/" class=
"md-nav__link">
641 <li class=
"md-nav__item">
642 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
653 <li class=
"md-nav__item">
654 <a href=
"../../../view/css/" class=
"md-nav__link">
675 <li class=
"md-nav__item md-nav__item--nested">
678 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
680 <label class=
"md-nav__link" for=
"__nav_4">
681 TypeScript and JavaScript API
682 <span class=
"md-nav__icon md-icon"></span>
684 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
685 <label class=
"md-nav__title" for=
"__nav_4">
686 <span class=
"md-nav__icon md-icon"></span>
687 TypeScript and JavaScript API
689 <ul class=
"md-nav__list" data-md-scrollfix
>
695 <li class=
"md-nav__item">
696 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
707 <li class=
"md-nav__item">
708 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
720 <li class=
"md-nav__item md-nav__item--nested">
723 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
725 <label class=
"md-nav__link" for=
"__nav_4_3">
727 <span class=
"md-nav__icon md-icon"></span>
729 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
730 <label class=
"md-nav__title" for=
"__nav_4_3">
731 <span class=
"md-nav__icon md-icon"></span>
734 <ul class=
"md-nav__list" data-md-scrollfix
>
740 <li class=
"md-nav__item">
741 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
752 <li class=
"md-nav__item">
753 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
764 <li class=
"md-nav__item">
765 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
776 <li class=
"md-nav__item">
777 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
788 <li class=
"md-nav__item">
789 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
800 <li class=
"md-nav__item">
801 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
812 <li class=
"md-nav__item">
813 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
824 <li class=
"md-nav__item">
825 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
826 Browser and Screen Sizes
836 <li class=
"md-nav__item">
837 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
854 <li class=
"md-nav__item">
855 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
866 <li class=
"md-nav__item">
867 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
878 <li class=
"md-nav__item">
879 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
902 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
905 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
907 <label class=
"md-nav__link" for=
"__nav_5">
909 <span class=
"md-nav__icon md-icon"></span>
911 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
912 <label class=
"md-nav__title" for=
"__nav_5">
913 <span class=
"md-nav__icon md-icon"></span>
916 <ul class=
"md-nav__list" data-md-scrollfix
>
922 <li class=
"md-nav__item">
923 <a href=
"../../package-xml/" class=
"md-nav__link">
937 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
940 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" checked
>
942 <label class=
"md-nav__link" for=
"__nav_5_2">
944 <span class=
"md-nav__icon md-icon"></span>
946 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
947 <label class=
"md-nav__title" for=
"__nav_5_2">
948 <span class=
"md-nav__icon md-icon"></span>
951 <ul class=
"md-nav__list" data-md-scrollfix
>
957 <li class=
"md-nav__item">
958 <a href=
"../" class=
"md-nav__link">
969 <li class=
"md-nav__item">
970 <a href=
"../acl-option/" class=
"md-nav__link">
981 <li class=
"md-nav__item">
982 <a href=
"../acp-menu/" class=
"md-nav__link">
995 <li class=
"md-nav__item md-nav__item--active">
997 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1003 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1005 <span class=
"md-nav__icon md-icon"></span>
1008 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1013 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1020 <label class=
"md-nav__title" for=
"__toc">
1021 <span class=
"md-nav__icon md-icon"></span>
1024 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1026 <li class=
"md-nav__item">
1027 <a href=
"#components" class=
"md-nav__link">
1031 <nav class=
"md-nav" aria-label=
"Components">
1032 <ul class=
"md-nav__list">
1034 <li class=
"md-nav__item">
1035 <a href=
"#classname" class=
"md-nav__link">
1041 <li class=
"md-nav__item">
1042 <a href=
"#showorder" class=
"md-nav__link">
1053 <li class=
"md-nav__item">
1054 <a href=
"#example" class=
"md-nav__link">
1072 <li class=
"md-nav__item">
1073 <a href=
"../acp-template/" class=
"md-nav__link">
1084 <li class=
"md-nav__item">
1085 <a href=
"../bbcode/" class=
"md-nav__link">
1096 <li class=
"md-nav__item">
1097 <a href=
"../box/" class=
"md-nav__link">
1108 <li class=
"md-nav__item">
1109 <a href=
"../clipboard-action/" class=
"md-nav__link">
1120 <li class=
"md-nav__item">
1121 <a href=
"../core-object/" class=
"md-nav__link">
1132 <li class=
"md-nav__item">
1133 <a href=
"../cronjob/" class=
"md-nav__link">
1144 <li class=
"md-nav__item">
1145 <a href=
"../database/" class=
"md-nav__link">
1156 <li class=
"md-nav__item">
1157 <a href=
"../event-listener/" class=
"md-nav__link">
1168 <li class=
"md-nav__item">
1169 <a href=
"../file/" class=
"md-nav__link">
1180 <li class=
"md-nav__item">
1181 <a href=
"../language/" class=
"md-nav__link">
1192 <li class=
"md-nav__item">
1193 <a href=
"../media-provider/" class=
"md-nav__link">
1204 <li class=
"md-nav__item">
1205 <a href=
"../menu/" class=
"md-nav__link">
1216 <li class=
"md-nav__item">
1217 <a href=
"../menu-item/" class=
"md-nav__link">
1228 <li class=
"md-nav__item">
1229 <a href=
"../object-type/" class=
"md-nav__link">
1240 <li class=
"md-nav__item">
1241 <a href=
"../object-type-definition/" class=
"md-nav__link">
1242 objectTypeDefinition
1252 <li class=
"md-nav__item">
1253 <a href=
"../option/" class=
"md-nav__link">
1264 <li class=
"md-nav__item">
1265 <a href=
"../page/" class=
"md-nav__link">
1276 <li class=
"md-nav__item">
1277 <a href=
"../pip/" class=
"md-nav__link">
1288 <li class=
"md-nav__item">
1289 <a href=
"../script/" class=
"md-nav__link">
1300 <li class=
"md-nav__item">
1301 <a href=
"../smiley/" class=
"md-nav__link">
1312 <li class=
"md-nav__item">
1313 <a href=
"../sql/" class=
"md-nav__link">
1324 <li class=
"md-nav__item">
1325 <a href=
"../style/" class=
"md-nav__link">
1336 <li class=
"md-nav__item">
1337 <a href=
"../template/" class=
"md-nav__link">
1348 <li class=
"md-nav__item">
1349 <a href=
"../template-listener/" class=
"md-nav__link">
1360 <li class=
"md-nav__item">
1361 <a href=
"../user-group-option/" class=
"md-nav__link">
1372 <li class=
"md-nav__item">
1373 <a href=
"../user-menu/" class=
"md-nav__link">
1384 <li class=
"md-nav__item">
1385 <a href=
"../user-notification-event/" class=
"md-nav__link">
1386 userNotificationEvent
1396 <li class=
"md-nav__item">
1397 <a href=
"../user-option/" class=
"md-nav__link">
1408 <li class=
"md-nav__item">
1409 <a href=
"../user-profile-menu/" class=
"md-nav__link">
1426 <li class=
"md-nav__item">
1427 <a href=
"../../database-php-api/" class=
"md-nav__link">
1448 <li class=
"md-nav__item md-nav__item--nested">
1451 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1453 <label class=
"md-nav__link" for=
"__nav_6">
1455 <span class=
"md-nav__icon md-icon"></span>
1457 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1458 <label class=
"md-nav__title" for=
"__nav_6">
1459 <span class=
"md-nav__icon md-icon"></span>
1462 <ul class=
"md-nav__list" data-md-scrollfix
>
1469 <li class=
"md-nav__item md-nav__item--nested">
1472 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1474 <label class=
"md-nav__link" for=
"__nav_6_1">
1475 Migrating from WSC
5.3
1476 <span class=
"md-nav__icon md-icon"></span>
1478 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1479 <label class=
"md-nav__title" for=
"__nav_6_1">
1480 <span class=
"md-nav__icon md-icon"></span>
1481 Migrating from WSC
5.3
1483 <ul class=
"md-nav__list" data-md-scrollfix
>
1489 <li class=
"md-nav__item">
1490 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1501 <li class=
"md-nav__item">
1502 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1503 Session Handling and Authentication
1513 <li class=
"md-nav__item">
1514 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1515 TypeScript and JavaScript
1525 <li class=
"md-nav__item">
1526 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1537 <li class=
"md-nav__item">
1538 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1539 Third Party Libraries
1556 <li class=
"md-nav__item md-nav__item--nested">
1559 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1561 <label class=
"md-nav__link" for=
"__nav_6_2">
1562 Migrating from WSC
5.2
1563 <span class=
"md-nav__icon md-icon"></span>
1565 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1566 <label class=
"md-nav__title" for=
"__nav_6_2">
1567 <span class=
"md-nav__icon md-icon"></span>
1568 Migrating from WSC
5.2
1570 <ul class=
"md-nav__list" data-md-scrollfix
>
1576 <li class=
"md-nav__item">
1577 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1588 <li class=
"md-nav__item">
1589 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1590 Templates and Languages
1600 <li class=
"md-nav__item">
1601 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1602 Third Party Libraries
1619 <li class=
"md-nav__item md-nav__item--nested">
1622 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1624 <label class=
"md-nav__link" for=
"__nav_6_3">
1625 Migrating from WSC
3.1
1626 <span class=
"md-nav__icon md-icon"></span>
1628 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1629 <label class=
"md-nav__title" for=
"__nav_6_3">
1630 <span class=
"md-nav__icon md-icon"></span>
1631 Migrating from WSC
3.1
1633 <ul class=
"md-nav__list" data-md-scrollfix
>
1639 <li class=
"md-nav__item">
1640 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1658 <li class=
"md-nav__item md-nav__item--nested">
1661 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1663 <label class=
"md-nav__link" for=
"__nav_6_4">
1664 Migrating from WSC
3.0
1665 <span class=
"md-nav__icon md-icon"></span>
1667 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1668 <label class=
"md-nav__title" for=
"__nav_6_4">
1669 <span class=
"md-nav__icon md-icon"></span>
1670 Migrating from WSC
3.0
1672 <ul class=
"md-nav__list" data-md-scrollfix
>
1678 <li class=
"md-nav__item">
1679 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1690 <li class=
"md-nav__item">
1691 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1702 <li class=
"md-nav__item">
1703 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1714 <li class=
"md-nav__item">
1715 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1726 <li class=
"md-nav__item">
1727 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1745 <li class=
"md-nav__item md-nav__item--nested">
1748 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1750 <label class=
"md-nav__link" for=
"__nav_6_5">
1751 Migrating from WCF
2.1
1752 <span class=
"md-nav__icon md-icon"></span>
1754 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1755 <label class=
"md-nav__title" for=
"__nav_6_5">
1756 <span class=
"md-nav__icon md-icon"></span>
1757 Migrating from WCF
2.1
1759 <ul class=
"md-nav__list" data-md-scrollfix
>
1765 <li class=
"md-nav__item">
1766 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1777 <li class=
"md-nav__item">
1778 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1789 <li class=
"md-nav__item">
1790 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1801 <li class=
"md-nav__item">
1802 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1829 <li class=
"md-nav__item md-nav__item--nested">
1832 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1834 <label class=
"md-nav__link" for=
"__nav_7">
1836 <span class=
"md-nav__icon md-icon"></span>
1838 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1839 <label class=
"md-nav__title" for=
"__nav_7">
1840 <span class=
"md-nav__icon md-icon"></span>
1843 <ul class=
"md-nav__list" data-md-scrollfix
>
1850 <li class=
"md-nav__item md-nav__item--nested">
1853 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1855 <label class=
"md-nav__link" for=
"__nav_7_1">
1857 <span class=
"md-nav__icon md-icon"></span>
1859 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1860 <label class=
"md-nav__title" for=
"__nav_7_1">
1861 <span class=
"md-nav__icon md-icon"></span>
1864 <ul class=
"md-nav__list" data-md-scrollfix
>
1870 <li class=
"md-nav__item">
1871 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1882 <li class=
"md-nav__item">
1883 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
1894 <li class=
"md-nav__item">
1895 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
1906 <li class=
"md-nav__item">
1907 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
1918 <li class=
"md-nav__item">
1919 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
1930 <li class=
"md-nav__item">
1931 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
1958 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1959 <div class=
"md-sidebar__scrollwrap">
1960 <div class=
"md-sidebar__inner">
1962 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1969 <label class=
"md-nav__title" for=
"__toc">
1970 <span class=
"md-nav__icon md-icon"></span>
1973 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1975 <li class=
"md-nav__item">
1976 <a href=
"#components" class=
"md-nav__link">
1980 <nav class=
"md-nav" aria-label=
"Components">
1981 <ul class=
"md-nav__list">
1983 <li class=
"md-nav__item">
1984 <a href=
"#classname" class=
"md-nav__link">
1990 <li class=
"md-nav__item">
1991 <a href=
"#showorder" class=
"md-nav__link">
2002 <li class=
"md-nav__item">
2003 <a href=
"#example" class=
"md-nav__link">
2017 <div class=
"md-content" data-md-component=
"content">
2018 <article class=
"md-content__inner md-typeset">
2021 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/pip/acp-search-provider.md" title=
"Edit this page" class=
"md-content__button md-icon">
2022 <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>
2026 <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>
2027 <p>Registers data provider for the admin panel search.
</p>
2028 <h2 id=
"components">Components
<a class=
"headerlink" href=
"#components" title=
"Permanent link">#
</a></h2>
2029 <p>Each acp search result provider is described as an
<code><acpsearchprovider
></code> element with the mandatory attribute
<code>name
</code>.
</p>
2030 <h3 id=
"classname"><code><classname
></code><a class=
"headerlink" href=
"#classname" title=
"Permanent link">#
</a></h3>
2031 <p>The name of the class providing the search results,
2032 the class has to implement the
<code>wcf\system\search\acp\IACPSearchResultProvider
</code> interface.
</p>
2033 <h3 id=
"showorder"><code><showorder
></code><a class=
"headerlink" href=
"#showorder" title=
"Permanent link">#
</a></h3>
2034 <p><span class=
"label label-info">Optional
</span></p>
2035 <p>Determines at which position of the search result list the provided results are shown.
</p>
2036 <h2 id=
"example">Example
<a class=
"headerlink" href=
"#example" title=
"Permanent link">#
</a></h2>
2037 <div class=
"titledCodeBox">
2038 <div class=
"codeBoxTitle"><code>acpSearchProvider.xml
</code></div>
2039 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2040 <span class=
"normal">2</span>
2041 <span class=
"normal">3</span>
2042 <span class=
"normal">4</span>
2043 <span class=
"normal">5</span>
2044 <span class=
"normal">6</span>
2045 <span class=
"normal">7</span>
2046 <span class=
"normal">8</span>
2047 <span class=
"normal">9</span></pre></div></td><td class=
"code"><div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
2048 <span class=
"nt"><data
</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/
2019/acpSearchProvider.xsd
"</span><span class=
"nt">></span>
2049 <span class=
"nt"><import
></span>
2050 <span class=
"nt"><acpsearchprovider
</span> <span class=
"na">name=
</span><span class=
"s">"com.woltlab.wcf.example
"</span><span class=
"nt">></span>
2051 <span class=
"nt"><classname
></span>wcf\system\search\acp\ExampleACPSearchResultProvider
<span class=
"nt"></classname
></span>
2052 <span class=
"nt"><showorder
></span>1<span class=
"nt"></showorder
></span>
2053 <span class=
"nt"></acpsearchprovider
></span>
2054 <span class=
"nt"></import
></span>
2055 <span class=
"nt"></data
></span>
2064 <div class=
"md-source-date">
2067 Last update:
2021-
04-
23
2086 <footer class=
"md-footer">
2088 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2090 <a href=
"../acp-menu/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2091 <div class=
"md-footer__button md-icon">
2092 <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>
2094 <div class=
"md-footer__title">
2095 <div class=
"md-ellipsis">
2096 <span class=
"md-footer__direction">
2105 <a href=
"../acp-template/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2106 <div class=
"md-footer__title">
2107 <div class=
"md-ellipsis">
2108 <span class=
"md-footer__direction">
2114 <div class=
"md-footer__button md-icon">
2115 <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>
2121 <div class=
"md-footer-meta md-typeset">
2122 <div class=
"md-footer-meta__inner md-grid">
2123 <div class=
"md-footer-copyright">
2125 <div class=
"md-footer-copyright__highlight">
2126 Copyright ©
2020 WoltLab GmbH
2130 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2135 <div class=
"md-footer-copyright">
2136 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2137 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2144 <div class=
"md-dialog" data-md-component=
"dialog">
2145 <div class=
"md-dialog__inner md-typeset"></div>
2147 <script id=
"__config" type=
"application/json">{
"base":
"../../..",
"features": [],
"translations": {
"clipboard.copy":
"Copy to clipboard",
"clipboard.copied":
"Copied to clipboard",
"search.config.lang":
"en",
"search.config.pipeline":
"trimmer, stopWordFilter",
"search.config.separator":
"[\\s\\-]+",
"search.placeholder":
"Search",
"search.result.placeholder":
"Type to start searching",
"search.result.none":
"No matching documents",
"search.result.one":
"1 matching document",
"search.result.other":
"# matching documents",
"search.result.more.one":
"1 more on this page",
"search.result.more.other":
"# more on this page",
"search.result.term.missing":
"Missing"},
"search":
"../../../assets/javascripts/workers/search.fe42c31b.min.js",
"version": {
"provider":
"mike"}}
</script>
2150 <script src=
"../../../assets/javascripts/bundle.4ea5477f.min.js"></script>