Knowledgebase

Need help with Total Donations? You're in the right place.

Shortcode Arguments

Shortcodes are special kinds of content (e.g. forms, progress bar) that you can attach to pages easily by adding the corresponding shortcode into the page. This allows you to easily embed files that would normally require complicated code. For example, to insert the shortcode for the donation form, you would add this shortcode [totaldonations] anywhere on the page that you’d like to use for receiving donations. Below is a list of all the shortcodes and the arguments that they take. You can add more than one argument to a shortcode.

Note: If you’d like to add a shortcode inside of a WP template file, you can by using the “do_shortcode” method: echo do_shortcode('[totaldonations-recent-donors]');

[totaldonations_progressbar]

This shortcode display a progress bar and the text info related to it. To set up the progress bar and the info text, please go to the “Customize Theme” page. An example shortcode would look like [totaldonations_progressbar id="2" button_text="Visit" button="yes" link="https://totaldonations.com/freeversion/"]. The available arguments are:

link=”

Example Argument
[totaldonations_progressbar id="1150"] id: defines which campaign the bar shows based on form_id. To see the form_id for each campaign, please see on campaign page. Enter the ID of campaign you’d like to display the progress bar for, inside the shortcode area.
[totaldonations_progressbar button="yes"] button: only accepts two values: yes and no. This tells the bar if it is using the link button or not.
[totaldonations_progressbar button_text="Donate Now"] button_text: This defines the text used on the button This shortcode works with the link and button arguments.
[totaldonations_progressbar text="yes"] text: only accepts two values: yes or no , this tells the bar if it should use the text info or not. You can change the default text through the “Customize Theme” page inside the plugin.
[totaldonations_progressbar link="https://totaldonations.com/freeversion/"] link: use this to define the URL target that appears after the button is clicked. The button must be set to on with the “button” argument in order for this to work.

[totaldonations_circlebar]

This shortcode display a circle bar and the text info related to it. To set up the circle bar and the info text, please go to the “Customize Theme” page. An example shortcode would be [totaldonations_circlebar id='2' button_text='Visit' button='yes' link='https://totaldonations.com/freeversion/'] The available arguments are:

Example Argument
[totaldonations_circlebar id="1150"] id: defines which campaign the bar shows based on the form_id. To see the form_id for each campaign, please go to campaign page inside Total Donations. Enter the ID of the campaign you’d like to display the progress bar for, inside the shortcode area.
[totaldonations_circlebar button="yes"] button: only accepts two values: yes and no. This tells the bar if it is using the link button or not. This shortcode works with the link argument.
[totaldonations_circlebar button="yes" button_text="Donate Now"] button_text: use this to define the text that appears on the button. The button must be set to on with the “button” argument in order for this to work. Works with the link and button arguments.
[totaldonations_circlebar link="https://totaldonations.com/freeversion/"] link: use this to define the URL target that appears after the button is clicked. The button must be set to on with the “button” argument in order for this to work.

[totaldonations-top-donors](full version only)

This adds a list of your top donors.

Example Argument
[totaldonations-top-donors title="Title"] title: Sets the title of the Top Donor Wall
[totaldonations-top-donors show_honoree_name="yes"] show_honoree_name: Shows the honoree name instead of the donor’s name. Arguments: “yes” or “no”
[totaldonations-top-donors num_rec="5"] num_rec: Set how many donors will be displayed, the default is 5
[totaldonations-top-donors donation_type="both"] donation_type: Choice to add only offline, online or both donors. Arguments: online, offline and both
[totaldonations-top-donors use_link="yes"] use_link: Adds a link to the donation form. Two values to choose from: yes or no
[totaldonations-top-donors btn_class="mgbtn"] btn_class: Adds a new CSS class to the button. User defined. You can use the class “mgbtn” for the grey button
[totaldonations-top-donors btn_text="donate now"] btn_text: Add the text that you want to appear on the button here . User defined.
[totaldonations-top-donors url_link="http://calmar-webmedia.com" ] url_link: use a link to point the correct form if we use button or a text link on the short code.
[totaldonations-top-donors show_anonymous="yes"] show_anonymous: The values are yes and no. If you set it to yes then anonymous donor will appear as “anonymous” on the list.
[totaldonations-top-donors campaign="ID"] campaign: Show recent Top Donor per each campaign

[totaldonations-recent-donors] (full version only)

This adds a list of your recent donors.

Example Argument
[totaldonations-recent-donors title="Title"] title: Sets the title of the Recent Donor Wall
[totaldonations-recent-donors show_honoree_name='yes'] show_honoree_name: Shows the honoree name instead of the donor’s name. Arguments: “yes” or “no”
[totaldonations-recent-donors num_rec="5"] num_rec: Sets how many donors will be displayed. The default is 5
[totaldonations-recent-donors donation_type="both"] donation_type: Choose to add only offline, online or both. Arguments: online, offline and both
[totaldonations-recent-donors use_link="yes"] use_link: Adds a link to the donation form. Two values to choose from: yes or no
[totaldonations-recent-donors btn_class="mgbtn"] btn_class: Adds a new CSS class to the button. User defined. You can use the class “mgbtn” for the grey button
[totaldonations-recent-donors btn_text="donate now"] btn_text: Add the text that you want to appear on the button here . User defined.
[totaldonations-recent-donors url_link="http://calmar-webmedia.com"] url_link: use a link to point the correct form if we use button or a text link on the short code.
[totaldonations-recent-donors show_anonymous="yes"] show_anonymous: The values are yes and no. If you set it to yes then anonymous donor will appear as “anonymous” on the the list.
[totaldonations-recent-donors campaign="ID"] campaign: Show recent donations per each campaign

[totaldonations-text-fields](full version only)

Use this short code to display info about the amount raised, the total goal, a link to a specific campaign inside a text paragraph. The available attributes for this shortcode are:

Example Argument
[[totaldonations-text-fields campaign="Save the Sun Bears"]] campaign : to define which campaign to show the amounts and other things for.
[[totaldonations-text-fields button=”yes”] button: only accept two values yes and no , this sets if it is using a link button or not.
[[totaldonations-text-fields button=”yes” button_text=”Donate to Save Bears”]] button_text : to define the text that appears on button. The button must be set to on with the “button” argument in order for this to work.
[[totaldonations-text-fields text="We have raised #total# for the #campaign# from a total of #backers# donors. This is #percetage#. We need to raise #remainder# more to reach our #target#. target' ] text: This inserts the text value. On the text itself you can additional shortcode tags inside the text. These are #backers#, #campaign#, #total#, #target#, #percentage#, #remainder#, and #textlink:donate here#. Using the argument #textlink:donate here# will create a link to the [ totaldonations ] shortcode and open up the campaign that you specify.

[totaldonations_thank_you_page]

Example
[totaldonations_thank_you_page] There are no arguments for this shortcode. This shortcode specifies what page to display the Thank You page on. If you want to redirect your donor to a new page after a donation is complete, use this shortcode. To set what the donor sees after the donation is complete go to General Settings > Notifications and Email Settings > Set the Thank You Page Here.

[totaldonations]

This short code to display the form on the front end. To define if only a single campaign is selected on the form. Use the “campaign” and “form_id” argument.

Example Argument
[totaldonations campaign="id"] (full version only) campaign: If you define a campaign here the form will act as a single campaign form ( a-form-per-campaign ) and the campaign selector will be hidden on the form. If you don’t fill the campaign in it will act as multi-campaign form that has a campaign selector inside the form. For the single campaign form, please make sure you fill the campaign Id.