Wie Sie SaveTo Wishlist mit Hooks und der REST-API erweitern können

Erstellen Sie eine benutzerdefinierte Integration, ändern Sie das Aussehen der Wishlist-Schaltfläche oder reagieren Sie, wenn ein Kunde ein Produkt speichert? SaveTo Wishlist bietet Ihnen WordPress-Filter und -Aktionen für jede dieser Aufgaben sowie eine REST-API zum Lesen und Ändern von Wishlists. Dieser Artikel listet die Hooks und Routen auf, die mit SaveTo Wishlist Lite 1.1.8 geliefert werden, mit den Argumenten, die jeder erhält, und einem funktionierenden Beispiel für die gängigen Fälle.

Bevor Sie beginnen

• Sie benötigen SaveTo Wishlist Lite und WooCommerce aktiv auf der Website. SaveTo Wishlist Pro und Registry fügen ihre eigenen Hooks hinzu, die hier nicht behandelt werden.
• Jeder Hook-Name beginnt mit stwlite_.
• Fügen Sie Ihren Code in ein kleines benutzerdefiniertes Plugin oder ein Code-Snippets-Plugin ein. Fügen Sie Platzierungsfilter (siehe unten) in eine Plugin-Datei ein, nicht in die functions.php-Datei eines Themes.
• Jeder Hook und jede Route in diesem Artikel ist in SaveTo Wishlist Lite 1.1.8 enthalten. Ein Hook, der hier nicht aufgeführt ist, ist kein Teil der öffentlichen Oberfläche, verlassen Sie sich also nicht darauf.

Hooks

Jeder Hook unten listet seinen Typ, die empfangenen Argumente und seine Funktion auf. Wenn Sie einen Callback registrieren, der mehr als ein Argument annimmt, übergeben Sie die Anzahl der Argumente als vierten Parameter von add_filter() oder add_action(), wie die Beispiele zeigen.

Schaltflächenausgabe

Diese Filter ändern das Markup der Wishlist-Schaltfläche, bevor es ausgegeben wird. Das Plugin übergibt das endgültige Markup durch wp_kses(), sodass Tags und Attribute außerhalb seiner Zulassungsliste entfernt werden. Um mehr Tags zuzulassen, verwenden Sie den Filter stwlite_allowed_button_html, der das Array der Zulassungsliste empfängt.

Dieses Beispiel fügt eine kurze Notiz nach der Schaltfläche für Produkte im Angebot hinzu:

add_filter( 'stwlite_wishlist_button_html', function ( $button_html, $product, $placement, $style, $button_label ) {
    if ( '' === $button_html || ! $product instanceof WC_Product || ! $product->is_on_sale() ) {
        return $button_html;
    }

    return $button_html . '<span class="my-sale-note">On sale</span>';
}, 10, 5 );

Platzierung, Stil und Beschriftungen der Schaltfläche

Diese Filter ändern, wo die Schaltfläche erscheint und wie sie aussieht. Jeder erhält die gespeicherte Einstellung und gibt den zu verwendenden Wert zurück.

Shop-Platzierungen sind top_right, top_left, above_title, below_title, above_button, below_button und disable. Produktseiten-Platzierungen sind top_image_right, top_image_left, top_cart, bottom_cart, inline_cart, top_title, bottom_title und disable. Das Plugin liest die Platzierung einmal, wenn es beim Hook setup_theme mit Priorität 100 gestartet wird. Ein Platzierungsfilter muss daher vorher hinzugefügt werden. Registrieren Sie ihn also in einer Plugin-Datei und nicht in der functions.php-Datei eines Themes. Die Filter für Stil, Beschriftung und Farbe werden jedes Mal ausgeführt, wenn eine Schaltfläche gerendert wird, sodass sie von jedem Code aus funktionieren.

add_filter( 'stwlite_wishlist_button_product_placement', function ( $placement ) {
    return 'bottom_cart';
} );

Für die entsprechende Einstellungsansicht siehe Anpassen der Platzierung und Stile der Wunschlisten-Schaltfläche in WooCommerce.

Wunschlisten-Daten

Diese Filter ändern die Wunschlistendaten, während das Plugin sie liest. Sie werden bei vielen Anfragen ausgeführt, einschließlich der Überprüfungen von Besitzern und Berechtigungen. Halten Sie Ihre Callbacks daher schnell. Ändern Sie nicht die Werte für id, user_id, status oder is_public, da das Plugin diese liest, um zu entscheiden, wer eine Wunschliste sehen kann.

Dieses Beispiel entfernt die Beschreibung aus Wunschlistenobjekten in Listenantworten:

add_filter( 'stwlite_collections_data', function ( $collections ) {
    foreach ( $collections as $collection ) {
        $collection->description = '';
    }

    return $collections;
} );

Benutzer-Wunschlisten-Zugriff

Diese Filter entscheiden, wer eine Wunschliste lesen oder besitzen darf. Bei einer Leseanfrage erlaubt das Plugin zuerst Administratoren mit der manage_options-Berechtigung, dann dem Besitzer der Wunschliste, dann öffentlichen veröffentlichten Wunschlisten und dann seinen eigenen Freigaberegeln. Erst nach diesen Prüfungen ruft es stwlite_user_wishlist_access auf.

Dieses Beispiel erlaubt Shop-Managern, jede Wunschliste zu lesen:

add_filter( 'stwlite_user_wishlist_access', function ( $granted, $wishlist, $user_id, $request ) {
    if ( $user_id && user_can( $user_id, 'manage_woocommerce' ) ) {
        return true;
    }

    return $granted;
}, 10, 4 );

Wunschlisten-Aktionen

Nutzen Sie diese Aktionen, um zu reagieren, wenn sich etwas ändert, z. B. um Daten an ein CRM zu synchronisieren oder einen Log-Eintrag zu schreiben.

Dieses Beispiel speichert das letzte Produkt, das ein Kunde in seinen Benutzer-Metadaten gespeichert hat:

add_action( 'stwlite_after_product_added_to_wishlist', function ( $product_id, $quantity, $collection_id, $user_id, $added ) {
    if ( ! $added || ! $user_id ) {
        return;
    }

    update_user_meta( $user_id, 'my_last_wishlisted_product', (int) $product_id );
}, 10, 5 );

Admin-Einstellungsregisterkarten und -Steuerelemente

Der Einstellungsbildschirm erstellt seine Registerkarten und Felder aus Arrays. Verwenden Sie diese Filter, um Ihre eigene Registerkarte, Ihren eigenen Abschnitt oder Ihr eigenes Feld hinzuzufügen oder ein vorhandenes zu ändern.

Registerkarten befinden sich unter dem übergeordneten Schlüssel saveto_wishlist. Die Schlüssel der untergeordneten Registerkarten sind general, wishlist_page, wishlist_guest, wishlist_button und importer. Jede untergeordnete Registerkarte enthält sort, key, label, icon und ein sections-Array. Das Steuerelement-Array ist als $controls[ 'saveto_wishlist' ][ $tab_key ][ $section_key ] verschlüsselt, und jeder Abschnitt enthält eine Liste von Steuerelement-Arrays. Ein Steuerelement hat einen type (z. B. switch oder select), ein label, eine id, die der Optionsname ist, eine description und einen default. Steuerelemente vom Typ switch verwenden die Werte yes und no.

Dieses Beispiel fügt der Registerkarte „Allgemein“ einen Schalter hinzu. Es wird davon ausgegangen, dass der Abschnittsschlüssel save_to_wishlist_settings der erste Abschnitt dieser Registerkarte ist.

add_filter( 'stwlite_admin_setting_default_general_tab_controls', function ( $controls ) {
    $controls['save_to_wishlist_settings'][] = array(
        'type'        => 'switch',
        'label'       => __( 'Log wishlist adds', 'my-plugin' ),
        'id'          => 'my_plugin_log_wishlist_adds',
        'description' => __( 'If Yes, write an entry to the debug log when a customer saves a product.', 'my-plugin' ),
        'options'     => array(
            'yes' => __( 'Yes', 'my-plugin' ),
            'no'  => __( 'No', 'my-plugin' ),
        ),
        'default'     => get_option( 'my_plugin_log_wishlist_adds', 'no' ),
    );

    return $controls;
} );

Der Einstellungsbildschirm speichert jeden Steuerelementwert über die später in diesem Artikel beschriebene Admin-Einstellungsroute. Zwei dynamische Filter ermöglichen es Ihnen, eine Speicherung oder eine Schaltfläche selbst zu handhaben:

• stwlite_group_settings_{action} ist ein Filter, der die gespeicherten Werte als $options empfängt, wenn die Payload der Einstellungen einen Schlüssel namens action enthält. Er gibt das Antwort-Array mit status und message zurück.
• stwlite_trigger_{action} ist ein Filter, der die Anfrageparameter als $params empfängt, wenn die Aktionsroute aufgerufen wird. Er gibt ein Array mit status und message sowie eine optionale redirect-URL zurück.

Frontend-Übersetzungen

Die Wunschlisten-Seite lädt diese Zeichenketten zweimal pro Anfrage, daher sollte Ihre Callback eine Zuordnung zusammenführen und aufwändige Arbeiten vermeiden. Dieses Beispiel ändert eine Zeichenkette. Verwenden Sie einen Schlüssel, der bereits im Array vorhanden ist.

