WordPress.org

Ready to get started?Download WordPress

Plugin Directory

Personal Fundraiser

Expand your fundraising base by getting your donors and fans involved in the fundraising process.

Why should I use this plugin?

charity: water has raised over $28M using personal fundraising campaigns. This plugin adds the capability of creating personal fundraising campaigns on your WordPress site.

How do I get started?

  1. Once you have followed the installation instructions, navigate to /causes/sample-cause/ to see a sample cause.
  2. If you do not see anything at /causes/sample-cause/, check your Personal Fundraising settings in the admin dashboard. Check the Cause Slug value. If it is something other than causes, the sample cause is located at /SLUG NAME/sample-cause.
  3. If you still cannot locate the sample cause, check your permalink settings to make sure you are using Pretty Permalinks. For more details see: Using_Permalinks.
  4. Once you can navigate to the sample cause, fill out the fields in the popup. This will create a sample fundraising campaign.
  5. Go to the admin dashboard and click on the Causes and Campaigns menu items to look at the sample cause and the campaign you just created.

What is a Cause?

A Cause is a template used to create fundraising campaigns. As an administrator you define the look and feel of the campaigns that your users create.

When creating or editing a cause, here are several things to keep in mind:

  1. Every cause needs to have the shortcode [pfund-edit] in the content. This enables the ability for users to create and/or edit campaigns.
  2. Every cause should also have the shortcode [pfund-donate] in the content. This enables the ability for donations to be collected on campaigns created from the cause.
  3. Besides the content specified in the WYSIWYG editor, each cause has a description and image field. These fields are displayed on the cause list page.
  4. If you update the look and feel of a cause, all of the campaigns created from that cause will also have an updated look and feel.

What shortcodes does this plugin provide?

