Description
Create campaigns, add pay buttons to pages or posts and track campaign status.
Supported payment processors:
Ask for additional payment processors and I’ll add them.
Usage
- Login to your WordPress administration panel.
- Go to Plugins and activate Kickgogo.
- Go to Options -> Kickgogo and set up your Pelepay account ID.
- Go to the Kickgogo main page and create a new campaign. Set the name to be displayed to the users in the processor payment page and the target goal. Its also possible to specify a default pay amount – it makes it easier if you don’t want to create multiple pay buttons.
- Go to the page or post where you want to put the payment button and add a button by using the short code
[kickgogo](see details below). - Go to the page or post where you want to display the status of your campaign and use the short code
[kickgogo-status]or the other display short codes (see details below).
Shortcodes
The shortcode examples below are not shown correctly in the WordPress plugin directory. You can check out the plugin home page at https://github.com/guss77/kickgogo-wordpress-plugin
for more correct details.
Payment Button
Use the [kickgogo] short code to create a payment button.
The short code takes the following parameters:
name(Required) – Specify the name of the campaign this button will apply to. Can also be the numeric ID of the campaign as shown in the campaign list. If this is not specified or an invalid value is specified, the short code will show an error message instead of the button.amount(Optional) – Specify the amount to be payed into the campaign. If this is not specified, then the default pay amount set on the campaign will be used instead. If this is not specified and the campaign has no default amount set, the short code will show an error message instead of the button.club(Optional) – set to “yes” (or actually, any text) to allow this funding amount only for club members. For this to work you’d need to create a Club Loging page, set its permalink in the Kickgogo option “Club Login Page” and also set the Club API Endpoint. See the documentation in the[kickgogo-club-login]shortcode for more details.
The shortcode also requires content which will be used as the text on the payment button. If no content is specified, the default text “Donate” is shown instead.
Example:
`
[kickgogo name=4 amount=25]Donate ₪25 to my campaign[/kickgogo]
`
Campaign Status Display
Use the [kickgogo-status] short code to create a simple text display of the current status of the campaign.
The short code takes the following parameters:
name(Required) – Specify the name of the campaign for which to display the status. Can also be the numeric ID of the campaign as shown in the campaign list. If this is not specified or an invalid value is specified, the short code will show an error message instead of the status.
The shortcode accepts content to format the status text. The format string must comply with PHP’s [sprintf](http://php.net/sprintf) format argument and must support 3 arguments, in the following order: current amount, goal, and percentage completed. If the short code is used without content, the default format is used instead, which is: %d of %d (%d%%).
Example:
`
[kickgogo-status]So far collected ₪%d out of ₪%d needed[/kickgogo-status]
`
Current Campaign Goal
Use the [kickgogo-goal] short code to show the current goal of the campaign.
The short code takes the following parameters:
name(Required) – Specify the name of the campaign for which to display the goal. Can also be the numeric ID of the campaign as shown in the campaign list. If this is not specified or an invalid value is specified, the short code will show an error message instead of the goal.
Current Campaign Funds
Use the [kickgogo-amount] short code to show the current amount of funds collected for the campaign.
The short code takes the following parameters:
name(Required) – Specify the name of the campaign for which to display the current amount. Can also be the numeric ID of the campaign as shown in the campaign list. If this is not specified or an invalid value is specified, the short code will show an error message instead of the current amount.
Current Campaign Funding Percentage
Use the [kickgogo-percentage] short code to show the current percentage of funds collected of the goal total for the campaign.
The short code takes the following parameters:
name(Required) – Specify the name of the campaign for which to display the current percentage. Can also be the numeric ID of the campaign as shown in the campaign list. If this is not specified or an invalid value is specified, the short code will show an error message instead of the current percentag.
Note that if the campaign funding passes the goal, the value shown will be higher than 100%.
Current Campaign Funding Progress Bar
Use the [kickgogo-progress] short code to show the current progress of the campaign as a progress bar.
The short code takes the following parameters:
-
name(Required) – Specify the name of the campaign for which to display the progress. Can also be the numeric ID of the campaign as shown in the campaign list. If this is not specified or an invalid value is specified, the short code will show an error message instead of the progress bar.Note that the progress bar only goes as far as %100 – if the campaign is over funded, the bar will still show 100%.
Current Campaign Donation Count
Use the [kickgogo-payments] short code to show the number of donations received so far.
The short code takes the following parameters:
name(Required) – Specify the name of the campaign for which to display the current donation count. Can also be the numeric ID of the campaign as shown in the campaign list. If this is not specified or an invalid value is specified, the short code will show an error message instead of the donation count.
Club Login Page
Use the [kickgogo-club-login] short code to create a club login form. This is needed to support the club attribute of the main [kickgogo] shortcode.
This shortcode must be used on a different page than the compaign pages as the login only works when moving between pages. To set it up:
- Create a new page for the club login.
- Add into it the
[kickgogo-club-login]shortcode. - Add any additional text and styling you want, or customize the permalink.
- Copy the permalink path (the URL shown under the page title, without the host name – everything after and including the first slash) and set it in the Kickgogo option Club Login Page.