Fundraisers Plugin

Pure Charity Fundraisers Plugin

A Plugin to show fundraisers from the Pure Charity app on your WordPress site.

It depends on the Pure Charity Base Plugin being installed and it’s credentials configured to work.

Installation

IMPORTANT: At this time the plugin requires a name change after extracting from Github. After downloading the source code from Github unzip the files and rename the folder /purecharity-wp-fundraisers and compress as purecharity-wp-fundraisers.zip if you plan to use the WordPress plugin installer via upload.

In order to install the plugin:

1. Download the plugin
2. Copy the `/purecharity-wp-fundraisers` folder to the `/wp-content/plugins` on your WP install
3. Activate the plugin through the ‘Plugins’ menu in WordPress
4. You’re done!

Template Tags

Last Fundraisers

Returns HTML ready for use

 

Function: 
pc_last_fundraisers()

Parameters:

The parameters are passed as an array.

 $options = array();
 $options['param'] = 'value';

Possible parameters:

  • limit – Defaults to 4. Set the number of fundraisers to show

Fundraisers

Returns a JSON string with the fundraisers requested

Function: 
pc_fundraisers()

Parameters:

The parameters are passed as an array.

 $options = array();
 $options['param'] = 'value';

Possible parameters:

  • limit – Set the number of fundraisers to show

Fundraiser Info

Returns JSON information for the fundraiser request

Function: pc_fundraiser_info($slug)

Parameters:

$slug: The fundraiser slug

Shortcodes

For more information pertaining to the shortcode usage, you can view the README file here

Fundraisers Search

[fundraisers_search]

Possible parameters:

  • page_id – (page id) Required. Should be add the id of the page which one have fundraisers shortcode.

Fundraisers Listing

[fundraisers]

No Fundraisers Found.

Possible parameters:

  • grid – (true|false) Defaults to false. Set to true to enable the alternative grid view
  • title – (founder_name|title_and_owner_name)What to use on the title of the fundraisers. If not present, uses the fundraiser’s title
  • campaign – Campaign slug to pull fundraisers from
  • layout – (1|2|3|4) Defaults to 1. 1) 4 columns, 2) 3 columns, 3) simplified 3 columns, 4) 3 columns new layout
  • per_page – The amount of records to fetch per page
  • order – (title|name|last_name|date) Sort by name, last name or date
  • dir – (asc|desc) Direction of sorting
  • hide_search – (true) Option to hide the search in specific shortcode applications
  • Choose the layout above to use for the shortcode to overwrite the plugin’s settings (Only works if grid=true)

Last Fundraisers Listing

[last_fundraisers]


No Fundraisers Found.

Possible parameters:

  • title – (founder_name|title_and_owner_name) What to use on the title of the fundraisers. If not present, uses the fundraiser’s title
  • limit – Defaults to 4. Set the number of fundraisers to show
  • order – (name|date) Sort by name or date
  • dir – (asc|desc) Direction of sorting

Single Fundraiser

[fundraiser slug=fundraiser-slug]

Possible parameters:

  • slug – (required) The slug of the fundraiser on the Pure Charity app.
  • title – (founder_name|title_and_owner_name) What to use on the title of the fundraisers. If not present, uses the fundraiser’s title