Each of the fields defined in the Personal Fundraiser Fields section of the Personal Fundraiser settings has a corresponding shortcode. In addition, the plugin provides the following shortcodes:

  • [pfund-campaign-list] Display the list of campaigns.
  • [pfund-campaign-permalink] Display the permalink(URL) for the campaign.
  • [pfund-cause-list] Display the list of causes.
  • [pfund-comments] Display the comments/donations for the campaign.
  • [pfund-donate] PayPal donate button. This shortcode is required in order to accept donations for the campaigns.
  • [pfund-edit] Required shortcode to display edit button.
  • [pfund-camp-title] The title of the campaign.
  • [pfund-days-left] The number of days left in the campaign (if an end date is specified for the campaign).
  • [pfund-gift-goal] The amount that the user hopes to raise for their campaign.
  • [pfund-gift-tally] The total amount raised.
  • [pfund-giver-list] Displays a list of supporters for the current campaign. The supported attributes are:
    • max_givers Maximum number of supporters to display. If this attribute is specified and the number of supporters exceeds this value, a set of randomized supporters will be returned.
    • row_max Number of supporters to display in one row. This attribute is simply used to add a css class to the last supporter in a row. The class is specified by the row_end_class attribute.
    • row_end_class Class to apply to last support in a row. This class is applied to the last supporter in a row.
  • [pfund-giver-tally] The total number of unique donors to the campaign.
  • [pfund-progress-bar] Displays a progress bar for the campaign. This progress bar displays how much of the campaign goal has been achieved.
  • [pfund-total-campaigns] Displays the total number of campaigns published.
  • [pfund-user-avatar] The avatar of the user who created the campaign. You can specify the size of the avatar by passing a "size" attribute (e.g. [pfund-user-avatar size="50"].

What do the various settings do?

  • Campaign Slug URL prefix for campaigns. Also the location of the page containing the list of causes.
  • Cause Slug URL prefix for causes. Also the location of the page containing the list of campaigns.
  • Currency Symbol Currency symbol to display next to monetary amounts such as amount of donations received.
  • Date Format Date format to use to display dates. The date formats correspond to the ones defined at: http://codex.wordpress.org/Formatting_Date_and_Time. This plugin only supports the following subset of formatting characters:
    • d Day of the month.
    • j Day of the month with no leading zeros
    • m Numeric month leading zeros
    • n Numeric month without leading zeros
    • Y Full numeric year, 4 digits
    • y Numeric year: 2 digits
  • Login Required To Create If checked, users must be logged in before they can create campaigns. If it is not checked, users may create campaigns anonymously, but those campaigns stay in draft status until the user logs in. Once the user logs in the campaign is assigned to that user.
  • Allow Users To Register If users are not logged in, allow them to register using the custom registration the personal fundraiser plugin provides.
  • Campaigns Require Approval If checked, campaigns for logged in users are saved as Pending Review until an admininstrator can approve them. Campaigns pending review are only visible to the creator of the campaign as well as admins. If this checkbox is not checked, campaigns will be publicly visible as soon as a logged in user saves them.
  • User Roles that can submit campaigns Determines what user roles can create campaigns. This setting only affects anonymous campaigns after a user logs in. If a campaign is created anonymously, but the logged in user doesn't have rights to submit a campaign, the campaign will stay in a draft status indefintely.
  • PayPal Options See below
  • Mandrill Options This plugin provides the ability to send transactional emails through Mandrill.
  • Mandrill API key Mandrill API key needed to send emails via Mandrill. This API key can be obtained from Mandrill at: SMTP & API Credentials.
  • Campaign Approval HTML Email The contents of the HTML email to send campaign approved emails. The following merge fields are passed to Mandrill:
    • NAME The display name of the user who created the campaign.
    • CAMP_TITLE The title of the campaign.
    • CAMP_URL The URL for the campaign.
  • Campaign Approval Text Email The text version of the Campaign Approval Email.
  • Campaign Approval Email Template (Optional) If you would like to use a Mandrill template for the Campaign Approval Email, enter in the name of the template here.
  • Campaign Donation HTML Email The contents of the HTML email to use to send campaign donation emails. The following merge fields are passed to Mandrill:
    • NAME The display name of the user who created the campaign.
    • CAMP_TITLE The title of the campaign.
    • CAMP_URL The URL for the campaign.
    • DONATE_AMT The amount donated.
    • DONOR_ANON If the donation was an anonymous donation, this value will be "true".
    • DONOR_FNAM Donor's first name (if not an anonymous donation).
    • DONOR_LNAM Donor's last name (if not an anonymous donation).
    • DONOR_EMAL Donor's email(if not an anonymous donation).
  • Campaign Donation Text Email The text version of the Campaign Donation Email.
  • Campaign Donation Email Template (Optional) If you would like to use a Mandrill template for the Campaign Donation Email, enter in the name of the template here.
  • Goal Reached HTML Email The contents of the HTML email to use to send an email when the campaign goal is reached. The following merge fields are passed:
    • NAME The display name of the user who created the campaign.
    • CAMP_TITLE The title of the campaign.
    • CAMP_URL The URL for the campaign.
    • GOAL_AMT The goal that was reached.
  • Goal Reached Text Email The text version of the Goal Reached Email.
  • Goal Reached Email Template (Optional) If you would like to use a Mandrill template for the Goal Reached Email, enter in the name of the template here.
  • Personal Fundraiser Fields Defines the fields that are available for use for personal fundraisers. Each field has the following settings:
    • Label The text to display to identify this field on the campaign creation/edit screen.
    • Description A longer text description of the field that will be displayed on the campaign creation/edit screen.
    • Type Defines the type of field. The following types are available:
      • Date Selector Displays a date picker to the user.
      • Campaign Title The field used to contain the campaign title. This field is required and the type cannot be changed.
      • Campaign URL slug The field used to contain the campaign url suffix. This field is required and the type cannot be changed.
      • End Date The field used to contain the campaign end date. The type of this field cannot be changed.
      • Large Text Input (textarea) Provides a large textbox for users to provide text.
      • Image Provides an image upload.
      • Select Dropdown Displays a dropdown for users to select a value.
      • Text Input Simple text input field.
      • Fixed Input Intended for future development. Generally the idea of this field is pass along fixed data when a donation is processed. Useful if you need additional fields to categorize donations.
      • User Email Email field that will default to the user's email but can be overriden with any valid email address.
      • User Display Name Text input field that defaults to the user's display name but can be overriden with any value.
      • User Goal The field used to contain the campaign goal. This field is required and the type cannot be changed.
    • Data Currently only used by Select Dropdown fields, this field defines the valid values for the drop down. Each value for the drop down should be separated by a new line.
    • Required If this checkbox is checked, this field is required in order to create or update the campaign.
    • Shortcode The shortcode to use to display this field on the campaign.
    • Actions Actions that can be taken on the field:
      • Delete the field. Note that the field will not actually be deleted until you click on the "Save Changes" button.
      • Move Up/Move Down Change the display order of the field on the campaign creation/edit screen.

Can I use any of the shortcodes elsewhere on my site?

Yes, you can! In the admin dashboard, when you edit a campaign you will see a list of shortcodes that you can use elsewhere in your site.

How do I use PayPal?

Using PayPal requires a Premier or Business PayPal account. In order to work properly with the Personal Fundraiser plugin, there are several settings that must be set on your PayPal account. Also there two fields on the Personal Fundraising settings screen that must be set. These values can be obtained by logging into PayPal:

Donate Button Code

  1. Click on Merchant Services.
  2. Under Create Buttons, click on Donate.
  3. Fill in your Organization name and optionally fill in a Donation ID. Both these values will be displayed to the user during the PayPal checkout process.
  4. Optionally, you may customize the text or appearance of the button.
  5. For contribution amount, select Donors enter their own contribution amount.
  6. For Merchant account IDs, select Use my secure merchant account ID.
  7. Click on Create Button.
  8. Copy all of the HTML code from the Website tab and paste it in the Donate Button Code field.

PayPal has more information on using a donate button here: PayPal Donate Button.

Payment Data Transfer Token

  1. Click My Account tab.
  2. Click on Profile.
  3. Click on My Selling Tools under My Profile on the left hand side of the screen.
  4. Under the "Selling Online" section, click on Update for the line titled Website Preferences.
  5. Make sure that Auto Return for Website Payments is turned on.
  6. For Return URL, specify your site's URL. The plugin will override this value to return to the campaign once a donation is processed.
  7. Under the Payment Data Transfer (optional) section, make sure that Payment Data Transfer is On. If it is already on, copy the Identity Token value and paste it into the Payment Data Transfer Token field. If it is not on, turn it on, click on Save at the bottom of the page and then click Website Payment Preferences in the Seller Preferences column to display the screen again with the Identity Token value.

Instant Payment Notification

Instant Payment Notification or IPN is a secondary measure to ensure that a PayPal donation is recorded by the personal fundraiser. This is used in cases where a donor closes their browser window after submitting a donation but before returning to your site.

  1. Click My Account tab.
  2. Click on Profile.
  3. Click on My Selling Tools under My Profile on the left hand side of the screen.
  4. Under the "Getting paid and managing my risk" section, click on Update for the line titled Instant payment notifications.
  5. If instant payment notifications is turned off, click on the button that says Choose IPN Settings. If it is turned on, you do not need to do anything else.
  6. For Notification URL, specify your site's URL. The plugin will override this value.
  7. For IPN messages, select Receive IPN messages (Enabled).
  8. Click on Save to save your settings.

Use PayPal Sandbox

If you are using PayPal's developer sandbox for testing, check this checkbox; otherwise leave it unchecked.

How do I use Authorize.Net?

Using Authorize.Net first requires that you have a SSL Certificate for your site and the capability of running at least part of your site via https.

In order to work properly with the Personal Fundraiser plugin, there are several settings that must be obtained from your Authorize.Net account. These values can be obtained by logging into Authorize.Net:

API Login ID

  1. Click on Account.
  2. Under Security Settings, click on API Login ID and Transaction Key.
  3. If an API Login ID value has already been generated and is visible, copy the API Login ID from the API Login ID and Transaction Key screen and paste it in the API Login ID field on the Personal Fundraiser settings screen.
  4. If an API Login ID value has not already been generated: do the following, type in your Secret Answer. You should have configured a Secret Question and Secret Answer during account activation.
  5. Click Submit to continue. The API Login ID and Transaction Key generated for your payment gateway account appear. Copy these values to the corresponding values on the Personal Fundraiser settings screen.

Transaction Key

  1. Click on Account.
  2. Under Security Settings, click on API Login ID and Transaction Key.
  3. Under the section titled Create New Transaction Key, type in your Secret Answer. You should have configured a Secret Question and Secret Answer during account activation.
  4. Click Submit to continue. The API Login ID and Transaction Key generated for your payment gateway account appear. Copy these values to the corresponding values on the Personal Fundraiser settings screen.

Product/Donation name

Specify the description that should be used for the transactions. If this is empty, this will default to "Donation".

Use SSL

Unless you are using the Authorize.Net sandbox for testing, this checkbox should be checked. When checked, all campaign pages will be served as secure (https) pages.

Test Mode

Check this checkbox if you are using a test Authorize.Net account; otherwise it should be unchecked.

Requires: 3.6 or higher
Compatible up to: 3.8.3
Last Updated: 2014-3-31
Downloads: 10,322

Ratings

4 stars
4.7 out of 5 stars

Support

2 of 11 support threads in the last two months have been resolved.

Got something to say? Need help?

Compatibility

+
=
Not enough data

0 people say it works.
0 people say it's broken.

100,1,1
100,2,2
50,2,1
0,2,0 50,4,2
100,2,2
0,1,0