Comment étendre SaveTo Wishlist avec des hooks et l'API REST

Vous créez une intégration personnalisée, modifiez l'apparence du bouton de liste de souhaits ou réagissez lorsqu'un client enregistre un produit ? SaveTo Wishlist vous offre des filtres et des actions WordPress pour chacun de ces travaux, ainsi qu'une API REST pour lire et modifier les listes de souhaits. Cet article répertorie les hooks et les routes fournis avec SaveTo Wishlist Lite 1.1.8, avec les arguments que chacun reçoit et un exemple fonctionnel pour les cas courants.

Avant de commencer

• Vous avez besoin de SaveTo Wishlist Lite et de WooCommerce actifs sur le site. SaveTo Wishlist Pro et Registry ajoutent leurs propres hooks, qui ne sont pas abordés ici.
• Chaque nom de hook commence par stwlite_.
• Placez votre code dans un petit plugin personnalisé ou un plugin d'extraits de code. Ajoutez les filtres de placement (voir ci-dessous) dans un fichier de plugin, pas dans le fichier functions.php d'un thème.
• Chaque hook et route de cet article existe dans SaveTo Wishlist Lite 1.1.8. Un hook qui n'est pas répertorié ici ne fait pas partie de l'interface publique, ne vous y fiez donc pas.

Hooks

Chaque hook ci-dessous liste son type, les arguments qu'il reçoit et ce qu'il fait. Lorsque vous enregistrez un rappel qui prend plus d'un argument, passez le nombre d'arguments comme quatrième paramètre de add_filter() ou add_action(), comme le montrent les exemples.

Sortie du bouton

Ces filtres modifient le balisage du bouton de liste de souhaits avant son affichage. Le plugin passe le balisage final par wp_kses(), donc les balises et attributs en dehors de sa liste autorisée sont supprimés. Pour autoriser plus de balises, utilisez le filtre stwlite_allowed_button_html, qui reçoit le tableau de la liste autorisée.

Cet exemple ajoute une courte note après le bouton pour les produits en promotion :

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 );

Emplacement, style et libellés du bouton

Ces filtres modifient l'endroit où le bouton apparaît et son apparence. Chacun reçoit le paramètre enregistré et retourne la valeur à utiliser.

Les emplacements de la boutique sont top_right, top_left, above_title, below_title, above_button, below_button et disable. Les emplacements des pages de produits sont top_image_right, top_image_left, top_cart, bottom_cart, inline_cart, top_title, bottom_title et disable. Le plugin lit l'emplacement une fois, lorsqu'il démarre sur le hook setup_theme à la priorité 100. Un filtre d'emplacement doit donc être ajouté avant ce point, alors enregistrez-le dans un fichier de plugin et non dans le fichier functions.php d'un thème. Les filtres de style, de libellé et de couleur s'exécutent chaque fois qu'un bouton est rendu, ils fonctionnent donc à partir de n'importe quel code.

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

Pour l’écran des paramètres correspondants, consultez Comment personnaliser le placement et les styles du bouton de liste de souhaits dans WooCommerce.

Données de la liste de souhaits

Ces filtres modifient les données de la liste de souhaits au fur et à mesure que le plugin les lit. Ils s’exécutent sur de nombreuses requêtes, y compris les vérifications de propriété et d’autorisation, alors gardez vos callbacks rapides. Ne modifiez pas les valeurs id, user_id, status ou is_public, car le plugin les lit pour décider qui peut voir une liste de souhaits.

Cet exemple supprime la description des objets de liste de souhaits dans les réponses de liste :

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

    return $collections;
} );

Accès à la liste de souhaits de l’utilisateur

Ces filtres décident qui peut lire ou posséder une liste de souhaits. Pour une requête de lecture, le plugin autorise d’abord les administrateurs ayant la capacité manage_options, puis le propriétaire de la liste de souhaits, puis les listes de souhaits publiques publiées, puis ses propres règles de partage. Ce n’est qu’après ces vérifications qu’il appelle stwlite_user_wishlist_access.

Cet exemple permet aux responsables de boutique de lire n'importe quelle liste de souhaits :

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 );

Actions de la liste de souhaits

Utilisez ces actions pour réagir lorsque quelque chose change, par exemple pour synchroniser des données avec un CRM ou écrire une entrée de journal.

Cet exemple stocke le dernier produit qu'un client a enregistré dans ses métadonnées utilisateur :

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 );

Onglets et contrôles des paramètres d'administration

L'écran des paramètres construit ses onglets et champs à partir de tableaux. Utilisez ces filtres pour ajouter votre propre onglet, section ou champ, ou pour modifier un onglet, une section ou un champ existant.

Les onglets se trouvent sous la clé parente saveto_wishlist. Les clés des onglets enfants sont general, wishlist_page, wishlist_guest, wishlist_button et importer. Chaque onglet enfant contient sort, key, label, icon et un tableau sections. Le tableau des contrôles est indexé comme $controls[ 'saveto_wishlist' ][ $tab_key ][ $section_key ], et chaque section contient une liste de tableaux de contrôles. Un contrôle a un type (par exemple switch ou select), un label, un id qui est le nom de l'option, une description et une valeur default. Les contrôles de type switch utilisent les valeurs yes et no.

