Terhelés, leírás és Elements-beállítás szűrői
Csak engedélyezés (authorization only), a terhelési leírás és a terhelés tulajdonságainak módosítása, valamint a Stripe Elements konfigurációjának szűrése.
Ezek a szűrők az egyszeri fizetések (Termékek és szolgáltatások feedek) terhelését módosítják. A PHP-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. Az elements/config szűrő JavaScript, lásd lent.
gform_stripe_charge_authorization_only: csak engedélyezés, terhelés nélkül
Szekció neve “gform_stripe_charge_authorization_only: csak engedélyezés, terhelés nélkül”A szűrő megakadályozza, hogy a bővítmény a bejegyzés mentése után elküldje a terhelési (capture) kérést, így a Stripe csak lefoglalja az összeget a kártyán, de nem vonja le.
- Csak a Stripe Card Elementtel (kártyamező) használható, vagyis ha a Stripe-mezőben a Use Stripe’s Payment Element ki van kapcsolva. Payment Element esetén a
gform_stripe_payment_element_authorization_onlyszűrőt használd. - Csak Termékek és szolgáltatások feedekre vonatkozik. Előfizetéseknél nem működik, mert a Stripe az előfizetés első fizetését azonnal beszedi.
add_filter( 'gform_stripe_charge_authorization_only', 'your_function_name', 10, 5 );| Paraméter | Típus | Jelentés |
|---|---|---|
$authorization_only |
bool | Alapból false. true visszaadásával a fizetés nem kerül beszedésre. |
$feed |
Feed Object | A feldolgozott feed. |
$submission_data |
Submission Data | Az űrlap címe, a fizetendő összeg, a beállítási díj, a próbaidőszak összege, a tételek és a kuponkedvezmények. |
$form |
Form Object | A feldolgozott űrlap. |
$entry |
Entry Object | A bejegyzés, amelyből a fizetés készül. |
Minden termék- és szolgáltatásfeedre:
add_filter( 'gform_stripe_charge_authorization_only', '__return_true' );Csak egy adott feedre, a feed neve alapján:
add_filter( 'gform_stripe_charge_authorization_only', 'stripe_charge_authorization_only', 10, 2 );
function stripe_charge_authorization_only( $authorization_only, $feed ) { gf_stripe()->log_debug( __METHOD__ . '(): Running...' );
$feed_name = rgars( $feed, 'meta/feedName' );
if ( $feed_name === 'a feed neve' ) { gf_stripe()->log_debug( __METHOD__ . '(): Authorization only charge for feed ' . $feed_name ); return true; }
return $authorization_only;}gform_stripe_charge_description: a terhelés leírása
Szekció neve “gform_stripe_charge_description: a terhelés leírása”A szűrővel a Termékek és szolgáltatások feedek terhelési leírását módosíthatod, mielőtt az a Stripe-hoz kerülne. Minden fizetésbeszedési módnál működik. Az alapértelmezett leírás például így néz ki: Entry ID: 123, Products: Product A, Product B, Product C.
add_filter( 'gform_stripe_charge_description', 'your_function_name', 10, 5 );| Paraméter | Típus | Jelentés |
|---|---|---|
$description |
string | A módosítandó leírás. |
$strings |
array | A bejegyzés azonosítóját (entry_id) és a termékeket (products) tartalmazó tömb, amelyből a leírás összeállt. |
$entry |
Entry Object | A feldolgozott bejegyzés. |
$submission_data |
Submission Data | Az űrlap címe, az összeg, a beállítási díj, a próbaidőszak összege, a tételek és a kedvezmények. |
$feed |
Feed Object | A feldolgozott feed. |
A bejegyzés azonosítójának elhagyása:
add_filter( 'gform_stripe_charge_description', 'remove_entry_id', 10, 2 );function remove_entry_id( $description, $strings ) { unset( $strings['entry_id'] ); return implode( ', ', $strings );}Egy mezőérték hozzáfűzése (itt az 1-es Név mező keresztneve és vezetékneve):
add_filter( 'gform_stripe_charge_description', 'append_field_value', 10, 3 );function append_field_value( $description, $strings, $entry ) { return $description . ', Name: ' . rgar( $entry, '1.3' ) . ' ' . rgar( $entry, '1.6' );}Az alapértelmezett leírás teljes lecserélése egyetlen feedre (itt az „Invoice Payment via Stripe” nevűre), egy mezőérték (21-es azonosító) felhasználásával:
add_filter( 'gform_stripe_charge_description', 'gf_replace_charge_description', 10, 5 );function gf_replace_charge_description( $description, $strings, $entry, $submission_data, $feed ) { GFCommon::log_debug( __METHOD__ . '(): running.' ); $feed_name = rgars( $feed, 'meta/feedName' );
// Írd át a saját feednevedre. if ( 'Invoice Payment via Stripe' != $feed_name ) { return $description; }
// A 21-et cseréld a saját meződ azonosítójára. $description = 'Invoice Payment for #' . rgar( $entry, '21' );
GFCommon::log_debug( __METHOD__ . '(): Custom Description: ' . $description ); return $description;}A leírás módosításáról szóló lépésenkénti útmutató a A fizetési leírás módosítása fejezetben van.
gform_stripe_charge_pre_create: a terhelés tulajdonságainak felülírása
Szekció neve “gform_stripe_charge_pre_create: a terhelés tulajdonságainak felülírása”A szűrővel a terhelés (charge) tulajdonságait írhatod felül, mielőtt a bővítmény létrehozza a Stripe API-n keresztül. A $charge_meta['metadata'] tulajdonságot ne írd felül ezzel.
- A 3.0-s verziótól a Stripe Checkout fizetésbeszedési módnál nem használható: ott a
gform_stripe_session_dataszűrő a megfelelő. - Csak Termékek és szolgáltatások feedekre vonatkozik. Ha a Stripe-mezőben be van kapcsolva a Use Stripe’s Payment Element, a
gform_stripe_payment_element_initial_payment_informationszűrővel együtt kell használni.
add_filter( 'gform_stripe_charge_pre_create', 'your_function_name', 10, 5 );| Paraméter | Típus | Jelentés |
|---|---|---|
$charge_meta |
array | A létrehozandó terhelés tulajdonságai. |
$feed |
Feed Object | A feldolgozott feed. |
$submission_data |
Submission Data | Az űrlap címe, az összeg, a beállítási díj, a próbaidőszak összege, a tételek és a kedvezmények. |
$form |
Form Object | A feldolgozott űrlap. |
$entry |
Entry Object | A bejegyzés, amelyből a fizetés készül. |
A bankszámlakivonaton látszó statement_descriptor megadása (a követelményeket a Stripe írja elő):
add_filter( 'gform_stripe_charge_pre_create', 'stripe_charge_pre_create', 10, 5 );function stripe_charge_pre_create( $charge_meta, $feed, $submission_data, $form, $entry ) { $charge_meta['statement_descriptor'] = 'STATEMENTDESC';
return $charge_meta;}A fizetési mód ügyfélhez csatolása (Stripe kártyamezős űrlapoknál). Ha a mezőben nincs bekapcsolva a további fizetési módok engedélyezése, az ügyfélobjektum létrehozásához a gform_stripe_customer_id szűrővel együtt kell használnod:
// A setup_future_usage = off_session beállítás elmenti a fizetési módot.add_filter( 'gform_stripe_charge_pre_create', function ( $charge_meta, $feed, $submission_data, $form, $entry ) {
gf_stripe()->log_debug( __METHOD__ . '(): Adding setup_future_usage for feed ' . rgars( $feed, 'meta/feedName' ) ); $charge_meta['setup_future_usage'] = 'off_session';
return $charge_meta;}, 10, 5 );A description tulajdonság hozzáadása:
add_filter( 'gform_stripe_charge_pre_create', function ( $charge_meta, $feed, $submission_data, $form, $entry ) { if ( empty( $charge_meta['description'] ) ) { $charge_meta['description'] = gf_stripe()->get_payment_description( $entry, $submission_data, $feed ); }
return $charge_meta;}, 10, 5 );gform/stripe/elements/config/: a Stripe Elements konfigurációja (JavaScript)
Szekció neve “gform/stripe/elements/config/: a Stripe Elements konfigurációja (JavaScript)”Ez a szűrő JavaScriptben fut a weboldalon. A Stripe Elements konfigurációs objektumát módosíthatod vele, mielőtt a bővítmény abból Elementst hoz létre Payment Intent vagy Setup Intent nélkül. Aszinkron szűrő, ezért AJAX-hívás is lehet benne.
gform.utils.addAsyncFilter( 'gform/stripe/elements/config/', async ( elementsConfig ) => { // Saját logika. return elementsConfig;} );| Paraméter | Típus | Jelentés |
|---|---|---|
elementsConfig |
Object | A Stripe Elements konfigurációs objektuma, amellyel az Elements intent nélkül jön létre. |
A konfiguráció kiírása a böngészőkonzolra:
gform.utils.addAsyncFilter( 'gform/stripe/elements/config/', async ( elementsConfig ) => { console.log( 'Elements Config:', elementsConfig ); return elementsConfig;} );A fizetési mód mentése az ügyfélhez:
gform.utils.addAsyncFilter( 'gform/stripe/elements/config/', async ( elementsConfig ) => { // A setupFutureUsage = off_session elmenti a fizetési módot. elementsConfig['setupFutureUsage'] = 'off_session';
return elementsConfig;} );A JavaScript-kódot a webhely előoldali (frontend) kódjába kell tenned.
Készült: