Potrzebujesz zmienić sposób działania SaveTo Wishlist Pro bez edycji wtyczki? Możesz to zrobić za pomocą haków WordPress i API REST wtyczki. W tym artykule wymieniono haki i trasy, których możesz użyć, wraz z argumentami, które każdy z nich przekazuje, i krótkimi przykładami PHP. Wszystko tutaj dotyczy SaveTo Wishlist Pro w wersji 1.0.4.
Zanim zaczniesz
SaveTo Wishlist Pro działa na bazie SaveTo Wishlist Lite, więc obie wtyczki muszą być aktywne. Umieść swój kod haków w małej niestandardowej wtyczce lub wtyczce „must-use”, a nie w plikach SaveTo Wishlist Pro, ponieważ aktualizacje wtyczki zastępują te pliki.
Każda nazwa haka Pro zaczyna się od stwpro_. Haki dla darmowej wtyczki są opisane w Jak rozszerzyć SaveTo Wishlist za pomocą haków i API REST.
Poniższe haki i filtry są wymienione wraz z przekazywanymi argumentami. Dodając filtr, ustaw liczbę akceptowanych argumentów, aby pasowała, w przeciwnym razie WordPress przekaże Ci tylko pierwszy argument. Zwróć pierwszy argument (lub jego zmienioną kopię) z każdego filtra.
Trasy REST API
Wszystkie trasy SaveTo Wishlist Pro używają przestrzeni nazw saveto-wishlist-pro/v1, więc pełny adres URL wygląda tak: https://example.com/wp-json/saveto-wishlist-pro/v1/analytics/products-insight.
Kto może wywoływać trasy
Trasy analityczne, automatyzacji, domyślnych list życzeń i licencji obsługują własne ekrany administracyjne wtyczki i mogą ulec zmianie. Odpowiadają one tylko na żądania zalogowanego użytkownika, który ma uprawnienie manage_options (domyślnie administratorzy). Każdy inny otrzyma błąd 401 lub 403. Wyślij żądanie z normalną sesją logowania WordPress i noncem REST, lub z dowolną inną obsługiwaną przez Twoją witrynę metodą uwierzytelniania REST.
Trasy odczytu analityki, trasy automatyzacji i trasy licencji mają również limit żądań na użytkownika. Żądania odczytu (GET) otrzymują 300 żądań na minutę. Wszystkie inne metody otrzymują 60 żądań na minutę. Po przekroczeniu limitu trasa zwraca błąd 429 z kodem rate_limit_exceeded. Limity można zmienić za pomocą filtra stwpro_api_rate_limit, opisanego poniżej.
Trasy analityczne
Podstawowa ścieżka to /analytics.
| Trasa | Metoda | Kto może ją wywołać | Co robi |
|---|---|---|---|
/analytics/products-insight | GET | Administratorzy, z limitem żądań | Zwraca najpopularniejsze, najczęściej oglądane i ostatnio dodane produkty. Akceptuje parametr period z wartością 7days lub 30days. Domyślnie jest to 7days. |
/analytics/category-brand-insight | GET | Administratorzy, z limitem żądań | Zwraca analizy kategorii i marek. |
/analytics/engagement-insight | GET | Administratorzy, z limitem żądań | Zwraca analizy zaangażowania dla produktów. |
/analytics/timebased-trends | GET | Administratorzy, z limitem żądań | Zwraca trendy w czasie. Akceptuje parametr range z wartością 7days, 30days, 90days lub 365days. Domyślnie jest to 30days. |
/analytics/customer-behavior | GET | Administratorzy, z limitem żądań | Zwraca analizy zachowań klientów, w tym najlepszych twórców list życzeń i segmentów klientów. |
/analytics/refresh | POST | Administratorzy | Czyści pamięć podręczną analityki. Użytkownik może odświeżyć raz na 30 sekund. Szybsze żądanie zwraca błąd 429 z kodem cooldown_active. |
Odpowiedzi analityczne są domyślnie buforowane przez godzinę. Pomyślne wywołanie /analytics/refresh czyści pamięć podręczną, dzięki czemu następne odczytanie zwraca świeże dane.
Ten przykład odczytuje najpopularniejsze produkty z ostatnich 30 dni z przeglądarki, w skrypcie uruchamianym na ekranie administratora WordPress:
wp.apiFetch( {
path: '/saveto-wishlist-pro/v1/analytics/products-insight?period=30days',
} ).then( ( data ) => {
console.log( data.most_popular, data.trending, data.recently_added );
} );Trasy automatyzacji
Ścieżka bazowa to /automations. Wszystkie cztery trasy wymagają administratora i są ograniczone czasowo.
| Trasa | Metoda | Co robi |
|---|---|---|
/automations/get-automations | GET | Zwraca zapisane automatyzacje. Parametry zapytania są używane jako filtry. |
/automations/save-automation | POST | Tworzy lub aktualizuje automatyzację. Odczytuje id, trigger_type, action_type, status, description i action_data. |
/automations/delete-automation | USUŃ | Usuwa automatyzację z identyfikatorem w parametrze id. Zwraca błąd 400, gdy identyfikator jest pusty. |
/automations/send-test-email | POST | Wysyła przykładowy e-mail testowy z fikcyjnymi danymi. Odczytuje email_to, email_subject i email_body. |
Domyślne trasy list życzeń
Ścieżka bazowa to /default-wishlists. Wszystkie trasy wymagają administratora.
| Trasa | Metoda | Co robi |
|---|---|---|
/default-wishlists/settings | GET, POST | Odczytuje lub zapisuje domyślne ustawienia list życzeń. Żądanie POST odczytuje parametr list. |
/default-wishlists/migration-status | GET | Zwraca postęp zadania tworzenia domyślnych list życzeń dla istniejących użytkowników, którzy ich nie mają, oraz ilu użytkowników nadal się kwalifikuje. |
/default-wishlists/start-migration | POST | Rozpoczyna to zadanie. |
/default-wishlists/cancel-migration | POST | Anuluje to zadanie. |
Trasa Webhook
Trasa /webhook/wishlist-created różni się od pozostałych. Nie używa logowania WordPress. Używa klucza API webhook, wysyłanego w nagłówku x-api-key lub jako parametr zapytania api_key, i odpowiada kodem 401, gdy klucz jest brakujący lub nieprawidłowy. Żądanie POST uruchamia akcję stwpro_wishlist_created. Żądanie GET z parametrem wishlist_id zwraca publiczną, opublikowaną listę życzeń. Szczegółowe informacje o konfiguracji i bezpieczeństwie można znaleźć w Jak połączyć zewnętrzne narzędzia za pomocą webhooków list życzeń oraz Jak zabezpieczyć punkt końcowy API webhook SaveTo Wishlist Pro.
Filtry dla uprawnień tras
| Filtr | Argumenty | Co robi |
|---|---|---|
stwpro_api_admin_permissions_check | $response, $request | Filtruje wynik sprawdzenia administratora dla tras dostępnych tylko dla administratorów. Zwróć true, aby zezwolić, lub WP_Error, aby odmówić. |
stwpro_webhook_permissions_check | $response, $request | Filtruje wynik sprawdzenia klucza API dla trasy webhook. |
stwpro_api_rate_limit | $limit, $request, $is_read | Ustawia dozwoloną liczbę żądań na minutę. Domyślnie jest to 300 dla żądań odczytu i 60 dla pozostałych. |
stwpro_api_rate_limit_check | $result, $request | Filtruje ostateczny wynik sprawdzenia limitu żądań. |
Na przykład, to zwiększa limit zapisu do 120 żądań na minutę:
add_filter( 'stwpro_api_rate_limit', function ( $limit, $request, $is_read ) {
return $is_read ? $limit : 120;
}, 10, 3 );Haczyki automatyzacji
Automatyzacje łączą wyzwalacz, taki jak promocja produktu, z akcją, taką jak wysłanie wiadomości e-mail. Te haczyki pozwalają dodawać własne akcje i zmieniać dane wysyłane przez wbudowane akcje.
Dodaj własną akcję automatyzacji
Dwa filtry działają razem. Użyj stwpro_automation_actions, aby dodać swoją akcję do listy akcji, i użyj stwpro_automation_action_handlers, aby określić, która funkcja ją obsługuje. Wbudowane typy akcji to send_email, call_webhook i update_user_meta.
| Filtr | Argumenty | Co robi |
|---|---|---|
stwpro_automation_actions | $actions | Filtruje listę typów akcji. Każdy element to klucz akcji i jej etykieta. |
stwpro_automation_action_handlers | $handlers | Filtruje mapę typów akcji na obsługujące je funkcje. Funkcja obsługująca musi być wywoływalna. Jeśli Twój callback zwróci coś innego niż tablicę, wtyczka zignoruje to i zachowa wbudowane funkcje obsługujące. |
WordPress wywoła Twoją funkcję obsługującą z pięcioma argumentami: aktywnymi automatyzacjami tego typu dla wyzwalacza, danymi automatyzacji, obiektem kontekstu wyzwalacza, wartością logiczną dla warunku kategorii produktu i tablicą dodatkowych parametrów.
add_filter( 'stwpro_automation_actions', function ( $actions ) {
$actions['send_to_crm'] = __( 'Send to my CRM', 'my-plugin' );
return $actions;
} );
add_filter( 'stwpro_automation_action_handlers', function ( $handlers ) {
$handlers['send_to_crm'] = 'my_plugin_process_crm_automations';
return $handlers;
} );
function my_plugin_process_crm_automations( $automations, $automation_data, $context_data, $category_condition, $params ) {
foreach ( $automations as $automation ) {
// Send $automation_data to your CRM here.
}
}Zmień odbiorcę wiadomości e-mail z automatyzacji
Dwa filtry ustawiają odbiorcę wiadomości e-mail. stwpro_automation_filter_email_to_customer jest wywoływany raz dla każdego właściciela listy życzeń dla wyzwalaczy „produkt w promocji” i „produkt ponownie w magazynie”. stwpro_automation_filter_email_to jest wywoływany dla wszystkich innych wyzwalaczy. W obu przypadkach pusty lub nieprawidłowy adres pomija wysłanie wiadomości e-mail.
| Filtr | Argumenty |
|---|---|
stwpro_automation_filter_email_to | $email_to, $action_data, $context_data, $data, $params |
stwpro_automation_filter_email_to_customer | $email_to, $action_data, $per_customer_data, $context_data, $params |
Ten przykład wysyła wszystkie wiadomości e-mail z automatyzacji na adres testowy na stronie staging i pomija klientów, którzy zrezygnowali z subskrypcji:
add_filter( 'stwpro_automation_filter_email_to', function ( $email_to ) {
if ( 'production' !== wp_get_environment_type() ) {
return '[email protected]';
}
return $email_to;
}, 10, 1 );
add_filter( 'stwpro_automation_filter_email_to_customer', function ( $email_to, $action_data, $per_customer_data ) {
$customer_id = (int) ( $per_customer_data['customer_id'] ?? 0 );
if ( $customer_id && get_user_meta( $customer_id, 'no_wishlist_alerts', true ) ) {
return '';
}
return $email_to;
}, 10, 3 );Zmień zawartość i dane automatyzacji
Te cztery filtry przekazują wartość, którą filtrujesz jako pierwszą. Kolejne argumenty to rekord automatyzacji, ustawienia akcji, kontekst wyzwalacza, rozwiązane dane zmiennych i dodatkowe parametry. Działają one przed zastąpieniem tagów zmiennych przez wtyczkę, więc Twoje zmiany mogą nadal zawierać tagi, takie jak {customer_name}.
| Filtr | Argumenty | Co filtruje |
|---|---|---|
stwpro_automation_email_subject_template | $subject_template, $automation, $action_data, $context_data, $data, $params | Surowy temat wiadomości e-mail. |
stwpro_automation_email_message_template | $message_template, $automation, $action_data, $context_data, $data, $params | Surowa treść wiadomości e-mail. |
stwpro_automation_webhook_payload_template | $payload_template, $automation, $action_data, $context_data, $data, $params | Surowa ładunek webhooka. |
stwpro_automation_usermeta_meta_value_template | $meta_value, $automation, $action_data, $context_data, $data, $params | Surowa wartość dla akcji aktualizacji metadanych użytkownika. |
Trzy dodatkowe filtry mają własne argumenty:
| Filtr | Argumenty | Co filtruje |
|---|---|---|
stwpro_automation_variables | $trigger_variables, $trigger_type | Tagi zmiennych dostępne dla wyzwalacza. |
stwpro_automation_webhook_recipes | $recipes | Przepisy szybkiego startu webhooka. |
stwpro_automations_get_all_automations | $automations, $trigger_type, $action_type | Aktywne automatyzacje dla typu wyzwalacza i akcji. |
Dla danych zmiennych każdego wyzwalacza użyj jednego z tych filtrów. Wszystkie przekazują $variable_data, $trigger_type, $context_data.
stwpro_automation_data_wishlist_createdstwpro_automation_data_item_added_to_wishliststwpro_automation_data_item_removed_from_wishliststwpro_automation_data_product_on_salestwpro_automation_data_product_back_in_stock
Haczyki analityczne
Progi poziomu i segmentu klienta
Analizy klientów przypisują każdego najlepszego klienta do odpowiedniego poziomu. Klient osiąga poziom, gdy spełnione są oba warunki: liczba produktów na liście życzeń i całkowita wydana kwota. Wtyczka sprawdza poziomy od platynowego do brązowego, a klienci, którzy nie spełniają żadnych, są traktowani jako zwykli. Każdy filtr przyjmuje jeden argument, wartość domyślną, i zwraca liczbę.
| Poziom | Filtr liczby produktów na liście życzeń | Domyślnie | Filtr wydatków | Domyślnie |
|---|---|---|---|---|
| Platynowy | stwpro_admin_platinum_threshold | 8 | stwpro_admin_platinum_spent_threshold | 1500 |
| Złoty | stwpro_admin_gold_threshold | 5 | stwpro_admin_gold_spent_threshold | 800 |
| Srebro | stwpro_admin_silver_threshold | 3 | stwpro_admin_silver_spent_threshold | 400 |
| Brąz | stwpro_admin_bronze_threshold | 2 | stwpro_admin_bronze_spent_threshold | 200 |
add_filter( 'stwpro_admin_platinum_threshold', function () {
return 10;
} );
add_filter( 'stwpro_admin_platinum_spent_threshold', function () {
return 2500;
} );Inne filtry analityczne zmieniają segmenty klientów i listy wyświetlane na ekranach analitycznych:
| Filtr | Argumenty | Domyślnie | Co robi |
|---|---|---|---|
stwpro_admin_vip_threshold | $value | 5 | Liczba produktów na liście życzeń dla segmentu klientów VIP. |
stwpro_admin_vip_spent_threshold | $value | 800 | Całkowita kwota wydana dla segmentu klientów VIP. |
stwpro_admin_inactive_days | $value | 90 | Dni bez aktywności, po których klient jest uznawany za nieaktywnego. |
stwpro_admin_top_wishlisters_limit | $limit | 15 | Ile klientów zwraca lista najlepszych klientów z listą życzeń. |
stwpro_admin_top_wishlisters_excluded_roles | $excluded_roles | array( 'administrator', 'shop_manager' ) | Role wykluczone z listy najlepszych klientów z listą życzeń. |
stwpro_admin_customer_segments | $segments, $total_customers | Brak | Ostateczna lista segmentów klientów. |
Dane analityczne, pamięć podręczna i odświeżanie
| Hook | Typ i argumenty | Co robi |
|---|---|---|
stwpro_analytics_products_insight_data | Filtr: $products_insight, $request | Zmienia dane zwracane przez trasę produktów-insight. |
stwpro_analytics_products_insight_cache_duration | Filtr: $seconds | Ustawia czas przechowywania tej odpowiedzi w pamięci podręcznej. Domyślnie jest to jedna godzina. Trasy dotyczące kategorii i marki, zaangażowania, trendów czasowych i zachowań klientów mają odpowiadające im filtry: stwpro_analytics_category_brand_insight_cache_duration, stwpro_analytics_engagement_insight_cache_duration, stwpro_analytics_timebased_trends_cache_duration i stwpro_analytics_customer_behavior_cache_duration. |
stwpro_analytics_refresh_cooldown | Filtr: $seconds | Ustawia liczbę sekund oczekiwania użytkownika między odświeżeniami. Domyślnie jest to 30. Zwróć 0, aby wyłączyć oczekiwanie. |
stwpro_analytics_refreshed | Akcja: $timestamp | Uruchamiana po odświeżeniu, które czyści pamięć podręczną. Użyj jej do odbudowania własnych danych pochodnych. |
Powyższe progi są odczytywane podczas obliczania analiz. Jeśli zmienisz jeden z nich, a ekran się nie zmieni, odśwież analizy, aby odbudować wyniki z pamięci podręcznej.
Domyślne haki list życzeń
Te haki kontrolują listy życzeń, które Pro automatycznie tworzy dla nowych użytkowników.
| Hook | Typ i argumenty | Co robi |
|---|---|---|
stwpro_default_wishlists_sync_threshold | Filtr: $threshold | Jeśli skonfigurowana lista zawiera więcej list życzeń niż ta liczba, Pro tworzy je w tle za pomocą Action Scheduler zamiast podczas rejestracji. Domyślnie jest to 3. |
stwpro_default_wishlists_max_entries | Filtr: $max | Maksymalna liczba domyślnych list życzeń, które można zapisać na liście. Domyślnie jest to 20. |
stwpro_after_seed_default_wishlists | Akcja: $user_id, $created, $list | Uruchamiana po tym, jak użytkownik otrzyma domyślne listy życzeń. $created to liczba utworzonych list życzeń. Nie uruchamia się, gdy żadna nie została utworzona. |
add_action( 'stwpro_after_seed_default_wishlists', function ( $user_id, $created, $list ) {
update_user_meta( $user_id, 'default_wishlists_created', $created );
}, 10, 3 );Inne haki
| Hook | Typ i argumenty | Co robi |
|---|---|---|
stwpro_wholesale_price | Filtr: $price, $product_id, $user, $user_wholesale_role | Pozwala innemu wtyczce hurtowej dostarczyć cenę hurtową. Zwróć liczbę zmiennoprzecinkową, aby pominąć wyszukiwanie Cen hurtowych. Zwróć false, aby użyć domyślnego wyszukiwania. |
stwpro_disable_abilities | Filtr: $disabled | Zwróć true, aby zapobiec rejestrowaniu przez Pro jego możliwości. Możesz również zdefiniować stałą STWPRO_DISABLE_ABILITIES jako true. |
stwpro_show_powered_by_in_email | Filtr: $show | Zwróć false, aby usunąć linię „Powered by SaveTo Wishlist” z wiadomości e-mail wysyłanych przez Pro. |
stwpro_wishlist_created | Akcja: $wishlist_data, $wishlist_items | Uruchamiane, gdy prawidłowe żądanie POST dotrze do trasy webhook /webhook/wishlist-created. |
add_filter( 'stwpro_show_powered_by_in_email', '__return_false' );Często zadawane pytania
Czy mogę wywoływać trasy analityczne lub automatyzacji spoza WordPress?
Tylko jako zalogowany administrator. Te trasy sprawdzają uprawnienia manage_options i obsługują własne ekrany wtyczki, więc korzystaj z powyższych haków do wszystkiego, co musi pozostać stabilne. W przypadku zewnętrznych systemów użyj trasy webhook z kluczem API.
Dlaczego moje zmiany progów nie wyświetlają się na ekranie analityki?
Wyniki analityki są buforowane, domyślnie przez godzinę. Odśwież analitykę lub skróć czas buforowania za pomocą filtrów czasu buforowania, a nowe progi zaczną obowiązywać.
Potrzebujesz pomocy?
Jeśli masz pytanie lub napotkasz jakiekolwiek problemy, jesteśmy tutaj, aby pomóc.
- Użytkownicy premium: Otwórz zgłoszenie wsparcia
- Użytkownicy darmowi: Odwiedź nasze forum społeczności
