WordPress MicroPayments (CMMP) - Use Case - How to Set Up Fundraising Goals and Collect Donations
Use Case - How to Set Up Fundraising Goals and Collect Donations
Note: This use case requires this to be installed and activated:
- WordPress MicroPayments - This document uses version 2.3.6.
Introduction
The WordPress MicroPayments is a payment system for WordPress that allows you to create digital wallets for your users, reward them with points, and let them pay for them using real money.
Use Case Front-End
Creating and managing fundraising goals:
Displaying fundraising goals:
Wallets: What is a Wallet?
The Wallets are the "accounts" to which the points have to be connected to. They work very similar to bank accounts, or real life wallets.
Use Case Assumptions
In this example use case guide, we'll cover how to let users collect points donations by setting up fundraising goals.
We consider that you have already bought the plugin, but not installed it.
It follows:
- Installing the plugin
- Quick recap
- How to create and edit goals
- How to display goals
- Appearance settings
- Translating front-end interface (labels)
- Notifying about reaching the goal
- End result
Installing the Plugin
The process is the same for all CM plugins.
- Download the add-on from your customer dashboard.
- Log in to WordPress and navigate to the WordPress Admin → Plugins settings.
- Click on Add New.
- Activate it and add the license.
Learn more: Getting Started - Installation And First Steps
Quick Recap - Setting Up WordPress MicroPayments
If you still have question with these steps:
- Setting up WordPress MicroPayments
- How users can obtain points
- Grant points for purchase
- Use points for discounts
- Translating the interface
- Shortcodes
- Reports
- Exporting wallets to CSV
- Adding or subtracting points periodically
- Troubleshooting
Then check the guide WordPress MicroPayments (CMMP) - Use Case - How to Allow Users to Buy Points Using Real Money
How to Create and Edit Goals
To let user create and edit goals on the front-end, you need to prepare a page using the shortcode [cmmp_manage_goals]
, which displays the dashboard.
This shortcode has one parameter capability which allows to define what users are able to access the dashboard. Different user roles have different sets of capabilities. For example, usually all user roles have the capability "read", including the user role Subscriber. Using such capability as "publish_posts" will let such user roles as Author and Editor to user the dashboard, but not Subscriber, as this role doesn't have this capability by default. Learn more about Roles and Capabilities.
So, for example, if you want all logged-in users to be able to use the dashboard for managing goals, you can place the following shortcode on the page:
[cmmp_manage_goals capability="read"]
Let's check the result on the front-end as a logged-in user. He can see a table with his goals (which is empty at the moment), and the button Add New Goal:
So let's click the button Add New Goal and create one. There will be a form with the following fields:
- Title - Write a title of your fundraising campaign.
- Description - Write a description of your fundraising campaign.
- Status - Choose the status of the fundraising campaign:
- Pending - If you're creating a draft and want to keep it unpublished.
- Publish - To post the campaign for public.
- Target Points - Define the amount of points that you want to collect during this fundraising campaign.
- Deadline Date - Optionally, define the deadline date by which you need to collect the points.
- Wallet - As users are able to have multiple wallets, you need to choose, which wallet to use for collecting points from this fundraising campaign.
- Reached Action - Choose what to do when the define amount of points is collected:
- Stop Collecting - When the defined amount of points is collected, users will not be able to donate more points for this fundraising campaign. Instead of it they will see a message that the campaign goal is achieved. The message can be customized in the field below.
- Continue Collecting - In this case, when the defined amount of points is collected, users will still be able to donate more points, even knowing that the campaign goal is achieved.
- Reached Stop Message - You can customize the message that users will see when the option Stop Collecting is chosen in the previous settings, and the campaign goal is reached.
Here's an example of filling the form:
After clicking the button Save, you will see a message about successful creating of the goal and it will appear in the table. Here you can see Goal Title, Wallet, Status, Target Points, Collected Points and 2 actions - Edit and Delete:
The same way you can create more goals.
How to Display Goals
Now we need to display the goals on the front-end. It can be done with the shortcode [cmmp_display_goals]
. By default, this shortcode displays goals of all users. It also has a parameter userid which allows to display goals only of a certain user. This parameter accepts the user ID as a value. Example: [cmmp_display_goals userid="1"]
So let's display goals of the specific user by placing the shortcode to the page:
Now let's check it on the front-end (as another logged-in user). For each goal you can see how many points are collected out of the needed aim, and the progress bar shows the current percentage. Below it you can see the title, description and dateline (if specified). And at the bottom there's a field where the user can choose how many points he wants to donate, and choose one of his wallets where the points should be charged from.
If the wallet does not have enough points, the user will see a relevant message:
If the wallet has enough points, the donation will be successfully done - the page will be reloaded and the progress bar will show the actual info.
Once the goal is reached, there are 2 possible ways how the goals will behave, depending on which option was chosen while creating the goal:
- Stop Collecting - If this option was chosen, then after the goal is reached, the options for donation will be hidden, and users will see the message that the goal is reached.
- Continue Collecting - Users will be able to send more points after the goal is reached.
Appearance Settings
There are a few appearance settings which you can change. To find them, navigate to Admin Dashboard → CM Micropayment Platform → Settings → General tab.
Scroll down to the section Goals. You can find the following settings there:
- Progress bar - Choose if to display the progress bar and what it info it should contain. You can choose between:
No - Don't display the progress bar.
With actual numbers - Show only the amount of collected points.
With percentage - Show only the percentage of the total amount collected.
With actual numbers and percentage both - Show both the amount of collected points and percentage.
- Progress bar background color - Set the background color of the progress bar.
- Progress bar text color - Set the font color in the progress bar.
Translating Front-end Interface (Labels)
There are also a set of front-end labels (both for managing and displaying goals) which you can edit or translate. You can find them under the Labels tab.
The relevant labels are on the screenshot below:
Notifying About Reaching the Goal
It is also possible to notify the fundraising campaign owners when the goal is reached. To enable and configure the email notification, head to the Notifications tab.
Scroll down and find the following options:
- Send "Goal reached" Notifications - Enable this option to notify fundraising campaign owners about reaching the goal.
- "Goal reached" e-mail - title - Edit the email template title.
- "Goal reached" e-mail - content - Edit the email template body. This field accepts the following placeholders:
[userName]
- User name of the fundraising campaign owner.[goalName]
- Title of the relevant fundraising campaign.
Once the goal is reached, the campaign owner will receive an email. Example:
End Result
Following instructions found in the plugin and guides, you should be able to let users collect points donations by setting up fundraising goals.
Use Case Front-End
Creating and managing fundraising goals:
Displaying fundraising goals:
More information about the WordPress MicroPayments plugin Other WordPress products can be found at CreativeMinds WordPress Store |
|
Let us know how we can Improve this Product Documentation Page To open a Support Ticket visit our support center |