Charitable Documentation

Learn how to make the most of Charitable with clear, step-by-step instructions.

Hooks and filters in Annual Receipts

Like all Charitable extensions, Charitable Annual Receipts is designed to be developer-friendly, with hooks and filters that will help you customize it to your needs.

Paid Extension

Charitable Annual Receipts is a premium plugin. Get it today with one of our plugin bundles.

Filters

charitable_dompdf_options

Added in version 1.0.0

Change the options array passed to Dompdf when generating the PDF. To see all the available options, see:
https://github.com/dompdf/dompdf/blob/master/src/Options.php#L6-L286

Return Value

An array representing a set of options.

Arguments

  • $mode (string)

    The mode. Defaults to download.

charitable_pdf_mode

Added in version 1.0.0

This allows you to change the mode in which the PDF will be loaded. By default, it will automatically be downloaded, but you can change this to have it display inline.

Return Value

Either download or inline.

Arguments

  • $mode (string)

    The mode. Defaults to download.

Usage

add_filter( 'charitable_pdf_mode', function() {
    return 'inline';
} );

charitable_pdf_download_annual_receipt

Added in version 1.0.0

Use your own class for generating the PDF. The class must implement the \Charitable\Packages\Pdf\Interfaces\ClientInterface interface.

Return Value

An object that implements the \Charitable\Packages\Pdf\Interfaces\ClientInterface interface.

Arguments

  • $mode (string)

    The mode. Defaults to download.

charitable_annual_receipts_languages_directory

Added in version 1.0.0

Modify the directory where extension translations are stored.

Return Value

A string representing the path to the languages directory, relative to the wp-content/plugins directory.

Arguments

  • $mode (string)

    The mode. Defaults to download.

charitable_annual_receipts_languages_directory

Added in version 1.0.0

Modify the directory where extension translations are stored.

Return Value

A string representing the path to the languages directory, relative to the wp-content/plugins directory.

Arguments

  • $mode (string)

    The mode. Defaults to download.

charitable_annual_receipts_languages_directory

Added in version 1.0.0

Modify the directory where extension translations are stored.

Return Value

A string representing the path to the languages directory, relative to the wp-content/plugins directory.

Arguments

  • $mode (string)

    The mode. Defaults to download.

charitable_annual_receipts_theme_template_path

Added in version 1.0.0

Change the directory where template files are stored, relative to the theme/child theme.

Return Value

A string representing the path to the templates directory, relative to the theme folder.

Arguments

  • $mode (string)

    The mode. Defaults to download.

Action

charitable_annual_receipts_start

Added in version 1.0.0

Hook fired when the plugin is first loaded.

Return Value

Void

Arguments

  • $view_args (array)

    Arguments passed to the template.

charitable_before_annual_receipt

Added in version 1.0.0

Do something before the annual receipt is displayed.

Return Value

Void

Arguments

  • $view_args (array)

    Arguments passed to the template.

charitable_after_annual_receipt

Added in version 1.0.0

Do something after the annual receipt is displayed.

Return Value

Void

Arguments

  • $view_args (array)

    Arguments passed to the template.

charitable_annual_receipts_pdf_styles

Added in version 1.0.0

Add custom styles to the PDF version of the annual receipt.

Return Value

Void

Arguments

  • $view_args (array)

    Arguments passed to the template.

Usage

add_action( 'charitable_annual_receipts_pdf_styles', function() {
    echo "color: #444;";
} );

Still have questions? We’re here to help!

Last Modified:

What's New In Charitable

View The Latest Updates
🔔 Subscribe to get our latest updates
📧 Subscribe to Emails

Email Subscription

Join our Newsletter

We won’t spam you. We only send an email when we think it will genuinely help you. Unsubscribe at any time!

Improvement Migrations

↔️ Importing From GiveWP, Donorbox, GiveButter… even CSV!

Whether you’re migrating from another platform or consolidating your records, moving your data to Charitable is now faster and more flexible than ever. We’ve streamlined the process so you can bring over your entire fundraising history in just a few clicks.

🔄 Native GiveWP, Donorbox, & GiveButter Support: Switching from a major platform? Our dedicated migration tools handle the heavy lifting, automatically mapping your donors and donations directly into Charitable—no technical skills required.

📂 Universal CSV Import: Moving from a custom system or a specialized CRM? If you can export it to a CSV, you can import it here. Our smart mapping tool lets you align your columns to Charitable fields like names, emails, phone numbers, and addresses in seconds.

Instant Donor Profiles & Custom Tags: Automatically create rich donor profiles and bring in custom tags to keep your data organized. Segment and engage your supporters from day one with a clean, professional database structure.


Ready to make the switch?

Check out our GiveWP Migration Guide

Learn more about our Import Tools

Improvement Payments

💳 New Braintree Features For Your European Donors

With the release of Braintree addon version 1.3.0, you can now empower your European donors with the payment methods they trust and prefer, making giving seamless for international supporters.

🌍 Six New European Payment Methods: Support popular local options like iDEAL (Netherlands), Bancontact (Belgium), BLIK (Poland), and more to meet donors where they are.

⚡ Frictionless Donor Experience: These bank-based methods allow donors to authenticate directly with their own bank in a secure popup… no credit card numbers required.

⚙️ Automatic Currency Sync: No complex setup needed. The builder automatically displays the correct payment buttons based on your site’s currency (EUR or PLN), ensuring a relevant experience for every visitor.

Campaigns New

🖼️ Campaign Featured Images: Pro-Level Visuals Made Simple

With the new Campaign Featured Image setting in our visual builder, you now have a single, dedicated place to manage how your fundraisers look across your entire site and beyond.

🖼️ One Image, Everywhere: Set a primary thumbnail that automatically syncs to campaign grids, lists, and shortcodes—no more relying on layout order.

📱 Social Sharing Optimized: Easily upload images at the perfect size to ensure your campaigns look stunning and professional when shared on social media.

🔍 SEO & Accessibility Ready: Add custom alt text directly within the builder to improve search rankings and ensure your mission is accessible to every supporter.

Improvement receipts

🗓️ Annual Receipts 2.0: Send Year-End Receipts to Every Donor in Minutes

You can now send annual receipts in minutes with a few clicks to all your donors.

📧 One-Click Bulk Send Wizard that guides you to sending to hundreds of donors simultaneously directly from your WordPress dashboard.

🔍 Smart “Dry Run” Mode: See exactly who will receive a receipt and who will be skipped (and why) before a single email leaves your server.

🛡️ SMTP-Aware & Limit Protection: Charitable now detects your email setup and automatically adjusts batch sizes and pauses for daily limits to ensure your emails land in inboxes.

✅ Complete Audit Trail: Dedicated system log and on the individual donor’s profile, giving you a clear history for every fiscal year.

Stop dreading tax season and start spending that time on your mission. Update to Annual Receipts 2.0 and automate your year-end reporting today.

Addon Donations Improvement

🎈Recurring Donations 2.0: Smarter Automation, Better Recovery, and More Control

We’ve completely rebuilt our Recurring Donations system to help you grow your reliable income stream while giving you (and your donors) more powerful tools than ever before.

What’s New:

🔒 Recurring-Only Campaigns: You can toggle “Recurring Only” mode in the campaign builder to hide the one-time option entirely, ensuring your supporters stay focused on long-term commitment.

📧 Automatic Payment Recovery: Our new Payment Failed Email fires automatically the moment a subscription fails.

🛠️ Self-Service Donor Control:The new Cancel Subscription Button appears directly in the donor dashboard, allowing supporters to pause or end their recurring gifts on their own terms—reducing your admin burden and payment disputes.

📊 Real-Time Revenue Insights: Track your growth, monitor active subscriptions, and see exactly how much predictable support is coming in each month at a glance.

Our new Recurring Donations addon gives you the professional-grade tools you need to grow your mission.