Wie alle Charitable-Erweiterungen ist Charitable Stripe entwicklerfreundlich gestaltet und enthält Hooks und Filter, die Ihnen bei allen notwendigen Anpassungen helfen.
Bezahlte Erweiterung
Charitable Stripe ist ein Premium-Plugin. Holen Sie es sich noch heute mit einem unserer Plugin-Bundles.
Filter
charitable_stripe_statement_descriptor
Hinzugefügt in Version 1.3.0
Filtert den automatisch formatierten Zahlungsauftrag, der an Stripe gesendet wird.
Hinweis: Dieser Filter wird nur verwendet, wenn die Einstellung Format des Statement Descriptors (unter Charitable > Einstellungen > Zahlungs-Gateways > Stripe) auf „Kampagnentitel verwenden“ gesetzt ist.
Rückgabewert
String. Standardmäßig werden die ersten 22 Zeichen des Kampagnentitels zurückgegeben.
Argumente
$descriptor (Zeichenkette)Der Standard-Descriptor.
$donation (Charitable_Donation)Das Spendenobjekt.
$processor (Charitable_Donation_Processor)Das Spendenprozessorobjekt.
Nutzung
add_filter(
'charitable_stripe_statement_descriptor',
function( $descriptor, Charitable_Donation $donation ) {
return 'My Custom Statement Descriptor';
},
10,
2
);
charitable_stripe_metadata_fields
Hinzugefügt in Version 1.4.0
Filtert die Liste der Spendenfelder, die an Stripe als Metadaten für eine bestimmte einmalige oder wiederkehrende Spende gesendet werden.
Rückgabewert
Ein Array von Schlüsseln für Spendenfelder.
Argumente
$fields (Array)Die Schlüssel aller Spendenfelder, deren Werte an Stripe gesendet werden. Standardmäßig sind dies alle Felder, die im Frontend-Spendenformular angezeigt werden, sowie
donation_idunddonor.
Nutzung
/**
* Add a new field to the metadata.
*/
add_filter(
'charitable_stripe_metadata_fields',
function( $fields ) {
// Add the name(s) of the campaign(s) receiving the donation to the metadata
$fields[] = 'campaign_categories_list';
return $fields;
}
);
/**
* Remove a field from the metadata.
*/
add_filter(
'charitable_stripe_metadata_fields',
function( $fields ) {
unset( $fields['address'] );
return $fields;
}
);
charitable_stripe_charge_metadata
Hinzugefügt in Version 1.3.0
Filtert die Metadaten, die an eine Zahlungsinformation, eine Checkout-Sitzung oder eine Abbuchung übergeben werden.
Rückgabewert
Ein Array von Metadaten als Schlüssel-Wert-Paare.
Argumente
$metadata (Array)Der Satz von Metadaten.
$donation (Charitable_Donation)Das Spendenobjekt.
$processor (Charitable_Donation_Processor)Das Prozessorobjekt.
charitable_stripe_webhook_events
Hinzugefügt in Version 1.3.0
Filtert die Liste der Webhook-Ereignisse, für die Charitable benachrichtigt werden soll, von Stripe.
Rückgabewert
Ein Array von gültigen Webhook-Ereignistypen.
Argumente
$events (Array)Die Ereignisse, über die der Webhook benachrichtigt wird.
$connect_application (boolean)Ob dies ein Webhook für eine Connect-Anwendung ist.
charitable_stripe_setup_webhooks
Hinzugefügt in Version 1.3.0
Filtert, ob Webhooks für diese Website eingerichtet werden sollen.
Standardmäßig gibt dies true zurück, es sei denn, es handelt sich um localhost.
Rückgabewert
Boolean.
Argumente
$setup_webhooks (boolean)Ob die Webhooks eingerichtet werden sollen.
Nutzung
add_filter( 'charitable_stripe_setup_webhooks', '__return_false' );
charitable_stripe_default_event_processors
Hinzugefügt in Version 1.3.0
Modifiziert die Standard-Ereignisprozessoren für bestimmte Webhook-Ereignistypen.
Rückgabewert
Ein Schlüssel=>Wert Array von Stripe-Ereignistypen und zugehörigen Callback-Funktionen.
Argumente
$processors (Array)Array von Stripe-Ereignistypen und zugehörigen Callback-Funktionen.
charitable_stripe_languages_directory
Hinzugefügt in Version 1.0.0
Ändern Sie das Verzeichnis, in dem Erweiterungsübersetzungen gespeichert werden.
Rückgabewert
Ein String, der den Pfad zum Sprachenverzeichnis darstellt, relativ zum Verzeichnis wp-content/plugins.
Argumente
$directory (String)Der Pfad zum Sprachverzeichnis. Standardmäßig
charitable-stripe/languages.
charitable_gateway_stripe_name
Hinzugefügt in Version 1.0.0
Filtert den Gateway-Namen, wie er im Admin-Bereich angezeigt wird.
Rückgabewert
String. Standardmäßig „Stripe“.
Argumente
$name (String)Gateway-Name.
charitable_stripe_theme_template_path
Hinzugefügt in Version 1.4.0
Filtert den Stripe-Theme-Template-Pfad.
Rückgabewert
Ein String, der das Verzeichnis darstellt, in dem Theme-Templates gespeichert sind, relativ zum Theme-Ordner.
Argumente
$template_path (String)Der Template-Pfad. Standardmäßig
charitable/charitable-stripe.
charitable_stripe_gateway_processor_checkout
Hinzugefügt in Version 1.4.0
Filtert die Prozessor-Klasse, die zur Verarbeitung von Checkout-Spenden verwendet wird.
Rückgabewert
Ein String, der den Namen einer Klasse darstellt, die von der Basisklasse Charitable_Stripe_Gateway_Processor abgeleitet ist. Standardmäßig Charitable_Stripe_Gateway_Processor_Checkout.
Argumente
$class (String)Der Name der Stripe-Gateway-Prozessor-Klasse.
$processor (Charitable_Donation_Processor)Der Spendenprozessor-Helfer.
charitable_stripe_gateway_processor_payment_intents
Hinzugefügt in Version 1.4.0
Filtert den Prozessor, der zur Verarbeitung von PaymentIntent-Spenden verwendet wird.
Rückgabewert
Ein String, der den Namen einer Klasse darstellt, die von der Basisklasse Charitable_Stripe_Gateway_Processor abgeleitet ist. Standardmäßig Charitable_Stripe_Gateway_Processor_Payment_Intents.
Argumente
$class (String)Der Name der Stripe-Gateway-Prozessor-Klasse.
$processor (Charitable_Donation_Processor)Der Spendenprozessor-Helfer.
charitable_stripe_customer_args
Hinzugefügt in Version 1.2.2
Filtert die Stripe-Kundenargumente.
Rückgabewert
Ein Array von Argumenten, die an einen \Stripe\Customer::create()
Argumente
$args (Array)Die Kundenargumente.
$donor (Charitable_Donor)Das Spenderobjekt.
charitable_stripe_session_args
Hinzugefügt in Version 1.4.0
Filtert die Sitzungsargumente.
Rückgabewert
Ein Array von Argumenten, die in einem Aufruf von \Stripe\Checkout\Session::create()
Argumente
$args (Array)Die Sitzungsargumente.
$donation (Charitable_Donation)Das Spendenobjekt.
$processor (Charitable_Donation_Processor)Das Prozessorobjekt.
$gateway (Charitable_Gateway_Stripe)Die Stripe-Gateway-Klassen-Hilfe.
Nutzung
/**
* Change the 'submit_type' argument to 'pay' instead of 'donate'.
*/
add_filter(
'charitable_stripe_session_args',
function( $args ) {
if ( array_key_exists( 'submit_type', $args ) ) {
$args['submit_type'] = 'pay';
}
return $args;
}
);
charitable_stripe_payment_intent_args
Hinzugefügt in Version 1.4.0
Filtert die PaymentIntent-Argumente.
Rückgabewert
Ein Array von Argumenten, die in einem \Stripe\PaymentIntent::create()
Argumente
$args (Array)Die PaymentIntent-Argumente.
$donation (Charitable_Donation)Das Spendenobjekt.
$processor (Charitable_Donation_Processor)Das Prozessorobjekt.
$gateway (Charitable_Gateway_Stripe)Die Stripe-Gateway-Klassen-Hilfe.
Nutzung
/**
* Change the 'description' argument.
*/
add_filter(
'charitable_stripe_payment_intent_args',
function( $args, $donation ) {
$args['description'] = 'My payment description';
return $args;
},
10,
2
);
charitable_stripe_subscriptions_args
Hinzugefügt in Version 1.4.0
Filtert die an Stripe übergebenen Argumente, um ein neues Abonnement zu erstellen.
Rückgabewert
Ein Array von Argumenten, die an einen \Stripe\Subscription::create()-Aufruf übergeben werden.
Argumente
$args (Array)Die Abonnement-Argumente.
$recurring (Charitable_Recurring_Donation)Das wiederkehrende Spendenobjekt.
$processor (Charitable_Stripe_Gateway_Processor)Diese Gateway-Prozessor-Instanz.
charitable_stripe_plan_args
Hinzugefügt in Version 1.4.3
Filtert die an Stripe übergebenen Argumente, um einen neuen Plan zu erstellen.
Rückgabewert
Ein Array von Argumenten, die an einen \Stripe\Plan::create()-Aufruf übergeben werden.
Argumente
$plan_args (Array)Die Plan-Argumente, die an Stripe gesendet werden sollen.
$plan (Charitable_Stripe_Plan)Eine Instanz eines Charitable_Stripe_Plan-Objekts.
charitable_stripe_product_args
Hinzugefügt in Version 1.4.3
Filtert die an Stripe übergebenen Argumente, um ein neues Produkt zu erstellen.
Rückgabewert
Ein Array von Argumenten, die an einen \Stripe\Product::create()-Aufruf übergeben werden.
Argumente
$product_args (Array)Die Produktargumente, die an Stripe gesendet werden sollen.
$product (Charitable_Stripe_Product)Eine Instanz von
Charitable_Stripe_Product.
charitable_stripe_product_statement_descriptor
Hinzugefügt in Version 1.4.0
Filtert den automatisch formatierten statement_descriptor für Produkte.
Rückgabewert
Ein String, der als statement descriptor für ein neues Stripe-Produktobjekt verwendet wird.
Argumente
$descriptor (Zeichenkette)Der Standard-Descriptor.
$product (Charitable_Stripe_Product)Die
Charitable_Stripe_Product-Instanz.
charitable_stripe_recurring_subscription_status
Hinzugefügt in Version 1.2.0
Filtert den Status für ein wiederkehrendes Abonnement basierend auf einem Stripe-Status.
Rückgabewert
String. Ein gültiger Charitable-Status für wiederkehrende Spenden (einer von charitable-pending, charitable-active, charitable-onhold, charitable-cancelled, charitable-expired, charitable-failed, charitable-cancel).
Argumente
$status (String)Der Charitable-Status.
$stripe_status (Zeichenkette)Stripe-Status für das Abonnement. Siehe Stripes Liste möglicher Status.
charitable_stripe_load_stripe_scripts_sitewide
Hinzugefügt in Version 1.4.3
Ob das Stripe-Skript seitenweit geladen werden soll.
Rückgabewert
Boolean. Geben Sie true zurück, um Skripte seitenweit zu laden (Standard), oder false, um Stripes Skripte nur auf dem Spendenformular zu laden.
Argumente
$load (boolean)Ob die Skripte seitenweit geladen werden sollen. Standard ist true.
Nutzung
add_filter( 'charitable_stripe_load_stripe_scripts_sitewide', '__return_false' );
Action Hooks
charitable_stripe_ipn_event
Hinzugefügt in Version 1.0.0
Lösen Sie einen Action Hook aus, um das Ereignis zu verarbeiten.
Beachten Sie, dass dies nur für Webhooks ausgelöst wird, die noch nicht von einem der Standard-Webhook-Handler verarbeitet wurden.
Rückgabewert
Leer
Argumente
$event_type (Zeichenkette)Art des Ereignisses.
$event (\Stripe\Event)Stripe-Ereignisobjekt.