add_filter( 'stwlite_frontend_translations', function ( $i18n ) {
    $i18n['just_now'] = __( 'a moment ago', 'my-plugin' );

    return $i18n;
} );

Nutzungs-Tracking-Daten

Wenn ein Shop die Nutzungs-Verfolgung erlaubt hat, sendet das Plugin periodisch eine Meldung. Diese Filter ermöglichen es einem Begleit-Plugin, diese Daten zu ergänzen. Werte müssen Skalare sein und dürfen keine Anmeldeinformationen oder persönlichen Daten enthalten.

Die Einstellung „Nutzungs-Tracking“ auf der Registerkarte „Allgemein“ steuert die Zustimmung. Wenn ein Shop diese auf Nein setzt, meldet das Plugin nichts, unabhängig davon, was Ihre Filter zurückgeben.

REST-API

Alle Routen verwenden den Namespace saveto-wishlist/v1, sodass der vollständige Pfad https://your-site.com/wp-json/saveto-wishlist/v1/ gefolgt vom Pfad in den Tabellen ist. Sie folgen der normalen WordPress REST-Authentifizierung. Browser-Code sendet den X-WP-Nonce-Header für einen angemeldeten Benutzer, und andere Clients können ein Anwendungspasswort mit HTTP Basic-Authentifizierung verwenden. Eine abgelehnte Anfrage gibt den Fehler rest_forbidden_context mit Status 401 für einen abgemeldeten Aufrufer oder 403 für einen angemeldeten zurück.

Kunden-Routen

Diese Routen steuern den Wunschlisten-Button und die Wunschlisten-Seite.

Die Route POST /frontend/endpoints antwortet immer mit HTTP 200 und einem status-Feld. Überprüfen Sie daher status im Body. Ein Aufrufer, der die Wunschliste nicht besitzt, erhält status auf error gesetzt. Nur Benutzer mit der Berechtigung manage_options können in die Wunschliste eines anderen Benutzers schreiben.

Diese Anfrage listet die Wunschzettel des Kontos auf, dem das Anwendungspasswort gehört:

curl -u "username:application-password" \
  "https://your-site.com/wp-json/saveto-wishlist/v1/frontend/endpoints/wishlists"

Diese Filter ändern, wer die Kunden-Routenprüfungen besteht und was die Gast-Route zurückgibt:

Admin-Routen

Die folgenden Routen dienen den eigenen Admin-Bildschirmen des Plugins und können sich zwischen den Versionen ändern. Bevorzugen Sie für Integrationen die obigen Hooks. Jede Admin-Route erfordert die Berechtigung manage_options. Verwenden Sie den Filter stwlite_api_admin_permissions_check ($response, $request), um dies zu ändern, und seien Sie vorsichtig, wenn Sie den Zugriff erweitern, da diese Routen Website-Optionen schreiben und Wunschlisten löschen können.

Die integrierten Importquellen sind yith, ti, moreconvert und wpc. Verwenden Sie den stwlite_available_importers-Filter, der ein Array empfängt und zurückgibt, das einen Quell-Slug einem Importer-Klassennamen zuordnet, um eine weitere zu registrieren.

Häufig gestellte Fragen

Warum tut mein Platzierungsfilter nichts?

Das Plugin liest die Platzierung, wenn es beim setup_theme-Hook mit der Priorität 100 startet. Fügen Sie den Filter aus einer Plugin-Datei hinzu. Eine functions.php-Datei des Themes wird nach diesem Zeitpunkt geladen.

Warum verliert mein Button-Markup ein Tag oder Attribut?

Das Plugin leitet das Button-Markup durch wp_kses(). Fügen Sie das Tag oder Attribut mit dem stwlite_allowed_button_html-Filter zur Zulassungsliste hinzu.

Warum gibt die Speicherroute HTTP 200 für eine abgelehnte Anfrage zurück?

POST /frontend/endpoints antwortet immer mit HTTP 200 und legt das Ergebnis im Feld status des Bodys ab. Lesen Sie status und message anstelle des HTTP-Codes.

Was kommt als Nächstes

• Wie Sie SaveTo Wishlist Pro mit Hooks und der REST-API erweitern können
• Wie Sie die SaveTo Wishlist Registry mit Hooks und der REST-API erweitern
• Wie man KI-Fähigkeiten in SaveTo Wishlist verwendet

Brauchen Sie Hilfe?

Wenn Sie eine Frage haben oder auf Probleme stoßen, sind wir für Sie da.

• Premium-Benutzer: Support-Ticket eröffnen
• Kostenlose Benutzer: Besuchen Sie unser Community-Forum