Documentation Category: For Developers

Browse Documentation Categories

  • Setting Up Square Webhooks

    Would you like Charitable to receive real-time updates when a payment is completed or refunded through Square? With Square webhooks enabled, your forms can stay in sync with Square so payment statuses are always up to date. This guide will show you how to easily connect Square webhooks with Charitable, ensuring your website stays in…

  • 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. Filters Action

  • Hooks and filters in Automation Connect

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

  • Hooks & Filters in Braintree

    Filters

  • Hooks and filters in Ambassadors

    Filters

  • User Roles and Permissions

    Charitable adds two new user roles. In addition, Charitable Ambassadors adds an additional user role. Roles Donor The donor role is given to users after they make a donation. Permissions: read Campaign Manager The campaign_manager role gives a user the ability view Charitable campaigns and donations in the admin, without being able to change settings.…

  • Donation Fields API

    The Donation Fields API is provides a powerful, flexible way to add, remove and edit your donation fields. What are donation fields? How do I get the value for a particular field? How do I add a new field to my donation form? How do I change an existing donation field? How do I add…

  • Charitable_Donation_Field

    The Charitable_Donation_Field class allows you to create new donation fields or edit existing ones. Table of Contents Usage Create a new donation field Get an existing donation field Properties Methods __construct set __set __get Usage Create a new donation field If you want to add a new donation field, you will first need to create…

  • Hooks and filters in Stripe

    Like all Charitable extensions, Charitable Stripe is designed to be developer-friendly and includes hooks and filters that will help you make any customizations you need. Filters Action Hooks

  • Charitable_User

    The Charitable_User class allows you to get access to information about a particular user. Charitable_User is a sub-class of WP_User. Getting an instance of Charitable_User Given a user ID, you can retrieve a Charitable_User instance in one of two ways: The advantage of using charitable_get_user is that it uses the object cache to retain the…

  • Charitable_Donor

    The Charitable_Donor class allows you to get access to information about a particular donor. Getting an instance of Charitable_Donor A Charitable_Donor instance can be retrieved in different ways depending on the context in which you need to use it. With a donor ID With a donor ID and a donation ID With a donation object…

  • Charitable_Campaign

    The Charitable_Campaign class allows you to get information about a particular campaign. Getting an instance of Charitable_Campaign There are two primary ways to get a Charitable_Campaign object: While both options work, we recommend using charitable_get_campaign for forward-compatibility (in case we add object caching for campaigns or filtering). Class source code Methods get( $meta_name, $single = true ) Get a…

  • Hooks & Filters in Fee Relief

    Filters charitable_fee_relief_theme_template_path Customize the directory to use for template files in themes/child themes. Returns: String. Set to charitable/charitable-fee-relief by default. Arguments: None. Usage: add_filter( ‘charitable_fee_relief_theme_template_path’, function( $path ) { return ‘my-custom-template-path’; } ); charitable_fee_relief_languages_directory Customize the directory to use for translation files. Returns: String. Set to charitable-fee-relief/languages by default. Arguments: None. Usage: add_filter( ‘charitable_fee_relief_languages_directory’, function(…

  • Setting up a Stripe Webhook

    Note: Most of the time, you will not need to create a Stripe webhook manually, as Charitable will set one up for you automatically. However, if something goes wrong with that process, you can follow the steps below to (re)set up your webhook manually or to confirm your webhooks exist in Stripe. What is a…

  • Account Filters

    Filters charitable_disable_admin_bar Sets whether the admin bar should be disabled for everyone who does not have edit_posts or manage_charitable_settings caps. Returns: Boolean. true by default. Return false to enable the admin bar for everyone. Arguments: None. Usage: add_filter( ‘charitable_disable_admin_bar’, ‘__return_false’ ); charitable_disable_admin_access Sets whether admin access should be disabled for everyone who does not have…

What's New In Charitable

🔔 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!

Integration New

WordPress Command Palette Integration

Take your fundraising workflow to the next level. Speed up your site management and stay in your creative flow with our new WordPress Command Palette integration.

Supercharge Your Workflow
Navigate your fundraising dashboard faster than ever.

The Ultimate Keyboard Shortcut Hit Cmd + K (or Ctrl + K) to launch the Command Palette and manage your campaigns instantly.

⚡ Instant Navigation: Jump directly to your Campaigns, Donations, or Settings from anywhere in the editor.

➕ Quick Create: Start a new fundraising campaign or add a manual donation with a single command.

Efficiency Redefined
The tools you need, exactly when you need them.

⚙️ Contextual Actions: See relevant Charitable commands based on whether you’re editing a page or viewing your reports.

🚀 Seamless Integration: Built directly into the WordPress core experience for a lightweight, native feel.

Improvement New Security

📣 New Security Features

We’ve introduced a suite of new security tools to give you total control over who accesses your forms, plus a new way to tidy up your database.

Advanced Security Suite

Layered protection: Cloudflare, ReCAPTCHA, IP Controls, and Rate Limiting.

We have overhauled our security settings to stop bots without blocking real donors.

  • 🤖 Flexible Protection: Choose between Google reCAPTCHA v3 or the privacy-first Cloudflare Turnstile to block bots invisible.

  • 🚦 Rate limiting: Stop spam floods by limiting how many submissions an IP address can make in a set timeframe.

  • 🛑 Total control: Use the new IP Blacklist to block bad actors instantly, or the IP Whitelist to let your team bypass checks during testing.

The Clean Donation Tool

Go from “Testing” to “Live” in seconds.

Finished setting up your site and need to get rid of all those test transactions?

  • 🧹 Sweep it clean: Bulk delete test donations and donor records with a single click.

  • 📉 Accurate reporting: Ensure your revenue stats are 100% accurate for launch day.

  • ⚙️ Reset sequences: Automatically resets sequential invoice numbering.

Check out all the new security features »
donation form New

🏗️ Visual Donation Form Builder

Building the perfect donation form just got easier. We have completely reimagined how you create forms with a new drag-and-drop interface.

Design Visually, in Real-Time

No coding, no guessing. Just point, click, and build.

Say goodbye to confusing settings pages. You can now edit your form and see exactly what your donors will see, instantly.

  • 🖱️ Drag & Drop: Easily add fields like names, addresses, or file uploads by dragging them exactly where you want them.

  • 🎨 Customize everything: Click any field to tweak labels, placeholders, and requirement settings on the fly.

  • 👁️ Live preview: See your changes immediately as you make them—ensure your form flows perfectly before you hit publish.

Flexible & Powerful

Works with all your existing campaigns.

  • 🧩 Deep customization: Add custom HTML, shortcodes, or CSS classes for advanced branding.

  • ⚙️ Smart fields: Collect exactly what you need with support for dropdowns, checkboxes, dates, and hidden fields.

Check out the Visual Donation Form Builder »
Leaderboards New

🏆 Donor Leaderboards!

Turn your fundraising into a community event. Recognize your most generous supporters and inspire friendly competition with our new leaderboard tools.

Gamify Your Fundraising

Celebrate your top donors and encourage others to climb the ranks.

Create a public “Hall of Fame” to give your donors the recognition they deserve.

  • 🎨 Two stunning layouts: Choose the List View for a clean, data-rich table or the Card View for a modern, visual grid with avatars.

  • 🥇 Automatic highlights: The top 3 supporters get special Trophy and Crown icons to make them stand out.

  • 🧩 Place it anywhere: Add it to any page using the new Gutenberg Block, or drop it directly into your campaign using the Visual Builder.

Total Customization

You decide what to show and what to hide.

  • ⚙️ Flexible data: Choose to display or hide donation amounts, donor counts, or avatars.

  • 🔄 Lifetime stats: Works seamlessly with Recurring Donations to show a donor’s all-time total impact.

Check out the Donor Leaderboard »
Improvement New templates

🎨 New Templates & List Builder

Launch faster and design better. We’ve added three professional campaign templates and a versatile new content block to help you tell your story.

3 New Campaign Templates

Ready-to-use designs for specific fundraising needs.

Don’t start from scratch. Pick a template tailored to your cause and launch in minutes.

  • 🎄 Holiday Fundraiser: A warm, festive design perfect for year-end giving, toy drives, or food pantries.

  • 🎓 School Fundraiser: Built for PTAs and sports teams. clearly highlights goals like playground upgrades or classroom tech.

  • ⛪ Church Fundraiser: A trustworthy layout designed for building funds, mission trips, and tithes.

The New “List” Block

Organize your campaign details without writing code.

Make your campaign pages easier to scan and more visually engaging with our new builder block.

  • 📝 Flexible layouts: Choose from 3 distinct styles to display sponsorship levels, donation perks, or project goals.

  • 🎨 Rich customization: Add colorful headlines, support for emojis, and unlimited list items.

  • 👣 Smart footers: Include a built-in footer for extra context or a final Call to Action.

See the new templates »
View All Announcements