Comme toutes les extensions Charitable, Charitable Stripe est conçue pour être facile à utiliser pour les développeurs et inclut des hooks et des filtres qui vous aideront à apporter toutes les personnalisations dont vous avez besoin.
Extension payante
Charitable Stripe est un plugin premium. Achetez-le dès aujourd'hui avec l'un de nos packs de plugins.
Filtres
charitable_stripe_statement_descriptor
Ajouté dans la version 1.3.0
Filtre le descripteur de déclaration formaté automatiquement qui est envoyé à Stripe.
Note : Ce filtre n'est utilisé que lorsque le paramètre Format du descripteur de déclaration (sous Charitable > Paramètres > Passerelles de paiement > Stripe) est défini sur « Utiliser le titre de la campagne ».
Valeur de retour
String. Par défaut, cela renvoie les 22 premiers caractères du titre de la campagne.
Arguments
$descriptor (string)Le descripteur par défaut.
$donation (Charitable_Donation)L'objet de don.
$processor (Charitable_Donation_Processor)L'objet du processeur de dons.
Utilisation
add_filter(
'charitable_stripe_statement_descriptor',
function( $descriptor, Charitable_Donation $donation ) {
return 'My Custom Statement Descriptor';
},
10,
2
);
charitable_stripe_metadata_fields
Ajouté dans la version 1.4.0
Filtrez la liste des champs de don qui seront envoyés à Stripe comme métadonnées pour un don ponctuel ou récurrent particulier.
Valeur de retour
Un tableau de clés pour les champs de don.
Arguments
$fields (tableau)Les clés de tous les champs de don dont les valeurs seront envoyées à Stripe. Par défaut, cela inclura tout champ affiché dans le formulaire de don front-end, ainsi que
donation_idetdonor.
Utilisation
/**
* 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
Ajouté dans la version 1.3.0
Filtrez les métadonnées transmises à une intention de paiement, une session de paiement ou une transaction.
Valeur de retour
Un tableau de métadonnées sous forme de paires clé=>valeur.
Arguments
$metadata (tableau)L'ensemble des métadonnées.
$donation (Charitable_Donation)L'objet de don.
$processor (Charitable_Donation_Processor)L'objet du processeur.
charitable_stripe_webhook_events
Ajouté dans la version 1.3.0
Filtrez la liste des événements webhook auxquels Charitable est abonné pour recevoir des notifications de Stripe.
Valeur de retour
Un tableau de types d'événements webhook valides.
Arguments
$events (tableau)Les événements sur lesquels le webhook sera notifié.
$connect_application (booléen)S'il s'agit d'un webhook pour une application Connect.
charitable_stripe_setup_webhooks
Ajouté dans la version 1.3.0
Filtrez si les webhooks doivent être configurés pour ce site.
Par défaut, cela renverra true, sauf s'il s'agit de localhost.
Valeur de retour
Booléen.
Arguments
$setup_webhooks (booléen)Si les webhooks doivent être configurés.
Utilisation
add_filter( 'charitable_stripe_setup_webhooks', '__return_false' );
charitable_stripe_default_event_processors
Ajouté dans la version 1.3.0
Modifiez les processeurs d'événements par défaut pour des types d'événements webhook spécifiques.
Valeur de retour
Un tableau clé=>valeur de types d'événements Stripe et de fonctions de rappel associées.
Arguments
$processors (tableau)Tableau de types d'événements Stripe et de fonctions de rappel associées.
charitable_stripe_languages_directory
Ajouté dans la version 1.0.0
Modifiez le répertoire où sont stockées les traductions des extensions.
Valeur de retour
Un string représentant le chemin du répertoire des langues, relatif au répertoire wp-content/plugins.
Arguments
$directory (chaîne)Le chemin du répertoire des langues. La valeur par défaut est
charitable-stripe/languages.
charitable_gateway_stripe_name
Ajouté dans la version 1.0.0
Filtre le nom de la passerelle tel qu'il est affiché dans l'espace d'administration.
Valeur de retour
Chaîne de caractères. La valeur par défaut est « Stripe ».
Arguments
$name (chaîne)Nom de la passerelle.
charitable_stripe_theme_template_path
Ajouté dans la version 1.4.0
Filtre le chemin du modèle Stripe.
Valeur de retour
Une chaîne représentant le répertoire où les modèles sont stockés, relatif au dossier du thème.
Arguments
$template_path (chaîne)Le chemin du modèle. La valeur par défaut est
charitable/charitable-stripe.
charitable_stripe_gateway_processor_checkout
Ajouté dans la version 1.4.0
Filtre la classe de processeur utilisée pour gérer les dons via Checkout.
Valeur de retour
Une chaîne représentant le nom d'une classe qui hérite de la classe de base Charitable_Stripe_Gateway_Processor. La valeur par défaut est Charitable_Stripe_Gateway_Processor_Checkout.
Arguments
$class (chaîne)Le nom de la classe du processeur de passerelle Stripe.
$processor (Charitable_Donation_Processor)L'aide du processeur de dons.
charitable_stripe_gateway_processor_payment_intents
Ajouté dans la version 1.4.0
Filtre le processeur utilisé pour gérer les dons via PaymentIntent.
Valeur de retour
Une chaîne représentant le nom d'une classe qui hérite de la classe de base Charitable_Stripe_Gateway_Processor. La valeur par défaut est Charitable_Stripe_Gateway_Processor_Payment_Intents.
Arguments
$class (chaîne)Le nom de la classe du processeur de passerelle Stripe.
$processor (Charitable_Donation_Processor)L'aide du processeur de dons.
charitable_stripe_customer_args
Ajouté dans la version 1.2.2
Filtre les arguments du client Stripe.
Valeur de retour
Un tableau d'arguments qui seront passés à un appel \Stripe\Customer::create()
Arguments
$args (tableau)Les arguments du client.
$donor (Charitable_Donor)L'objet donateur.
charitable_stripe_session_args
Ajouté dans la version 1.4.0
Filtre les arguments de session.
Valeur de retour
Un tableau d'arguments qui seront utilisés dans un appel à \Stripe\Checkout\Session::create()
Arguments
$args (tableau)Les arguments de session.
$donation (Charitable_Donation)L'objet de don.
$processor (Charitable_Donation_Processor)L'objet du processeur.
$gateway (Charitable_Gateway_Stripe)L'aide de la classe de passerelle Stripe.
Utilisation
/**
* 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
Ajouté dans la version 1.4.0
Filtre les arguments de PaymentIntent.
Valeur de retour
Un tableau d'arguments qui seront utilisés dans un \Stripe\PaymentIntent::create()
Arguments
$args (tableau)Les arguments de PaymentIntent.
$donation (Charitable_Donation)L'objet de don.
$processor (Charitable_Donation_Processor)L'objet du processeur.
$gateway (Charitable_Gateway_Stripe)L'aide de la classe de passerelle Stripe.
Utilisation
/**
* 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
Ajouté dans la version 1.4.0
Filtrer les arguments passés à Stripe pour créer un nouvel abonnement.
Valeur de retour
Un tableau d'arguments qui sont passés à un appel \Stripe\Subscription::create().
Arguments
$args (tableau)Les arguments de l'abonnement.
$recurring (Dons_récurrents_Charitable)L'objet de don récurrent.
$processor (Processeur_Charitable_Stripe)Cette instance de processeur de passerelle.
charitable_stripe_plan_args
Ajouté dans la version 1.4.3
Filtre les arguments passés à Stripe pour créer un nouveau plan.
Valeur de retour
Un tableau d'arguments passés à un appel \Stripe\Plan::create().
Arguments
$plan_args (tableau)Les arguments du plan à envoyer à Stripe.
$plan (Plan_Charitable_Stripe)Une instance de l'objet Charitable_Stripe_Plan.
charitable_stripe_product_args
Ajouté dans la version 1.4.3
Filtre les arguments passés à Stripe pour créer un nouveau produit.
Valeur de retour
Un tableau d'arguments passés à un appel \Stripe\Product::create().
Arguments
$product_args (tableau)Les arguments du produit à envoyer à Stripe.
$product (Produit_Charitable_Stripe)Une instance de
Charitable_Stripe_Product.
charitable_stripe_product_statement_descriptor
Ajouté dans la version 1.4.0
Filtre le statement_descriptor formaté automatiquement pour les produits.
Valeur de retour
Une chaîne qui sera utilisée comme descripteur de déclaration pour un nouvel objet Produit Stripe.
Arguments
$descriptor (string)Le descripteur par défaut.
$product (Produit_Charitable_Stripe)L'instance de
Charitable_Stripe_Product.
charitable_stripe_recurring_subscription_status
Ajouté dans la version 1.2.0
Filtre le statut d'un abonnement récurrent en fonction d'un statut Stripe.
Valeur de retour
Chaîne. Un statut de don récurrent Charitable valide (l'un des charitable-pending, charitable-active, charitable-onhold, charitable-cancelled, charitable-expired, charitable-failed, charitable-cancel).
Arguments
$status (chaîne)Le statut Charitable.
$stripe_status (chaîne)Statut de Stripe pour l’abonnement. Voir la liste des statuts possibles de Stripe.
charitable_stripe_load_stripe_scripts_sitewide
Ajouté dans la version 1.4.3
Indique s’il faut charger le script Stripe sur l’ensemble du site.
Valeur de retour
Booléen. Retourne true pour charger les scripts sur l’ensemble du site (par défaut), ou false pour ne charger les scripts de Stripe que sur le formulaire de don.
Arguments
$load (booléen)Indique s’il faut charger les scripts sur l’ensemble du site. La valeur par défaut est true.
Utilisation
add_filter( 'charitable_stripe_load_stripe_scripts_sitewide', '__return_false' );
Hooks d'action
charitable_stripe_ipn_event
Ajouté dans la version 1.0.0
Déclencher un hook d’action pour traiter l’événement.
Notez que cela ne sera déclenché que pour les webhooks qui n’ont pas déjà été traités par l’un des gestionnaires de webhooks par défaut.
Valeur de retour
Vide
Arguments
$event_type (chaîne)Type d’événement.
$event (\Stripe\Event)Objet d’événement Stripe.
