Für Entwickler
Hooks und Filter
Auf dieser Seite
Themes und eigener Code können ändern, was das Plugin indexiert, wie das Suchfenster seine Filter darstellt, wer die Einstellungen ändern darf und wann sich die Suche öffnet. Legen Sie den Code in die functions.php eines Child-Themes oder in ein eigenes kleines Plugin.
Filter
searcio_index_allow_protected_meta
(bool $allow, string $meta_key, WP_Post $post)
Ein Feld, das Sie aus einem benutzerdefinierten Feld zuordnen (meta: gefolgt vom Schlüssel), überspringt geschützte Metadaten, also Schlüssel, die mit einem Unterstrich beginnen. So kann eine zu weit gefasste Zuordnung keine internen Daten in eine öffentliche Suche bringen. Geben Sie true zurück, um einen dieser Schlüssel trotzdem zu indexieren:
add_filter( 'searcio_index_allow_protected_meta', function ( $allow, $key ) {
return '_my_public_field' === $key ? true : $allow;
}, 10, 2 );searcio_storefront_facet_display
(string $display, string $field)
Wie das Suchfenster die Werte eines Filters darstellt:
| Wert | Darstellung |
|---|---|
auto |
Der Standard: Farb-Swatches, wenn jeder Wert eine Farbe hat, Bild-Swatches, wenn jeder Wert ein Bild hat, Kacheln für Größen, Schuhgrößen und Speichergrößen, sonst eine Liste mit Kontrollkästchen. |
list |
Eine Liste mit Kontrollkästchen. |
tiles |
Kacheln. |
color |
Farb-Swatches, sobald ein Wert eine Farbe hat. Ein Wert ohne Farbe erscheint als leerer Ring. |
image |
Bild-Swatches, auf dieselbe Weise. |
range |
Ein Bereich mit Minimum und Maximum. |
Jeder andere Wert gilt als auto. Das Plugin übergibt bereits tiles für eine Eigenschaft, die Ihr Swatches-Plugin als Beschriftungen oder Buttons zeigt, und color oder image für eine Eigenschaft, die als Farb- oder Bild-Swatches eingerichtet ist.
add_filter( 'searcio_storefront_facet_display', function ( $display, $field ) {
return 'attr_fit' === $field ? 'tiles' : $display;
}, 10, 2 );searcio_storefront_facet_colors
(array $colors, string $field, string $taxonomy)
Die Farbe jedes Werts eines Filters, als Wert => Hex-Farbe, in der Sprache der Seite. Das Plugin füllt sie für eine WooCommerce-Eigenschaft aus Ihrem Swatches-Plugin oder Theme (siehe So werden Produkte gesendet). $taxonomy ist leer für ein Feld, das keine Eigenschaft ist. Ein Wert ohne gültige Hex-Farbe wird verworfen.
add_filter( 'searcio_storefront_facet_colors', function ( $colors, $field ) {
if ( 'attr_farbe' === $field ) {
$colors['Petrol'] = '#1f6f78';
}
return $colors;
}, 10, 2 );searcio_storefront_facet_images
(array $images, string $field, string $taxonomy)
Das Bild jedes Werts eines Filters, als Wert => Bildadresse, auf dieselbe Weise. Eine Adresse, die nicht mit http oder https beginnt, wird verworfen. Zusammen mit searcio_storefront_facet_colors deckt dieser Filter ein Swatches-Plugin oder Theme ab, das das Plugin nicht selbst liest.
searcio_storefront_is_preview
(bool $is_preview)
Ob die Seite der Editor eines Page Builders ist. Suchen aus einem Editor zählen für Ihren Tarif, bleiben aber aus Ihrer Suchstatistik heraus. Das Plugin erkennt die Editoren von Elementor, Divi, Beaver Builder, Oxygen, Bricks und den Frontend-Editor von WPBakery sowie den Customizer. Geben Sie für einen anderen Editor true zurück:
add_filter( 'searcio_storefront_is_preview', function ( $is_preview ) {
return $is_preview || isset( $_GET['my_builder_edit'] );
} );searcio_sync_tick_budget
(int $budget)
Wie viele Sekunden ein Schritt einer vollständigen Synchronisierung laufen darf, geprüft zwischen den Paketen. Der Standard ist 20. Senken Sie den Wert, wo das Zeitlimit von PHP kürzer ist, damit ein Schritt endet, bevor PHP ihn abbricht:
add_filter( 'searcio_sync_tick_budget', fn () => 10 );woocommerce_product_is_visible
Der WooCommerce-eigene Filter (bool $visible, int $product_id) gilt auch beim Synchronisieren, wenn Nur veröffentlichte, sichtbare Produkte indexieren eingeschaltet ist (siehe Produktdetails). Geben Sie false zurück, um ein Produkt aus der Suche herauszuhalten.
Der übergebene Wert sagt, ob die Suche von WooCommerce das Produkt anzeigen würde. Ihr Callback läuft dort, wo die Synchronisierung läuft, in WP-Cron, WP-CLI oder einer REST-Anfrage. Deshalb ist is_search() falsch, und meist ist kein Benutzer angemeldet.
Actions
| Action | Wird ausgelöst | Argumente |
|---|---|---|
searcio/before_load |
Bei plugins_loaded, bevor das Plugin startet. |
Keine |
searcio/after_load |
Bei plugins_loaded, sobald das Plugin gestartet ist. |
Die Instanz des Plugins |
Die Suche aus eigenem Code öffnen
Ein Link auf #searcio oder jedes Element mit der Klasse searcio-open öffnet das Suchfenster (siehe Weitere Wege zur Einbindung).
Aus JavaScript lösen Sie das Ereignis whsc:open auf window aus. detail.query ist der Text, mit dem die Suche beginnt, und kann wegfallen:
window.dispatchEvent( new CustomEvent( 'whsc:open', { detail: { query: 'jacke' } } ) );Das Ereignis funktioniert auf jeder Seite, auf der die Suche geladen ist: auf einer Seite mit einem Such-Block, Widget oder Shortcode und auf jeder Seite, solange das Suchsymbol des Themes, das Tastenkürzel oder der schwebende Suchbutton eingeschaltet ist.
CSS Custom Properties
Das Suchfenster und das Suchfeld lesen die CSS Custom Properties --whsc-*. Setzen Sie sie für die ganze Website auf :root oder body oder für eine einzelne Einbindung auf deren Klasse whsc-instance-*. Ein von Ihnen gesetzter Wert hat Vorrang vor den Standardwerten. Der Block, das Elementor-Widget und der Aussehen-Editor setzen die meisten davon für Sie; nutzen Sie die Properties für das, was diese nicht abdecken.
| Property | Gestaltet |
|---|---|
--whsc-accent |
Die Akzentfarbe von Buttons, aktiven Tabs und Links. |
--whsc-accent-strong |
Text in der Akzentfarbe. |
--whsc-tab-text-active |
Den Text des aktiven Tabs. Standard ist --whsc-accent-strong. |
--whsc-floating-bg |
Den Hintergrund des schwebenden Suchbuttons. Standard ist die Akzentfarbe. |
--whsc-floating-color |
Das Symbol des schwebenden Suchbuttons. Standard ist Weiß. |
--whsc-floating-offset |
Den Abstand des schwebenden Suchbuttons vom unteren Bildschirmrand. |
--whsc-stock-in-color |
Die Zeile „Auf Lager“ auf Produktkarten. |
--whsc-stock-out-color |
Die Zeile „Nicht auf Lager“ auf Produktkarten. |
:root {
--whsc-accent: #25735f;
}Ändern Sie das Aussehen über diese Properties statt mit Regeln für die eigenen Klassen des Fensters: Das Stylesheet des Plugins hält das Fenster unter jedem Theme gleich, deshalb braucht eine solche Regel !important, um zu greifen.
Berechtigungen
Die drei Berechtigungen des Plugins haben Administratoren. Jede wird für sich geprüft: Eine Rolle, die Einstellungen ändern darf, braucht zusätzlich searcio_view, um den Bildschirm zu öffnen. Um sie einer anderen Rolle zu geben, verwenden Sie ein Plugin zur Rollenbearbeitung oder fügen Sie sie einmalig hinzu, etwa beim Aktivieren Ihres eigenen Plugins, denn eine Rolle behält, was ihr hinzugefügt wird:
$role = get_role( 'shop_manager' );
if ( $role ) {
$role->add_cap( 'searcio_view' );
$role->add_cap( 'searcio_run_sync' );
}Mehr
- Die WP-CLI-Befehle zum Synchronisieren stehen unter Synchronisierung über die Kommandozeile.
- Der Quellcode des Plugins, einschließlich JavaScript und CSS vor dem Build, liegt in seinem Repository auf GitHub.
- Um Searcio aus Ihrer eigenen Software statt aus WordPress anzusprechen, lesen Sie die Referenz der REST-API.