Cet exemple ajoute un interrupteur à l'onglet Général. Il suppose que la clé de section est save_to_wishlist_settings, qui est la première section de cet onglet.

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;
} );

L'écran des paramètres enregistre chaque valeur de contrôle via la route des paramètres d'administration décrite plus loin dans cet article. Deux filtres dynamiques vous permettent de gérer vous-même une sauvegarde ou un bouton :

• stwlite_group_settings_{action} est un filtre qui reçoit les valeurs enregistrées sous $options lorsque la charge utile des paramètres contient une clé nommée action. Il renvoie le tableau de réponse avec status et message.
• stwlite_trigger_{action} est un filtre qui reçoit les paramètres de la requête sous $params lorsque la route d'action est appelée. Il renvoie un tableau avec status et message, et une URL de redirect optionnelle.

Traductions frontend

La page de liste de souhaits charge ces chaînes deux fois par requête, donc votre callback doit fusionner dans une table et éviter les travaux lourds. Cet exemple change une chaîne. Utilisez une clé qui existe déjà dans le tableau.

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

    return $i18n;
} );

Données de suivi d'utilisation

Lorsqu'un magasin a autorisé le suivi d'utilisation, le plugin envoie une vérification périodique. Ces filtres permettent à un plugin compagnon d'ajouter à ces données. Les valeurs doivent être scalaires, et elles ne doivent pas contenir d'informations d'identification ou de données personnelles.

Le paramètre « Suivi d'utilisation » dans l'onglet Général contrôle le consentement. Si un magasin le définit sur Non, le plugin ne rapporte rien, quelles que soient les valeurs retournées par vos filtres.

API REST

Toutes les routes utilisent l'espace de noms saveto-wishlist/v1, donc le chemin complet est https://your-site.com/wp-json/saveto-wishlist/v1/ suivi du chemin dans les tableaux. Elles suivent l'authentification normale de l'API REST de WordPress. Le code du navigateur envoie l'en-tête X-WP-Nonce pour un utilisateur connecté, et d'autres clients peuvent utiliser un mot de passe d'application avec l'authentification HTTP Basic. Une requête refusée renvoie l'erreur rest_forbidden_context avec le statut 401 pour un appelant non connecté ou 403 pour un appelant connecté.

Routes client

Ces routes alimentent le bouton de liste de souhaits et la page de liste de souhaits.

La route POST /frontend/endpoints répond toujours avec HTTP 200 et un champ status, donc vérifiez status dans le corps. Un appelant qui ne possède pas la liste de souhaits obtient status défini sur error. Seuls les utilisateurs ayant la capacité manage_options peuvent écrire dans la liste de souhaits d'un autre utilisateur.

Cette requête liste les listes de souhaits du compte qui possède le mot de passe de l'application :

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

Ces filtres modifient qui passe les vérifications de la route client et ce que la route invité renvoie :

Routes d'administration

Les routes ci-dessous servent les écrans d'administration du plugin et peuvent changer entre les versions. Préférez les hooks ci-dessus pour les intégrations. Chaque route d'administration nécessite la capacité manage_options. Utilisez le filtre stwlite_api_admin_permissions_check ($response, $request) pour modifier cela, et faites attention lorsque vous élargissez l'accès, car ces routes peuvent écrire des options de site et supprimer des listes de souhaits.

Les sources d'importation intégrées sont yith, ti, moreconvert et wpc. Utilisez le filtre stwlite_available_importers, qui reçoit et renvoie un tableau associant un slug de source à un nom de classe d'importateur, pour en enregistrer une autre.

Questions fréquemment posées

Pourquoi mon filtre de placement ne fait-il rien ?

Le plugin lit le placement lors de son démarrage sur le hook setup_theme à la priorité 100. Ajoutez le filtre depuis un fichier de plugin. Le fichier functions.php d'un thème se charge après ce point.

Pourquoi mon balisage de bouton perd-il une balise ou un attribut ?

Le plugin traite le balisage du bouton via wp_kses(). Ajoutez la balise ou l'attribut à la liste d'autorisation avec le filtre stwlite_allowed_button_html.

Pourquoi la route d'enregistrement renvoie-t-elle HTTP 200 pour une requête refusée ?

POST /frontend/endpoints répond toujours avec HTTP 200 et place le résultat dans le champ status du corps. Lisez status et message au lieu du code HTTP.

Et ensuite

• Comment étendre SaveTo Wishlist Pro avec des hooks et l'API REST
• Comment étendre SaveTo Wishlist Registry avec des hooks et l'API REST
• Comment utiliser les capacités de l'IA dans SaveTo Wishlist

Besoin d'aide ?

Si vous avez une question ou rencontrez un problème, nous sommes là pour vous aider.

• Utilisateurs premium : Ouvrir un ticket de support
• Utilisateurs gratuits : Visitez notre forum communautaire