Petfinder Listings free WordPress plugin

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 v2.0 API key and secret. The Petfinder Listings plugin allows you to: Display all pets listed with your shelter on Petfinder Display a featured or random pet in a widget Sign up to be notified when the Petfinder plugin is updated You can sign up to receive notices when this plugin is updated or other important changes here: (https://unboxinteractive.com/petfinder-plugin-email-list/) Demos Greyhound Pets of America Wisconsin Midwest Italian Greyhound Rescue Midwest Italian Greyhound Rescue lists available pets from different shelters on one site. Shortcode [shelter_list] displays a list of pets from your shelter. You must enter your shelter ID, Petfinder v2.0 API key and secret on the 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. animal – Type of animal. Value should be one of the following or blank/don’t set to get all: Dog, Cat, Rabbit, Small & Furry, Horse, Bird, Scales, Fins & Other, Barnyard. breed – If you wish to list only one breed on a page, leave blank/don’t set to get all. Note: adding ! before breed to exclude breeds was removed when updated plugin to support Petfinder API v2.0 in plugin version 1.0.13. age – Accepts values of: baby, young, adult, or senior. Can separate with commas to display pets that match more than one age group. If not set, will display pets from all age groups. Example: [shelter_list breed=”Italian Greyhound”] – other breeds are not matched count – The maximum number of pets to return. Defaults to 75 and must be a number. Petfinder API v2.0 added ability to filter before retrieving results so you can set the count to the real number you want to list on the page now. Max returned is 100. page – Which page of pets to return. If you have over 100 pets, or want to break up your pets into multiple pages, you can put the shortcode on multiple pages, each with a different page number. You’ll need to add a link to each page somewhere so your users can navigate between pages. Only works with API v2.0. Don’t set ‘sort’ parameter when using page. Sorting only sorts the pets on the page, and not all pets. Petfinder does not provide a way to sort all by name and then return with paging. It can only sort by recent and distance in the initial call. I sort by name after the results are returned. Example: [shelter_list count=20 page=1] and on another page [shelter_list count=20 page=2] – would list the first 20 pets on page with first shortcode, and the 2nd 20 pets on page with second shortcode. 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 – For Petfinder API v1.0 ONLY: 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. Does not work with plugin after version 1.0.13 when updated to support Petfinder API v2.0. status – Values can be: A=adoptable, H=hold, P=pending, X=adopted/removed. For Petfinder API v2.0 ONLY (when Petfinder API Key and Secret v2.0 are set): New status of ‘found’ was added. A, H, P = adoptable. X = adopted. (H=hold and P=pending were removed as options. Use v1.0 values: A,H,P,X for backwards compatibility, and can add ‘found’ if using v2.0. sort_by – Value can be: newest, last_updated or name. Value can also be set globally in Petfinder Settings. petfinder_down_message – For Petfinder API v1.0 ONLY: 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” status=”A” sort_by=”newest” petfinder_down_message=”Please check on Petfinder” 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: https://www.petfinder.com/dog/nanook-45732995/mo/kansas-city/missouri-kansas-ig-rescue-mo306/?referrer_id=cca97ef9-e23d-4d0b-b29d-52afa8f7d70e – 45732995 is the pet id. css_class – Set your own class name on div containing single pet. 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. Featured Pet Widget Settings: Featured Pet ID – You can get this id from the pet’s Petfinder URL. URL will look like the following: https://www.petfinder.com/dog/nanook-45732995/mo/kansas-city/missouri-kansas-ig-rescue-mo306/?referrer_id=cca97ef9-e23d-4d0b-b29d-52afa8f7d70e – 45732995 is the pet id. 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 – For Petfinder API v1.0 ONLY: 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). Petfinder API v2.0 can use -1 for none. Otherwise description excerpt will display that is returned from the Petfinder API. The Petfinder API no longer returns the full pet description. 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. Filters Need to change your pets’ description? Perhaps you want to remove/replace special characters that are not displaying correctly, or want to add a paragraph to the end of all pets’ descriptions? You can do so with the following filter. Add it to your functions.php file. The filter name is petf_replace_description and it acts on all pets’ descriptions. function replace_pet_description( $description ) { return $description . ” Add me to end of all pets’ descriptions”; } add_filter( ‘petf_replace_description’, ‘replace_pet_description’ );