Charitable Documentation

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

Campaigns Shortcode

The [campaigns] shortcode allows you to display a collection of campaigns within your posts or pages.

Parameters

  • number: The number of campaigns to show. Set this to -1 to show all campaigns. Defaults to the number of posts you show on blog pages.
  • orderby: The order in which campaigns are displayed. Options include post_date, popular and ending. As of version 1.4, you can also use any of the options that WP_Query accepts. Defaults to post_date.
  • order: Change the direction in which campaigns are ordered. Accepts DESC or ASC. Defaults to DESC.
  • category: Only show campaigns within certain categories, identified by the category slug. Pass multiple category slugs as a comma separate list to include more than one category.
  • tag: Only show campaigns with certain tags, identified by the tag slug. Pass multiple tag slugs as a comma separated list to include more than one tag. Introduced in Charitable Pro.
  • creator: Only show campaigns created by a certain user. User must have their user ID passed.
  • exclude: Exclude specific campaigns by their ID. Pass multiple IDs as a comma separated list to exclude more than one.
  • include_inactive: Include campaigns that have expired by setting this to 1 or true. Defaults to false.
  • status: Filter campaigns by status. Options include active (only active campaigns), ended (only ended campaigns), or all (all campaigns regardless of status). This parameter takes precedence over include_inactive. Introduced in Charitable Pro.
  • columns: Choose how many columns you want to display the campaigns in. Supports any number between 1 and 4. Defaults to 2.
  • button: Choose whether you want to show a Donate button (the default), a read more link (button="details"), or nothing at all (button="0").
  • id: Show specific campaigns. You can provide a single number or multiple IDs as a comma separated list.
  • parent_campaigns: Only show child campaigns of the specified parent campaign IDs. Pass multiple IDs as a comma separated list. Introduced in Charitable Pro 1.8.5.
  • parent_only: Show only parent campaigns (top-level campaigns with no parent). Set to 1 or true to enable. This parameter takes precedence over parent_campaigns. Introduced in Charitable Pro.
  • description_limit: Limit the number of words displayed from the campaign description. Accepts any positive integer. Defaults to 100. Introduced in Charitable Pro.
  • responsive: Scale campaigns to a single-column layout on smaller screens. Set this to 0 to turn off the responsive behaviour, or specify a custom breakpoint with a px or em value. The default breakpoint is 768px.
  • masonry: Display the campaigns in a masonry layout (like Pinterest). Set this to 1 to enable the masonry layout. Defaults to 0.
  • pagination: Enable or disable pagination for the campaigns list. Set to true to enable pagination, false to disable. Defaults to false. Introduced in Charitable Pro 1.8.6.1.
  • pagination_position: Control where the pagination appears relative to the campaigns list. Options include top, bottom, or both. Defaults to bottom. Introduced in Charitable Pro 1.8.6.1.
  • pagination_prev_next: Control whether to show Previous/Next links in the pagination. Set to true to show these links, false to hide them. Defaults to true. Introduced in Charitable Pro 1.8.6.1.
  • pagination_first_last: Control whether to show First/Last page links in the pagination. Set to true to show these links, false to hide them. Defaults to true. Introduced in Charitable Pro 1.8.6.1.
  • pagination_mid_size: Control how many page numbers to show on each side of the current page. Accepts any positive integer. Defaults to 2. Introduced in Charitable Pro 1.8.6.1.

Usage

Default usage:

[campaigns]

Include expired campaigns:

[campaigns include_inactive=1]

Show 30 campaigns:

[campaigns number=30]

Order campaigns by the amount of money they have raised:

[campaigns orderby=popular]

Order campaigns by how soon they are ending (soonest to end is shown first):

[campaigns orderby=ending]

Only show campaigns within the “environmental issues” category:

[campaigns category=environmental-issues]

Only show campaigns with specific tags:

[campaigns tag=urgent,featured]

Only show campaigns by the user with ID 33:

[campaigns creator=33]

Display campaigns in 3 columns:

[campaigns columns=3]

Show a “read more” link for campaigns:

[campaigns button="details"]

Only display the campaigns with IDs of 33 and 44:

[campaigns id=33,44]

Show only child campaigns of parent campaign with ID 30:

[campaigns parent_campaigns=30]

Show only parent campaigns (top-level campaigns):

[campaigns parent_only=1]

Filter by campaign status (show only active campaigns):

[campaigns status=active]

Filter by campaign status (show only ended campaigns):

[campaigns status=ended]

Limit campaign description to 50 words:

[campaigns description_limit=50]

Turn off responsive styling:

[campaigns responsive=0]

Set a custom breakpoint of 600px for responsive styling:

[campaigns responsive=600px]

Enable pagination (4 campaigns per page):

[campaigns 
    number="4" 
    pagination="true" 
    pagination_position="bottom" 
    pagination_prev_next="true" 
    pagination_first_last="true" 
    pagination_mid_size="2"
]

Extra parameters added by extensions

Ambassadors

If you’re using Charitable Ambassadors version 2.0 or above, there are additional parameters you can use to filter which campaigns are shown:

  • parent: Show only the child campaigns of a specific parent campaign. This is an alias for parent_campaigns when using Charitable Ambassadors. Pass multiple IDs as a comma separated list.
  • fundraiser_type: Show only fundraiser campaigns of a specific type. Options include:
    • individual – Individual fundraisers for existing campaigns.
    • team – Team fundraisers for existing campaigns.
    • team-member – Team member campaigns.
    • fundraiser – Any campaign for an existing campaign or the organization.
    • personal – Any campaign for a personal cause.
  • fundraiser_type_not: Exclude fundraiser campaigns of a specific type. Pass multiple types as a comma separated list. Introduced in Charitable Ambassadors 2.1.0.
  • fundraise_button: If set to false, the Fundraise button will not be shown. Set it to your preferred button text if you would like to show the button. Defaults to false.
  • join_team_button: If set to false, the Join Team button will not be shown. Set it to your preferred button text if you would like to show the button. Defaults to false.

Usage

Show campaigns that are a child of the parent campaign with ID 30:

[campaigns parent=30]

Only show team fundraiser campaigns:

[campaigns fundraiser_type=team]

Only show personal campaigns:

[campaigns fundraiser_type=personal]

Exclude individual fundraisers:

[campaigns fundraiser_type_not=individual]

Show the “Fundraise” and “Join Team” buttons in the campaign grid:

[campaigns fundraise_button="Fundraise" join_team_button="Join Team"]

Geolocation

If you have Campaigns Geolocation installed, you can display campaigns on a Google Map, with some additional parameters:

  • map: Set to 1 or true to display campaigns on a map. Defaults to false.
  • width: Set how wide you want your map to be. This must be passed as a valid CSS width (400px, 100%, etc). Defaults to 100%.
  • height: Set how high you want your map to be. This must be passed as a valid CSS height. Defaults to 500px.
  • zoom: Set the initial zoom level you would like your map to display at. Defaults to auto, with the zoom level based on the pins that have been added to the map.

Usage

Display campaigns on a map width a width of 900px, height of 600px and zoom level set to 5:

[campaigns map=1 width=900px height=600px zoom=5]

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!

Donations New

👥 Introducing Donor Merging: Two Records, One Supporter!

Somewhere in your donor list is a supporter who appears twice, because they gave from a work address one year and a personal one the next. Every donation is still recorded and every receipt still went out, but a loyal supporter who has given for years can look like two people who gave half as much. From the Charitable Pro plugin 1.8.19.1 you can find those records and merge them from the Donors screen. Why this is important:

  • 🔍 A Find Duplicates link where you already work: Head to Charitable » Donors and it sits next to Filter and Export, then tells you how many groups of possible duplicates it found.
  • 🧩 Grouped by name, not by email: Charitable compares the first and last name together and ignores capital letters, spacing and punctuation, which is what catches the same person under two different addresses.
  • 📊 A preview before anything changes: Each group shows every record with its email address, its donation count and its lifetime total, and the preview shows you the combined totals and the email that will be added.
  • ↩️ Every merge can be undone: Nothing is merged until you choose to merge it, and you can reverse any merge afterwards, so a wrong guess costs you nothing.
  • 📥 Built for the week after an import: Moving donors over from another plugin is where most duplicates come from, and it is also when they are hardest to spot, because every record is new to you.

Check out our announcement here.

ambassadors New

🔑 Introducing Passwordless Fundraisers: Sign Up With Just an Email!

Supporters arrive wanting to help, and then the form asks them to invent a password for a website they may only visit twice. A lot of them stop right there. Passwordless Fundraiser Accounts, new in Charitable Ambassadors 3.5.0, let a supporter start a peer to peer fundraiser with nothing but an email address. Why this is important:

  • 🔑 No password step to lose them at: Switch it on in Charitable » Ambassadors » Templates » Submit Form and the create-fundraiser form asks only for a name, an email address and a page title.
  • 👤 Still a real WordPress account: One click in one email confirms the address, signs them in and creates the account, so they can come back later to edit their story, change their photo and see who has donated.
  • 🎚️ Your call on every campaign: Each peer to peer campaign can follow the site default or override it, which matters when a campaign pays fundraisers through Stripe Connect and those people do need a password.
  • 📋 See who has not clicked yet: The Charitable » Ambassadors » Directory » Awaiting Sign-In tab lists everyone still waiting, with the campaign they joined and a Resend button, so a typo or a spam folder is something you can spot and fix.
  • 🛡️ Links a scanner cannot use up: Opening the link only shows a page, and your fundraiser is signed in when they press the button on it, so corporate email scanners never burn the link. Each one works once, expires on its own and is stored only as a hash.

Check out our announcement here.

ambassadors New

🏃 Introducing Activity: Show Progress on More Than Money!

Most peer-to-peer fundraisers are about more than the money. A read-a-thon is about minutes read, a walkathon is about miles walked, and a food drive is about meals packed. Activity for Charitable Ambassadors lets your fundraisers show that effort right beside the dollars they raise. Why this is important:

  • 🎯 Progress on what you actually count: A progress bar shows each thing you count against its own target, sitting right beside the money raised.
  • 🏅 Milestones for the yes or no things: A milestone badge marks the efforts that are simply done or not done, with no number to chase.
  • ✍️ Fundraisers log their own numbers: Your supporters enter their totals from their own pages, so the effort stops living in a spreadsheet, a comment, or nowhere at all.
  • 🤖 Some numbers count themselves: An AUTOMATIC tag appears wherever the site worked the figure out from completed donations, so you can see at a glance what nobody typed in.
  • 🧩 Set it up once, use it anywhere: You decide what gets counted one time, then choose which campaigns count it. Available now in Charitable Ambassadors 3.4.7, with no new plugin and no developer.

Check out our announcement here.

ambassadors New

🖨️ Introducing Fliers and Posters: Raise Money Away From the Screen!

A lot of peer-to-peer fundraising happens away from a screen: at the finish line of a 5K, on a school noticeboard, in an office kitchen. Charitable Ambassadors 3.4.7 adds 2 printables, a fundraiser flier carrying each fundraiser’s own story and QR code, and a recruitment poster that signs new fundraisers up. Both open as a normal web page and print straight from the browser. Why this is important:

  • 🏁 A flier for every fundraiser: Each one carries that fundraiser’s own photo, story and goal, with a QR code that opens their page rather than your main campaign.
  • 📌 A poster that recruits: It shows “Now Recruiting” above your campaign name with a large QR code that opens your sign-up form, so someone can start fundraising without waiting on a link from you.
  • 🪄 No design tool needed: Both printables render as a normal web page and print from the browser, with no PDF plugin and no designer.
  • 📄 2 flier layouts: Hand out carries the full story for giving to friends and family, and Post up carries a short hook with 5 tear-off tabs for a noticeboard.
  • 🛡️ Off until you switch it on: Fliers stay off after the update until you enable them under Charitable » Ambassadors » Other » Fliers, and only the owner or an administrator can open one.

Check out our announcement here.

Improvement Payments

💸 Introducing Tiered Rates for Fee Relief: Match the Ask to the Gift!

Fee Relief asks your donors one short question at checkout: would you like to cover the processing fee on this gift? Until now that question used a single rate for every donation on a gateway, so a $10 gift and a $500 gift were asked for the same percentage. Fee Relief 1.3.0 lets you set as many donation bands as you like, each carrying its own rate. Why this is important:

  • 🪙 Gentler on small gifts: A fixed transaction cost is a far bigger share of a $10 donation than a $500 one, so bands let you ask for less at the bottom.
  • 🎚️ As many bands as you need: Each band carries its own percentage and its own fixed amount, and the top band runs on with no upper limit.
  • 🛑 An optional ceiling: A Maximum fee field stops any donor being asked for more than a number you choose, however large the gift.
  • 🔌 Set per payment gateway: Stripe can run on four bands while Windcave and Payfast stay on a single rate, because bands belong to a gateway and not to your whole site.
  • 🛡️ Nothing changes until you say so: Your current rates stay exactly as they are until you switch Use Tiered Rates on under Charitable » Settings » Advanced » Fee Relief.

Check out our announcement here.