Prérequis :
- Charitable Pro 1.8.16+
- Charitable Rewards 1.0.0+
Chaque crochet que Charitable Rewards expose, regroupé par ce qu'il affecte. Les pages de fonctionnalités contiennent des exemples de travail ; voici l'index complet.
Ajoutez vos extraits à un plugin spécifique au site ou à un plugin d'extraits de code, pas au fichier functions.php d'un thème, afin qu'ils survivent à un changement de thème.
Actions
Six actions, dont trois sont les points d'intégration pour la synchronisation des réclamations avec un système externe.
| Action | Se déclenche lorsque |
|---|---|
charitable_rewards_claim_confirmed | Une réclamation passe à confirmée, ce qui signifie que le don a été effectué. |
charitable_rewards_claim_fulfilled | Une réclamation est marquée comme satisfaite |
charitable_rewards_claim_revoked | Une réclamation est révoquée |
charitable_rewards_onboarding_complete | L'assistant de configuration atteint sa dernière étape. |
charitable_rewards_onboarding_reset | L'assistant de configuration est réexécuté |
charitable_rewards_onboarding_help_slot | S'affiche dans le bloc Aide et intégration, pour vos propres boutons. |
Formulaire et affichage des dons
| Filtre | Modifications |
|---|---|
charitable_rewards_form_heading | Titre au-dessus du bloc des récompenses sur un formulaire de don. |
charitable_rewards_form_heading_no_reward | Ce titre lorsqu'aucune récompense n'est actuellement à portée. |
charitable_rewards_thresholds_heading | Titre au-dessus de la liste des cartes de seuil. |
charitable_rewards_threshold_strip_with_cards | Indique si la bande de seuil compacte s'affiche à côté des cartes. |
charitable_rewards_summary_label | L'étiquette de récompense dans le résumé du don. |
charitable_rewards_decline_label | Le libellé de la case à cocher pour refuser les récompenses. |
charitable_rewards_change_amount_level_label | Étiquette sur le lien "changer votre niveau" en mode niveaux. |
charitable_rewards_change_amount_level_link | Le lien "changer votre niveau" lui-même. |
charitable_rewards_unlock_color | Couleur d'accentuation pour l'état déverrouillé. |
charitable_rewards_tier_image_size | Taille d'image enregistrée pour les images de carte de récompense |
charitable_rewards_level_image_size | Taille d'image enregistrée pour les images des cartes de niveau de don. |
charitable_rewards_view_models | Les vues modèles derrière le rendu des cartes, partagées par le formulaire et le shortcode |
charitable_reward_cards_shortcode | Sortie ou attributs de [charitable_reward_cards] |
Comportement
| Filtre | Modifications |
|---|---|
charitable_rewards_stacking_mode | Si un donateur reçoit uniquement la récompense la plus élevée ou tout ce qu'il a franchi. Le deuxième argument est l'ID de la campagne |
charitable_rewards_reservation_ttl | Combien de temps une récompense limitée est conservée pour un don en attente |
charitable_rewards_backers_statuses | Quels statuts de réclamation comptent pour les réclamations publiques |
charitable_rewards_log_renewal_to_donor | Si une réclamation de renouvellement est enregistrée auprès du donateur |
Livraison numérique
| Filtre | Modifications |
|---|---|
charitable_rewards_download_url_ttl | Durée de vie en secondes d'une URL de téléchargement signée. Par défaut 604800, soit sept jours |
charitable_rewards_allowed_file_types | Types de fichiers autorisés pour les téléchargements de récompenses numériques |
charitable_rewards_max_file_size | Plafond de taille de téléchargement |
Exécution
| Filtre | Modifications |
|---|---|
charitable_rewards_carriers | La liste des transporteurs proposée lors de l'enregistrement du suivi |
Reçus et taxes
| Filtre | Modifications |
|---|---|
charitable_rewards_receipt_heading | Titre du bloc des récompenses sur un reçu |
charitable_rewards_receipt_pending_note | Note affichée à côté d'une réclamation non encore exécutée |
charitable_rewards_tax_receipt_heading | Titre au-dessus de la divulgation fiscale |
charitable_rewards_tax_receipt_disclaimer | Le libellé de la divulgation fiscale |
E-mails
Chacun des trois e-mails expose les quatre mêmes filtres.
| Filtres | |
|---|---|
| Confirmation de récompense | charitable_email_reward_confirmation_recipient, _default_subject, _default_headline, _default_body |
| Livraison numérique de la récompense | charitable_email_reward_digital_delivery_recipient, _default_subject, _default_headline, _default_body |
| Récompense expédiée | charitable_email_reward_shipped_recipient, _default_subject, _default_headline, _default_body |
Chaque filtre _default_* est préfixé par la même tige charitable_email_reward_<email>_ que son filtre de destinataire.
Écrans d'administration
| Filtre | Modifications |
|---|---|
charitable_rewards_admin_tabs | La liste des onglets Récompenses |
charitable_rewards_admin_tab_badges | Compter les badges sur les onglets |
charitable_rewards_overview_range_presets | Les préréglages de plage de dates du tableau de bord |
charitable_rewards_overview_empty_state_html | Marquage affiché lorsqu'il n'y a rien à signaler |
charitable_rewards_catalog_search_limit | Combien de résultats la recherche du catalogue renvoie |
charitable_rewards_reports_overview_stat | Une statistique dans l'intégration Rapports |
Assistant de configuration
| Filtre | Modifications |
|---|---|
charitable_rewards_onboarding_enabled | Désactivez complètement l'assistant |
charitable_rewards_onboarding_steps | Ajouter, supprimer ou réorganiser les étapes |
charitable_rewards_onboarding_capability | Qui peut l'exécuter. Par défaut charitable_manage_rewards |
charitable_rewards_onboarding_should_show_panel | Si le panneau d'entrée de la vue d'ensemble s'affiche |
charitable_rewards_onboarding_campaign_limit | Combien de campagnes la étape de pièce jointe liste |
charitable_rewards_onboarding_step_errors | Messages de validation par étape |
charitable_rewards_onboarding_docs_url | URL de base pour les liens En savoir plus |
charitable_rewards_onboarding_docs_url_for_step | URL de documentation par étape, pour un lien direct vers une ancre |
charitable_rewards_onboarding_video_id | ID de la vidéo pour la vignette de l'étape 1 |
charitable_rewards_onboarding_video_file | Fichier vidéo auto-hébergé pour la vignette de l'étape 1 |
charitable_rewards_onboarding_video_params | Paramètres du lecteur pour la vignette de l'étape 1 |
Environnement, licence et intégration
| Filtre | Modifications |
|---|---|
charitable_rewards_license_state | L'état de la licence résolu |
charitable_rewards_license_grace_period_seconds | Période de grâce de la licence |
charitable_rewards_ambassadors_active | Si Récompenses pense que Charitable Ambassadors est présent |
charitable_rewards_docs_url | URL de base de la documentation utilisée en dehors de l'assistant |
Capacités
Quatre capacités, de sorte que l'accès puisse être limité plutôt que tout ou rien.
| Capacité | Permet |
|---|---|
charitable_manage_rewards | Créer, modifier et archiver des récompenses |
charitable_fulfill_rewards | Traiter la file d'attente des réclamations et marquer les réclamations comme satisfaites |
charitable_view_reward_pii | Voir les noms des donateurs et les adresses de livraison |
charitable_manage_reward_tax | Modifier les justes valeurs marchandes et les paramètres fiscaux |
Paramètres
Stocké dans l'option charitable_rewards_settings, lu via Charitable_Rewards_Settings::get().
| Clé | Défaut | Objectif |
|---|---|---|
activer_reçu_fiscal | faux | Enregistrer la juste valeur marchande et divulguer la partie déductible |
reservation_ttl_minutes | 30 | Combien de temps une récompense limitée est conservée pour un don en attente |
Les paramètres par campagne se trouvent sous campaign_settings_v2 dans le tableau settings.rewards de la campagne. Ces clés sont listées sur Mode automatique.
Constantes
| Constant | Valeur | Objectif |
|---|---|---|
Charitable_Rewards_Env::MIN_PRO_VERSION | 1.8.16 | En dessous, l'interface administrateur se verrouille derrière une notification |
Charitable_Rewards_Download::DEFAULT_TTL | 604800 | Durée de vie de l'URL de téléchargement signée en secondes |
Charitable_Rewards_Matcher::MODE_HIGHEST | le plus élevé | Mode d'empilement par défaut |
Charitable_Rewards_Matcher::MODE_CUMULATIVE | cumulatif | Mode d'empilement alternatif |
Objets de valeur
| Classe | Expose |
|---|---|
Charitable_Rewards_Reward | Constantes de type, portée, modèle d'attachement et statut |
Charitable_Rewards_Claim | Constantes de statut et de type de réclamation |
Charitable_Rewards_Level | Les champs de niveau de don |
Charitable_Rewards_Tax | deductible( $total, $fmv ), une aide pure |
Charitable_Rewards_Tracking | carriers(), save(), tracking_url(), parts_for_donation_reward() |
Charitable_Rewards_Shipping | field_keys(), parts_for_donation(), format_address() |
Charitable_Rewards_P2P_Source | resolve_source_campaign_id() |
Stockage
Rewards conserve ses propres tables pour les récompenses, les pièces jointes de campagne, les réclamations, l'activité des réclamations, les réservations et les niveaux de campagne. Les adresses de livraison et les numéros de suivi sont des métadonnées de don plutôt que des colonnes de table, préfixés respectivement par charitable_rewards_shipping_ et charitable_rewards_tracking_.
Les schémas ne sont pas reproduits ici à dessein. Ils changent entre les versions, et une copie dans la documentation devient obsolète silencieusement. Lisez-les à partir de la classe de schéma si vous avez besoin de la forme actuelle.
Deux colonnes sont déclarées mais non écrites : deductible_snapshot et tax_profile_version sur la table des réclamations. Le montant de la franchise est dérivé au moment du rendu à partir de la juste valeur marchande figée. Ne construisez pas de rapports qui les lisent en attendant des données.
Choses qui ne sont délibérément pas filtrables
Bon à savoir pour ne pas chercher :
- Le type d’une récompense après sa création. Le comportement s’est déjà produit au moment où vous le changeriez.
- Suppression d’une récompense. Il n’y a aucun chemin de suppression ; l’archivage est la voie prise en charge, car les réclamations font référence aux récompenses.
- Le portail des niveaux pair-à-pair. Les formulaires de dons enfants ne rendent pas les récompenses héritées lorsque le parent est en mode niveaux, car un niveau définit le montant du don et un formulaire enfant ne le peut pas. C’est une limite de capacité, pas une politique.
Connexes
- Récompenses caritatives – la page principale.
- Mode automatique – clés de paramètres par campagne et classes d’état des cartes.
- Livraison des récompenses – URL de téléchargement signées et champs d’expédition.
- Réclamations et exécution – les trois actions de réclamation dans leur contexte.
Liens utiles
🤝 Obtenez de l’aide quand vous en avez besoin
📑 Trouvez le guide dont vous avez besoin
Parcourez le Hub de documentation →
⬇️ Téléchargez des stratégies éprouvées, des idées de campagnes et des outils d'experts
Obtenez le Kit de collecte de fonds →
🔗 Laissez votre assistant IA faire le travail de collecte de fonds pour vous.
Connect Charitable à votre assistant IA →
💸 Obtenez des ressources gratuites pour la collecte de fonds
Rendez-vous sur le Hub de collecte de fonds Charitable →
🤔 Des questions sur Charitable ?
FAQ Charitable →
Besoin d'aide pour comprendre les termes et le jargon des organisations à but non lucratif ?
Consultez notre glossaire des organisations à but non lucratif→
