This is the GitHub repository for Charitable, the WordPress donation plugin that grows with you. Charitable helps you accept donations on your WordPress website, giving you complete control over their fundraising experience. Unlike other WordPress plugins, Charitable was created with a core focus on being extendable and feature-rich.
If you are not a developer or you want to find out more about Charitable's features and extensions, visit wpcharitable.com.
If you would like to test/develop with Charitable, you can clone it into your WordPress installation via the command line:
cd /path/to/wordpress/
cd wp-content/plugins
git clone git@github.com:Charitable/Charitable.git charitable
After that, you can activate Charitable via your WordPress dashboard or with WP CLI:
wp plugin activate charitable
Note: If you are not a developer, please install Charitable via your WordPress dashboard.
If you would like to pre-populate a test site site with pages, campaigns and donations, you can use the provided setup script.
bin/setup.sh
Optional Parameters
| Parameter | Description |
|---|---|
--campaigns=<campaigns> |
The number of campaigns to be created. Defaults to 0. |
--donations=<donations> |
The number of donations to be created automatically. Defaults to 0. |
--allow-root |
Run the command as root user. This passes the --allow-root argument to the WP CLI commands. |
Example
This automatically sets up all pages with shortcodes, updates settings, then creates 10 campaigns and 500 donations.
bin/setup.sh --campaigns=10 --donations=500
masteris the primary development branch. We do not recommend using this on production sites.stableis the latest stable branch, corresponding to the most recent public release.
Past releases can be checked out via git checkout 1.5.0 (replace 1.5.0 with the release you would like to check out). View the full set of releases at https://github.com/Charitable/Charitable/releases
If you find a bug you can report it right here on GitHub. To disclose a security issue, please submit a private report.
This repository is specifically for developers; it is not a place to get general Charitable support. If you have anything you need help with with Charitable, please get in touch via our Support page.
Patches, bug reports and other contributions are always welcome!
Charitable has active translation projects in many languages, and we are always looking for new translation contributors and editors. Read more.
- Code snippets library - A collection of 130+ code snippets to customize Charitable.
- Extension boilerplate - Rapidly scaffold a Charitable extension using a one-line Grunt command.