Beschikbare hooks en filters in Custom Login voor WooCommerce

U wilt dat klanten na het inloggen op een specifieke pagina terechtkomen, of u moet een link of een script toevoegen aan de inlogpagina. Custom Login for WooCommerce biedt u hooks voor beide, zodat u de pluginbestanden niet hoeft te bewerken. Het heeft ook een REST API-eindpunt dat de instellingen van de plugin vanuit code leest en bijwerkt.

Dit artikel behandelt de clwc_login_redirect filter, de clwc_after_login_form en clwc_login_footer acties, en het /settings REST API-eindpunt. Het bevat ook een korte tabel met drie kleinere hooks. Het instellen van de inlogpagina zelf wordt behandeld in Aan de slag met Custom Login for WooCommerce.

Dit is een ontwikkelaarsreferentie. Het gaat ervan uit dat u bekend bent met het toevoegen van PHP via een aangepaste plugin of het functions.php bestand van uw child theme. Als hooks nieuw voor u zijn, begin dan met de WordPress Plugin Handbook over hooks.

Vereisten

Hoe de hooks passen in de inlogpagina

De plugin serveert uw /login pagina vanuit zijn eigen zelfstandige template. Dat template laadt niet de header of footer van uw thema en roept wp_head() of wp_footer() niet aan. Dus een callback die is toegevoegd aan wp_head of wp_footer wordt nooit op deze pagina uitgevoerd. Gebruik in plaats daarvan de eigen hooks van de plugin hieronder.

Houd er rekening mee dat de redirect filter wordt uitgevoerd bij het indienen van het formulier, terwijl de twee acties worden uitgevoerd wanneer de inlogpagina wordt weergegeven.

Filter: clwc_login_redirect

Deze filter wijzigt waar een klant naartoe gaat direct na een succesvolle login. Het wordt niet uitgevoerd wanneer een login mislukt.

apply_filters( 'clwc_login_redirect', $redirect_to, $user );

Retourneer de gewenste URL. De beginwaarde van $redirect_to is de redirect_to waarde die aan de inlogpagina is doorgegeven, bijvoorbeeld uwwinkel.com/login/?redirect_to=.... Als er geen is, is het de URL van de accountpagina van uw WooCommerce.

Dit is wat er gebeurt nadat uw callback retourneert:

1. WooCommerce's eigen woocommerce_login_redirect filter wordt hierna uitgevoerd. Elke callback op die filter ziet uw resultaat en kan het opnieuw wijzigen.
2. De plugin controleert de uiteindelijke URL. Als deze verwijst naar een ander domein dat WordPress niet toestaat, stuurt de plugin de klant naar Mijn account.
3. De plugin stuurt de klant door.

Omdat woocommerce_login_redirect na clwc_login_redirect wordt uitgevoerd, kan een andere plugin op die filter uw redirect overschrijven. Als uw redirect lijkt te worden genegeerd, controleer dan op andere plugins die zich koppelen aan woocommerce_login_redirect.

Voorbeeld: stuur winkelbeheerders naar het dashboard

add_filter( 'clwc_login_redirect', function ( $redirect_to, $user ) {
	if ( in_array( 'shop_manager', (array) $user->roles, true ) ) {
		return admin_url();
	}

	return $redirect_to;
}, 10, 2 );

De 10 is de prioriteit van de callback, en de 2 vertelt WordPress dat je callback twee parameters accepteert. Zonder de 2 ontvang je $user niet.

Acties: clwc_after_login_form en clwc_login_footer

Beide acties laten je je eigen HTML op de inlogpagina afdrukken. Geen van beide geeft parameters door, dus je callback heeft geen argumenten nodig. Geef je inhoud weer met echo.

Voorbeeld: voeg een link toe onder het inlogformulier

add_action( 'clwc_after_login_form', function () {
	echo '<p><a href="' . esc_url( home_url( '/become-a-customer/' ) ) . '">Need an account? Apply here.</a></p>';
} );

Voorbeeld: voeg een tekstregel toe aan de paginavoettekst

add_action( 'clwc_login_footer', function () {
	echo '<p style="text-align:center;">Need help? Call us on 1300 000 000.</p>';
} );

clwc_login_footer wordt buiten het formulierpaneel uitgevoerd, dus je eigen CSS bepaalt waar de inhoud verschijnt. Gebruik clwc_after_login_form voor inhoud die bij het formulier hoort.

Andere hooks op de inlogpagina

Deze hooks zijn kleiner en minder gebruikelijk. Ze werken op dezelfde manier als de bovenstaande acties en filters.

Het inlogformulier voert ook de standaard inlog-hooks van WooCommerce uit: woocommerce_login_form_start, woocommerce_login_form en woocommerce_login_form_end. Daarom werken de meeste CAPTCHA- en beveiligingsplugins die op het WooCommerce-inlogformulier werken hier ook.

REST API: instellingen-eindpunt

De plugin heeft één REST API-eindpunt voor zijn instellingen. Hiermee kun je de huidige instellingen lezen of ze vanuit code bijwerken, bijvoorbeeld wanneer je veel winkels vanuit één script instelt.

/wp-json/clwc/v1/settings

Wie kan het gebruiken

Beide methoden vereisen een ingelogd account met de manage_woocommerce-mogelijkheid. Dat omvat beheerders en winkelbeheerders. Iedereen anders krijgt een 401- of 403-antwoord.

Voor een verzoek vanuit de browser terwijl je bent ingelogd, stuur de X-WP-Nonce-header met een wp_rest-nonce. Gebruik voor een verzoek van buiten WordPress een toepassingswachtwoord met basisauthenticatie.

Lees de instellingen

curl -u "admin:APPLICATION_PASSWORD" https://yourstore.com/wp-json/clwc/v1/settings

Het antwoord is een JSON-object. Elke instelling die u nog niet hebt opgeslagen, wordt teruggestuurd met de standaardwaarde, behalve logo_url, die ontbreekt in het antwoord totdat u een logo-URL opslaat.

Werk de instellingen bij

Verstuur een JSON-body met alleen de velden die u wilt wijzigen. Velden die u weglaat, blijven zoals ze zijn.

curl -X POST -u "admin:APPLICATION_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"template":"template-2","button_bg":"#e11d48","login_heading":"Welcome back"}' \
  https://yourstore.com/wp-json/clwc/v1/settings

Vanuit de browser kunt u wp.apiFetch op dezelfde manier gebruiken:

wp.apiFetch( {
	path: '/clwc/v1/settings',
	method: 'POST',
	data: { login_button_text: 'Sign in' },
} );

De plugin reinigt elke waarde voordat deze wordt opgeslagen. Een waarde van het verkeerde type wordt overgeslagen of leeg opgeslagen, en het verzoek slaagt nog steeds.

Velden die niet in de tabel staan, worden genegeerd. Bovendien vervangt rotation_items de hele opgeslagen lijst elke keer dat u deze verzendt, dus neem elk item op dat u wilt behouden.

Probleemoplossing

Veelgestelde vragen

Hulp nodig?

Custom Login for WooCommerce is een premium plugin, dus als je hulp nodig hebt met een specifieke aanpassing, open een supportticket en ons team kan je wijzen op de juiste hook voor jouw use case.