WordPress.org

Ready to get started?Download WordPress

Plugin Directory

Petfinder Listings

The Petfinder Listings plugin takes advantage of the Petfinder API and can be integrated into your site without coding.

Petfinder is a free site where shelters and rescues can post pets for adoption. The Petfinder Listings plugin takes advantage of the Petfinder API and can be integrated into your site without coding. All you need is your Petfinder shelter id and free Petfinder API key.

The Petfinder Listings plugin allows you to:

  1. Display all pets listed with your shelter on Petfinder
  2. Display a featured or random pet in a widget

Demos

Example of different shelters listed on one site

Example of Featured Pet Widget

Shortcode

[shelter_list] displays a list of pets from your shelter. You must enter your shelter ID and API key in Petfinder Listings' settings page for this shortcode to work. You may also need to edit your Petfinder settings to enable sharing your data with third parties. See Petfinder settings under Frequently Asked Questions below. Optional attributes for shortcode are:

  • shelter_id - Allows you to list adoptable pets from a shelter different from the shelter id defined in your Petfinder Listings Settings.

  • breed - If you wish to list only one breed on a page. You can also add ! before the breed if you wish to list all pets who do not match this breed. See the following examples:

[shelter_list breed="Italian Greyhound"] - mixed breeds are not matched

[shelter_list breed="!Italian Greyhound"] - mixed breed are matched

  • count - The maximum number of pets to return. Defaults to 75 and must be a number. Note if you set the breed or animal attribute you need to set the count high enough to include all animals with your shelter. For example, if you have 50 animals made up of 25 cats and 25 dogs, and you have one page to list all dogs and one page to list all cats, the count should be set to at least 50 to get all cats or all dogs on both pages. Petfinder does not have a method to filter animals from a shelter so the plugin has to filter after retrieving all the results.

  • animal - Type of animal. Value should be one of the following or blank to get all: barnyard, bird, cat, dog, horse, pig, reptile, smallfurry.

  • include_info - Value should be set to "yes" or "no"; default is "yes". If set to "yes", Breeds, Spayed/Neutered, Up-to-date with routine shots, Housebroken, kid safe, cat safe, dog safe, special needs are displayed in list below photo thumbnails. Each list item has a different CSS class so you can hide any you do not want to show.

  • css_class - Set your own class name on div containing all pets. The default value is 'pets'. This allows you to control the styles separately on different pages.

  • contact - Default is blank. If set to a value, will only list animals with this contact. Contact should be set to first and last name of Contact Person in the Petfinder Contact/Location box for each animal. This can be used to customize the listings of animals on different pages if the other attributes are not enough. Contacts can be added to the Contacts Tab in the Petfinder Admin.

  • status - Default is "A" for adoptable. Values can be: A=adoptable, H=hold, P=pending, X=adopted/removed.

  • sort_by - Value can be: newest, last_updated or name. Value can also be set globally in Petfinder Settings.

  • petfinder_down_message - Set a message that displays when Petfinder is down. Example: petfinder_down_message='Petfinder is down at the moment. Please try to view our pets on our Petfinder page Here' NOTE: you can't use the same type of quote marks to quote the value and any HTML in the string.

Example using all attributes: [shelter_list shelter_id="WI185" breed="Italian Greyhound" count=75 animal="dog" include_info="no" css_class="igs" contact="Barb Smith"]

You can also list a single pet with the following shortcode [get_pet pet_id="numeric value"]

  • pet_id - Required. You can get this id from the pet's Petfinder URL. URL will look like the following: http://www.petfinder.com/petdetail/1234568 - 1234568 is the pet id.

  • css_class - Set your own class name on div containing all pets. The default value is 'pets'. This allows you to control the styles separately on different pages.

  • include_info - Value should be set to "yes" or "no"; default is "yes". If set to "yes", Breeds, Spayed/Neutered, Up-to-date with routine shots, Housebroken, kid safe, cat safe, dog safe, special needs are displayed in list below photo thumbnails. Each list item has a different CSS class so you can hide any you do not want to show.

Example using all attributes: [get_pet pet_id="23367571" include_info="no" css_class="igs"]

Widget

Add the Petfinder Listings Featured Pet widget under Appearance -> Widgets. After adding the widget to a sidebar you can set a featured pet id to display a featured pet, or leave blank to display a random pet from your shelter. Please note: Petfinder has been buggy lately about returning a random pet through their API call. It is recommended to use the widget with a Featured Pet ID. Featured Pet Widget Settings:

Featured Pet ID - This is the Petfinder System ID listed below the Pet's name on Petfinder's Pet Edit screen. (Optional - if left blank a random pet from your shelter will be displayed. Please note: Petfinder's random pet listing tends to be unstable.)

Your Listing Page URL - The page where your shortcode [shelter_list] can be found. If this is set, your featured pet will link directly to this pet on your shelter list page. (Optional)

Featured Pet Image Size - The size of the Featured Pet image. (Required)

Featured Pet Copy Size - How many characters from the Pet's description you want to display. You can also enter 0 to display full description or -1 for none. (Required)

Featured Pet PDF Link - If you would like to create a PDF with more information about your Featured Pet, link to the PDF uploaded separately through WordPress' Media here.

Requires: 3.0 or higher
Compatible up to: 3.9.1
Last Updated: 2014-5-13
Downloads: 2,981

Ratings

5 stars
5 out of 5 stars

Support

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,1,1
100,1,1 100,1,1 100,1,1
100,1,1
100,2,2
100,1,1
100,1,1
100,1,1
100,1,1 100,1,1
100,1,1