Stripe-ügyfél szűrői
Meglévő Stripe-ügyfél használata, új ügyfél létrehozása és az ügyfél utólagos módosítása a gform_stripe_customer_id és a gform_stripe_customer_after_create segítségével.
A két szűrő a Stripe-ügyfél (Customer) körül ad beavatkozási lehetőséget: az egyikkel megadhatod, melyik meglévő ügyfelet használja a bővítmény, a másikkal az ügyfél létrehozása után végezhetsz egyedi műveletet. A kódot az aktív téma functions.php fájljába, saját funkcióbővítő bővítménybe, saját Add-On-ba vagy kódrészlet-kezelő bővítménybe teheted.
gform_stripe_customer_id: meglévő ügyfél megadása
Szekció neve “gform_stripe_customer_id: meglévő ügyfél megadása”A szűrő minden Stripe-feedre lefut, és megadhatod vele a Stripe ügyfélazonosítóját, amelyet az űrlap feldolgozásához használjon a bővítmény.
add_filter( 'gform_stripe_customer_id', 'your_function_name', 10, 4 );| Paraméter | Típus | Jelentés |
|---|---|---|
$customer_id |
string | A Stripe ügyfélazonosítója. Alapból üres szöveg, ilyenkor új ügyfél jön létre. |
$feed |
Feed Object | A feldolgozott Stripe-feed. |
$entry |
Entry Object | A feldolgozott bejegyzés. |
$form |
Form Object | A feldolgozott űrlap. |
Azonosító a felhasználó metaadataiból
Szekció neve “Azonosító a felhasználó metaadataiból”Bejelentkezett felhasználónál az ügyfélazonosítót a felhasználó metaadataiból olvashatod ki. (Az azonosító mentésére lásd a gform_stripe_customer_after_create példáját lent.)
add_filter( 'gform_stripe_customer_id', 'get_stripe_customer_id', 10, 4 );function get_stripe_customer_id( $customer_id ) {
if ( is_user_logged_in() ) { $user_id = get_current_user_id(); $customer_id = get_user_meta( $user_id, '_stripe_customer_id', true ); gf_stripe()->log_debug( __METHOD__ . "(): Retrieved Stripe Customer ID {$customer_id} from WP user ID {$user_id}" ); }
return $customer_id;}Új ügyfél létrehozása
Szekció neve “Új ügyfél létrehozása”A példa csak Termékek és szolgáltatások feedekre fut, és csak a megadott nevű feedekre. A $feed_names tömbbe a saját feedjeid neve kerüljön, a Név és a Telefon mező azonosítóját pedig igazítsd az űrlapodhoz (vagy töröld azokat a sorokat). A támogatott paramétereket a Stripe ügyfél-létrehozási API-ja határozza meg.
add_filter( 'gform_stripe_customer_id', function ( $customer_id, $feed, $entry, $form ) {
$feed_name = rgars( $feed, 'meta/feedName' );
gf_stripe()->log_debug( 'gform_stripe_customer_id: Running for Feed: ' . $feed_name );
// A feedek nevei, amelyekre a kód fusson. $feed_names = array( 'feed name one', 'feed name two' );
// Kilépés, ha másik feed dolgozza fel, vagy nem termék és szolgáltatás típusú. if ( rgars( $feed, 'meta/transactionType' ) !== 'product' || ! in_array( $feed_name, $feed_names ) ) { return $customer_id; }
if ( empty( $customer_id ) ) {
$response = gf_stripe()->get_stripe_js_response();
if ( ! empty( $response->id ) && substr( $response->id, 0, 3 ) === 'pi_' ) { try { $intent = \Stripe\PaymentIntent::retrieve( $response->id ); if ( ! empty( $intent->customer ) ) { gf_stripe()->log_debug( 'gform_stripe_customer_id: PaymentIntent has customer: ' . print_r( $intent->customer, true ) ); return is_object( $intent->customer ) ? $intent->customer->id : $intent->customer; } } catch ( \Exception $e ) { gf_stripe()->log_debug( 'gform_stripe_customer_id: unable to get PaymentIntent; ' . $e->getMessage() ); } }
$customer_params = array();
$email_field = rgars( $feed, 'meta/receipt_field' ); if ( ! empty( $email_field ) && strtolower( $email_field ) !== 'do not send receipt' ) { $customer_params['email'] = gf_stripe()->get_field_value( $form, $entry, $email_field ); }
// Nem kötelező: az ügyfél neve a 8-as Név mezőből. $customer_params['name'] = rgar( $entry, '8.3' ) . ' ' . rgar( $entry, '8.6' ); gf_stripe()->log_debug( __METHOD__ . '(): Name: ' . $customer_params['name'] );
// Nem kötelező: az ügyfél telefonszáma az 5-ös Telefon mezőből. $customer_params['phone'] = rgar( $entry, '5' ); gf_stripe()->log_debug( __METHOD__ . '(): Phone: ' . $customer_params['phone'] );
$customer = gf_stripe()->create_customer( $customer_params, $feed, $entry, $form ); $customer_id = $customer->id;
gf_stripe()->log_debug( 'gform_stripe_customer_id: Returning Customer ID: ' . $customer_id ); }
return $customer_id;}, 10, 4 );Tranzakciók csoportosítása e-mail-cím szerint
Szekció neve “Tranzakciók csoportosítása e-mail-cím szerint”A példa ugyanahhoz az e-mail-címhez tartozó tranzakciókat és előfizetéseket egyetlen Stripe-ügyfél alá gyűjti. Ha a megadott e-mail-címmel már van ügyfél a Stripe-ban, a szűrő annak azonosítóját adja vissza. Ha nincs találat, üres szöveget ad vissza, és új ügyfél jön létre. A feedben megfeleltetett e-mail mezőt használja.
add_filter( 'gform_stripe_customer_id', function ( $customer_id, $feed, $entry, $form ) { // A Stripe API betöltése. $api = ( new Gravity_forms\Gravity_Forms_Stripe\Elements\Elements_Handler() )->get_api( $feed ); // A feedben megfeleltetett e-mail mező értéke. $email = gf_stripe()->get_field_value( $form, $entry, rgars( $feed, 'meta/customerInformation_email' ) ); // Ügyfélkeresés e-mail-cím alapján (az első egyezést adja vissza). $customer = $api->get_customer_by_email( $email ); // Találat esetén az azonosító, különben üres szöveg (új ügyfél jön létre). return $customer ? $customer->id : '';}, 10, 4 );gform_stripe_customer_after_create: művelet az ügyfél létrehozása után
Szekció neve “gform_stripe_customer_after_create: művelet az ügyfél létrehozása után”Ez egy művelet (action) típusú horog, amely az ügyfél létrehozása és az előfizetéshez rendelése között fut. Az Előfizetés típusú feedekre fut le.
add_action( 'gform_stripe_customer_after_create', 'your_function_name', 10, 4 );| Paraméter | Típus | Jelentés |
|---|---|---|
$customer |
Stripe Customer Object | A most létrehozott Stripe-ügyfél. |
$feed |
Feed Object | A feldolgozott Stripe-feed. |
$entry |
Entry Object | A feldolgozott, még nem mentett bejegyzés. |
$form |
Form Object | A feldolgozott űrlap. |
Számlatétel létrehozása
Szekció neve “Számlatétel létrehozása”A példa egy díjat ad az ügyfél következő számlájához. Ez a Stripe Checkout fizetésbeszedési móddal nem működik. Az 5-ös mező azonosítóját és a feed nevét cseréld a sajátodra.
add_action( 'gform_stripe_customer_after_create', 'add_invoice_item', 10, 4 );function add_invoice_item( $customer, $feed, $entry, $form ) {
$feed_name = rgars( $feed, 'meta/feedName' ); if ( $feed_name !== 'feed name goes here' ) { return; }
$currency = rgar( $entry, 'currency' ); $amount = gf_stripe()->get_amount_export( rgar( $entry, '5' ), $currency ); // Írd át a mező azonosítóját.
$item = array( 'amount' => $amount, 'currency' => $currency, 'description' => 'Some fee', );
gf_stripe()->log_debug( 'gform_stripe_customer_after_create: Invoice item => ' . print_r( $item, true ) );
$result = $customer->addInvoiceItem( $item );
gf_stripe()->log_debug( 'gform_stripe_customer_after_create: Result => ' . print_r( $result, true ) );}Az ügyfélazonosító mentése
Szekció neve “Az ügyfélazonosító mentése”Bejelentkezett felhasználónál az ügyfélazonosító a felhasználó metaadataiba menthető. A mentett értéket a gform_stripe_customer_id szűrő olvashatja vissza (lásd fent).
add_action( 'gform_stripe_customer_after_create', 'save_stripe_customer_id' );function save_stripe_customer_id( $customer ) { if ( is_user_logged_in() ) { $user_id = get_current_user_id(); update_user_meta( $user_id, '_stripe_customer_id', $customer->id );
gf_stripe()->log_debug( __METHOD__ . "(): Saved Stripe Customer ID {$customer->id} to user {$user_id}" ); }}Az ügyfél adatainak módosítása a Stripe-ban
Szekció neve “Az ügyfél adatainak módosítása a Stripe-ban”A példa a Stripe-ügyfél nevét és címét frissíti az űrlap mezőiből (itt a 3-as azonosítójú űrlapon, az 1-es Név mező alapján). A kód csak akkor működik, ha a fizetésbeszedés módja a Stripe-mező.
add_action( 'gform_stripe_customer_after_create', 'update_customer_data', 10, 4 );function update_customer_data( $customer, $feed, $entry, $form ) {
if ( (int) $form['id'] !== 3 ) { return; }
gf_stripe()->log_debug( __METHOD__ . '(): Running' );
$name = rgar( $entry, '1.3' ) . ' ' . rgar( $entry, '1.6' );
$customer_data = array( 'name' => $name, 'address' => array( 'line1' => gf_stripe()->get_field_value( $form, $entry, rgars( $feed, 'meta/billingInformation_address_line1' ) ), 'line2' => gf_stripe()->get_field_value( $form, $entry, rgars( $feed, 'meta/billingInformation_address_line2' ) ), 'city' => gf_stripe()->get_field_value( $form, $entry, rgars( $feed, 'meta/billingInformation_address_city' ) ), 'state' => gf_stripe()->get_field_value( $form, $entry, rgars( $feed, 'meta/billingInformation_address_state' ) ), 'postal_code' => gf_stripe()->get_field_value( $form, $entry, rgars( $feed, 'meta/billingInformation_address_zip' ) ), ), );
$country = gf_stripe()->get_field_value( $form, $entry, rgars( $feed, 'meta/billingInformation_address_country' ) ); if ( $country ) { $code = GF_Fields::get( 'address' )->get_country_code( $country ); if ( $code ) { $customer_data['address']['country'] = $code; } }
$result = $customer->update( $customer->id, $customer_data );
gf_stripe()->log_debug( __METHOD__ . '(): Result => ' . print_r( $result, true ) );}Készült: