开源软件名称（OpenSource Name）：

开源软件地址(OpenSource Url)：

开源编程语言(OpenSource Language)：

开源软件介绍(OpenSource Introduction)：

Charitable Code Snippet library

This is a library of code snippets designed to help end users and theme or plugin developers.

How to use the code snippets

If you are new to PHP or WordPress development, we recommend adding these code snippets using the Code Snippets plugin. This allows you to add the code directly within your WordPress dashboard.

For those a little more familiar with WordPress development, you can use the snippets to create simple standalone plugins. Read the WordPress documentation about creating a plugin.

Alternatively, you could add the snippets directly to your theme or child theme's functions.php file.

How to use the custom templates

Customizations shown in the custom templates folder should be added using your theme or child theme. The templates cannot be added using the Code Snippets plugin or a custom plugin.

Each snippet shows where the tempalte should be saved in your template's folder.

Contributing a snippet

We welcome and encourage everyone to submit their code snippets. If you would like to submit your snippet, please fork the repository and then create a pull request.

Directory

General

• Unhook default Charitable template functions
• Add the User Dashboard menu at the top of all User Dashboard pages
• Change plugin text
• Load template files in the admin

Editing Forms

• Remove form fields
• Change form fields
• Change the labels of form fields
• Change whether a form field is required
• Add HTML before form fields
• Add HTML after form fields
• Add a description/paragraph field to a form
• Add arbitrary HTML to a form
• Applying a pattern attribute to the postcode field
• Applying a pattern attribute to the phone field
• Require US-formatted phone numbers (111-111-1111)

Donation form

Registering new fields (examples for charitable 1.5+)

• Adding a text field (detailed example)
• Adding a text field (condensed example)
• Adding a checkbox field
• Adding a select field
• Adding a picture field
• Adding multiple fields at once
• Adding a new field, but only showing it for a specific campaign
• Adding an "Organisation" field
• Adding a dynamicaly populated hidden field to the donation form

Changing fields & other

• Moving fields in relation to each other
• Make a donation field required
• Make the donor address fields required
• Replace label with placeholder attribute for each donation field
• Remove donation form fields
• Remove login form
• Add campaign title as a header
• Display a specific donation form
• Change the section headers
• Change the section headers on a per-campaign basis
• Move donor details section to end of form, after payment form
• Add an opt-out for receiving the donation receipt
• Show the Offline payment instructions in the donation form
• Change the donation cancellation URL
• Prevent donor fields from being hidden by default for logged in users
• Disable the nonce check for non logged-in users
• Convert form into multi-step form with Javascript

City

• Change the City field to a dropdown/select field

State

• Change State field to Province
• Change State field to a dropdown list of US states, with a default

Postcode

• Change Postcode field to ZIP Code
• Require a specific format for the Postcode field

Country

• Change the Countries list to only list a few specific countries
• Change which countries are accepted in the donation form on a per-campaign basis
• Change the Countries field to a hidden field with a default country for all donors
• Add a default "Select your country" choice to the list of countries

Donation Amounts

• Change the "Custom amount" field label
• Change the "Custom amount" field label on a per-campaign basis
• Set fixed donation amount
• Set the default donation amount for all campaigns
• Set the default donation amount on a per-campaign basis
• Set the minimum donation amount
• Set the maximum donation amount
• Allow people to make $0 "donations"

Terms & Conditions

• Remove Terms & Conditions, Privacy Policy and User Consent fields

Admin donation form (manual donations)

• Allow manual donations without an email address

Donation receipt

• Display a link back to the campaign from the donation receipt
• Display a summary of the amount raised for the campaign
• Set a custom donation receipt page
• Set a custom donation receipt page for offline donations
• Set a custom donation receipt page for recurring donations
• Set a custom recurring donations receipt page (this is the receipt for the recurring donation, not the donation)

Donations

• Treat Pending donations as "Approved" donations
• Automatically mark Offline donations as Paid
• Add a Donate button with modal to your template

Emails

General

• Add email headers
• Remove campaign name from donation summaries in emails
• Add a custom campaign field to display in emails
• Add a custom donation field to display in emails
• Add a custom email field to show in campaign or donation-specific emails
• Add a custom donation field to display in emails with conditional values
• Add an email tag for an existing field (Donation Fields API)
• Add the offline payment instructions to donation emails
• Add the payment method used for the donation to donation emails
• Change the footer text in all emails

Donation Receipt

• Send donation receipt to customer for Offline donations that are Pending
• Turn off the donation receipt for Offline donations
• Copy the donation receipt to the website admin

Donation Notification

• Send donation notifications to admin for Offline donations that are Pending

Campaigns

Campaign Page

• Use the Page template for campaigns
• Add featured image to the top of the campaign
• Remove campaign summary block
• Remove campaign summary block from a specific campaign
• Remove the donor count
• Remove the donor count from a specific campaign
• Add a progress bar before the campaign summary block
• Move the campaign summary block below the Extended Description
• Move the campaign summary block & description below the Extended Description
• Change the campaign finished notice

Campaign Grid/Loop

• Remove the funds raised & progress bar in the campaigns grid
• Remove the campaign descriptions from the campaigns grid
• Add a custom field to the campaigns grid
• Add a Read More link to the campaigns grid
• Change the Thumbnail size in the campaigns grid
• Display the campaign creator name in the campaign page and [campaigns] output

Other

• Add a progress bar shortcode
• Register a Post Parent field
• Disable description text santization
• Round the percentage donated to a whole number
• Change the amount shown as donated to a particular campaign
• Change the donor count for a particular campaign
• Change the campaign slug base
• Change the campaign rewrite rules to disable the with_front setting
• Enable the Block Editor for campaigns
• Add a "Campaigns" menu tab to the WordPress dashboard
• Disable donations to a campaign after it has reached its goal
• Bulk update campaign end dates
• When a campaign becomes fully funded, give it an "Funded" tag and change its end date
• Add a field to the campaign editor to pick a custom donation page

Notifications

• Send notification emails to the admin & new user when someone registers (credit: altatof)

Users

• Allow admin access for donors and campaign creators
• Show the admin bar to donors and campaign creators

Login form

• Change the arguments passed to the login form (uses wp_login_form())
• Redirect to the previous page after logging in
• Use the Charitable login page for wp_login_url()

Profile form

• Remove a section
• Remove the organisation field
• Add a field to the "Your Details" section
• Keep a user's Display Name the same as their Login name
• Require a specific format for the Postcode field
• Change the Countries list to only list a few specific countries

Registration form

• Add additional fields to the form
• Send emails to the new user and admin after a user registers
• Redirect the user to a custom page after registration
• Set the role of new users

Widgets

Donation Stats

• Customize the stats to show in the Donation Stats widget

Donors

• Only show the donor's first name and initial of last name
• Include donors with pending donations

Styles

• Change the default highlight colour

Currency

• Add a new currency, with a currency symbol
• Add an "Hours" currency
• Change the currency format according to the locale

Countries

• Add Kosovo to the countries list

Privacy

• Show whether terms and conditions were accepted in the admin and export
• Remove Terms & Conditions, Privacy Policy and User Consent fields

Export

• Add a column to the Donations export
• Remove a column from the Donations export
• Format the date in the Date of Donation column
• Add separate columns for each category/tag in the Donations export
• Add campaign creator name to the Donations export
• Add extra campaign creator columns to the Campaigns export

Payment Gateways

PayPal

• Collect shipping information in PayPal
• Set a custom item name for donations in PayPal
• Set the locale in PayPal
• Use a different currency for PayPal

Offline

• Show the Offline payment instructions in the donation form
• Register fields and display them when the donor selects the "Offline" payment method
• Set a custom donation receipt page for offline donations
• Automatically mark Offline donations as Paid
• Send the Campaign Creator Donation Notification for Offline donations when they're pending
• Add the offline payment instructions to donation emails
• Disable Offline payment method for recurring donations

Stripe

• Set a custom statement descriptor
• Accept more payment methods in Stripe Checkout

PayUMoney

• Modify the arguments sent to PayUMoney

PayFast

• Modify the arguments sent to PayFast
• Modify the payment reference/description sent to PayFast

Extensions:

Charitable Ambassadors

Campaign Form

Adding, changing and removing fields

• Add text field
• Add select field
• Add phone number field
• Add address fields to the "Your Details" section
• Add start date field
• Add field to "Who Are You Raising Money For?" section
• Add a "Gallery" field to the campaign form and display the gallery on the campaign automatically
• Change field labels
• Change editable fields to non-editable and vice versa
• Change the options shown for the categories field
• Change the categories field to be a required field
• Change the recipient type labels for "Personal Causes" and "Your Organization"
• Change which fields are required in the Campaign Details section
• Change which fields are required in the Your Details section
• Change all fields to be required
• Change the "Goal" field to be required
• Change the PayPal payout details field
• Change the Campaign Details header
• Change the Who Are You Raising Money For? header
• Change the "Length" field to an end date field