Veuillez noter : Cette documentation est en cours de développement et ne couvre pas encore tous les filtres et hooks d'action disponibles dans Charitable Ambassadors. Si vous ne trouvez pas de hook ou de filtre décrivant ce que vous devez faire, contactez-nous via notre page de support et nous vous aiderons.
Filtres
Ambassadeurs caritatifs : collecte de fonds
Ajouté dans la version 2.0.0
u003cpu003eModifiez le titre généré automatiquement pour une nouvelle collecte de fonds, lorsque le titre est défini pour être basé dynamiquement sur le nom du créateur de la campagne.u003c/pu003e
Valeur de retour
u003cpu003eString. Le titre de la collecte de fonds.u003c/pu003e
Arguments
$title (chaîne)u003cpu003eLe titre. Par défaut, ce sera le nom complet du créateur de la campagne.u003c/pu003e
$data (tableau)u003cpu003eLes données soumises.u003c/pu003e
Utilisation
add_filter( 'charitable_ambassadors_fundraiser_title', function( $title, $data ) {n $first_name = array_key_exists( 'first_name', $data ) ? $data['first_name'] : '';n $last_name = array_key_exists( 'last_name', $data ) ? $data['last_name'] : '';n $full_name = trim( sprintf( '%s %s', $first_name, $last_name ) );nn // Joe Blow's Fundraisern return sprintf( u0022%s's Fundraiseru0022, $full_name );n}, 10, 2 );
Ambassadeurs caritatifs : Mes campagnes - Afficher le lien de création de campagne
Ajouté dans la version 2.0.0
u003cpu003eChoisissez si vous souhaitez afficher le bouton "Créer une nouvelle campagne" en bas du résultat du shortcode [charitable_my_campaigns].u003c/pu003e
Valeur de retour
u003cpu003eBoolean. True si vous souhaitez l'afficher, ou false si vous préférez ne pas le faire. Ceci retournera true par défaut.u003c/pu003e
Arguments
$show (booléen)u003cpu003eIndique s'il faut afficher le bouton.u003c/pu003e
Utilisation
// Do not show the button.nadd_filter( 'charitable_ambassadors_my_campaigns_show_campaign_creation_link', '__return_false' );
Ambassadeurs caritatifs : Mes campagnes - Texte du bouton
Ajouté dans la version 1.0.0
u003cpu003eModifiez le texte du bouton "Créer une campagne" en bas du résultat du shortcode [charitable_my_campaigns].u003c/pu003e
Valeur de retour
u003cpu003eString. Le texte à utiliser dans le bouton.u003c/pu003e
Arguments
$text (chaîne)u003cpu003eLe texte du bouton.u003c/pu003e
Utilisation
add_filter( 'charitable_ambassadors_my_campaigns_button_text', function( $text ) {n return 'Start a New Campaign';n} );
Ambassadeurs caritatifs : URL de la page de succès de soumission de campagne
Ajouté dans la version 1.0.0
u003cpu003eModifiez la page vers laquelle les utilisateurs seront redirigés après avoir soumis leur campagne pour la première fois. Notez que si vous souhaitez rediriger vers une page statique, vous pouvez le faire sans code en configurant le paramètre "Page de succès de soumission de campagne" sous Charitable u003e Paramètres u003e Ambassadeurs.u003c/pu003e
Valeur de retour
u003cpu003eString. Une URL vers laquelle rediriger après la première soumission d'une campagne. Notez que la redirection se fait via un appel à u003ccodeu003ewp_safe_redirect()u003c/codeu003e, donc l'URL doit être vers un hôte autorisé (voir u003ca href=u0022https://developer.wordpress.org/reference/functions/wp_safe_redirect/u0022u003ehttps://developer.wordpress.org/reference/functions/wp_safe_redirect/u003c/au003e).u003c/pu003e
Arguments
$default (chaîne)u003cpu003eL'URL vers laquelle rediriger.u003c/pu003e
$args (tableau)u003cpu003eUn tableau d'arguments. Par défaut, il n'aura qu'une propriété u003ccodeu003ecampaign_idu003c/codeu003e avec l'ID de la campagne nouvellement soumise.u003c/pu003e
Utilisation
// Redirect to the newly submitted campaign after submission.nadd_filter( 'charitable_permalink_campaign_submission_success_page', function( $url, $args = array() ) {n if ( ! array_key_exists( 'campaign_id', $args ) ) {n return $url;n }nn return get_permalink( $args['campaign_id'] );n}, 10, 2 );
Ambassadeurs caritatifs : URL de redirection après soumission de campagne
Ajouté dans la version 1.0.0
u003cpu003eModifiez l'URL vers lequel les utilisateurs sont redirigés après avoir soumis, mis à jour ou enregistré et prévisualisé leur campagne.u003c/pu003eu003cpu003eSi vous souhaitez uniquement modifier la page vers laquelle les utilisateurs sont redirigés après avoir soumis pour la première fois leur campagne, utilisez plutôt le filtre u003ca href=u0022https://www.wpcharitable.com/documentation/hooks-filters-in-ambassadors/#charitable_permalink_campaign_submission_success_pageu0022u003echaritable_permalink_campaign_submission_success_pageu003c/au003e.u003c/pu003e
Valeur de retour
u003cpu003eString. L'URL vers lequel l'utilisateur sera redirigé.u003c/pu003e
Arguments
$url (chaîne)u003cpu003eL'URL vers lequel l'utilisateur sera redirigé.u003c/pu003e
$data (tableau)u003cpu003eLes données soumises.u003c/pu003e
$campaign_id (entier)u003cpu003eL'ID de la campagne.u003c/pu003e
$user_id (entier)u003cpu003eL'ID de l'utilisateur.u003c/pu003e
Ambassadeurs caritatifs : Collecte de fonds - Liste des champs du formulaire
Ajouté dans la version 2.1.0
u003cpu003eAjoutez ou supprimez des champs du formulaire de collecte de fonds. u003c/pu003eu003cpu003eLa liste des champs est une liste de clés de champs qui sont inclus dans le formulaire principal de la campagne, et qui doivent également être inclus dans le formulaire de collecte de fonds. Les champs suivants ne sont pas inclus dans le formulaire de collecte de fonds par défaut :u003c/pu003eu003cpu003e- u003ccodeu003edescriptionu003c/codeu003eu003cbru003e- u003ccodeu003ecategoriesu003c/codeu003eu003cbru003e- u003ccodeu003etagsu003c/codeu003eu003cbru003e- u003ccodeu003esuggested_donationsu003c/codeu003eu003cbru003e- u003ccodeu003eallow_custom_donationsu003c/codeu003eu003c/pu003e
Valeur de retour
array
Arguments
$list (tableau)u003cpu003eLa liste des champs à inclure.u003c/pu003e
$form (Charitable_Ambassadors_Fundraiser_Form)u003cpu003eL'objet du formulaire de collecte de fonds.u003c/pu003e
Utilisation
// Include the 'description' field in the Fundraiser form.nadd_filter( 'charitable_ambassadors_fundraiser_form_field_list', function( $fields ) {n $fields[] = 'description';n return $fields;n} );
Ambassadeurs caritatifs : Collecte de fonds - Champs hérités
Ajouté dans la version 2.0.0
u003cpu003eFiltrez les champs qui sont automatiquement hérités de la campagne parente de la collecte de fonds.u003c/pu003e
Valeur de retour
array
Arguments
$fields (tableau)u003cpu003eLes champs hérités.u003c/pu003e
Utilisation
add_filter(n 'charitable_ambassadors_fundraiser_inherited_fields', n function( $fields ) {n $fields[] = 'my_custom_field';n return $fields;n }n);
Ambassadeurs caritatifs : Mettre à jour les dates de fin de collecte de fonds lors du changement de date de fin du parent
Ajouté dans la version 2.0.0
u003cpu003eDéfinissez si les dates de fin des collectes de fonds doivent être mises à jour automatiquement lorsque la date de fin d'une campagne parente est modifiée.u003c/pu003e
Valeur de retour
u003cpu003eBoolean. Par défaut, true.u003c/pu003e
Arguments
$should_update (booléen)u003cpu003eIndique s'il faut mettre à jour automatiquement.u003c/pu003e
$campaign (Charitable_Campaign)u003cpu003eL'objet de la campagne parente.u003c/pu003e
Ambassadeurs caritatifs : Créateur - Colonnes d'exportation des dons
Ajouté dans la version 2.0.0
u003cpu003eFiltrez les colonnes incluses dans l'exportation.u003c/pu003e
Valeur de retour
u003cpu003eArray. Les clés des colonnes à inclure.u003c/pu003e
Arguments
$colonnes (tableau)Les colonnes à inclure.
Utilisation
add_filter( 'charitable_ambassadors_creator_donations_export_columns', function( $columns ) {n // Only show the first name, last name, amount and donor comment.n $included_columns = array(n 'first_name',n 'last_name',n 'amount',n 'donor_comment',n );ntn foreach ( $columns as $column =u003e $header ) {n if ( ! in_array( $column, $included_columns ) ) {n unset( $columns[ $column ] );n }n }ntn return $columns;n} );
