[pmp-search] Reference #
The [pmp-search] shortcode displays animal search results on your WordPress page. This is the complete reference for all available parameters.
[pmp-search] string from the Shortcode Builder tab in the PetMatchPro admin. The builder shows only parameters valid for your partner, method, and license tier.Basic Usage #
[pmp-search]Displays all adoptable animals using the default search template configured in your admin settings.
All Parameters #
Free Parameters (All Tiers) #
These parameters are available on every license tier.
| Parameter | Values | Description |
|---|---|---|
type |
adopt, lost, found, list, featured, preferred |
Search method type. Defaults to adopt. Lost/found/list/featured/preferred require appropriate license and partner. |
template |
Template name (e.g., adopt-search-default) |
Search template to use. Non-default templates require Junior+. Shows upgrade message if tier is insufficient. |
details |
Comma-separated field names | Which animal fields to display (e.g., Name,Breed,Sex,Age). |
filter |
enable, disable |
Enable or disable search filter widgets. |
species |
Species name (e.g., Dog, Cat) |
Filter results to a specific species. |
poster |
enable, disable |
Enable or disable the print poster button. |
Junior Parameters (Junior License or Higher) #
These parameters are silently ignored on the Basic tier.
| Parameter | Values | Description |
|---|---|---|
subtitle |
Text string | Subtitle text displayed below the search heading. |
banner |
Text string | Banner text displayed in the search results area. |
row |
Number | Number of results to display per row. |
rows |
Number | Number of rows to display. |
pagination |
enable, disable |
Enable pagination for search results. |
count |
Number | Maximum number of results to display. |
labels |
enable, disable |
Show or hide field labels in search results. |
separator |
Character(s) | Separator character between fields in search results. |
client |
Client identifier | Client-specific display options. |
button_consistency |
enable, disable |
Style filter dropdowns to match sort buttons. Requires client="enable". |
exclude |
Comma-separated values | Exclude specific animals or values from results. |
icon |
enable, disable |
Enable or disable icon display. |
icons |
Number | Maximum number of icons to display per animal. |
overlay |
enable, disable |
Enable or disable photo overlays. |
overlays |
Number | Maximum number of overlays per photo. |
overlay_filter |
Filter criteria | Filter which icons appear as overlays. |
overlay_position |
Position value | Position of overlays on the photo (e.g., corner placement). |
hide_empty |
true, false |
Hide fields with no value. When true, empty fields are dropped from the card entirely. When false (or omitted), empty fields render with the Not Defined placeholder. Overrides the per-method admin setting for the specific shortcode instance. |
icon_size |
small, large, xl, or number |
Override icon display size on search cards. Named presets or a numeric pixel value (e.g., icon_size="32"). Also configurable in admin settings (General > Display Options). |
title_size |
small, large, xl |
Override the search results title font size. |
subtitle_size |
small, large, xl |
Override the search subtitle font size. |
banner_size |
small, large, xl |
Override the search banner font size. |
card_hover_text |
Any text, with optional {FieldName} tokens |
Override the hover/tooltip text on the card name link, photo link, and image. Defaults vary by method type (e.g., “Have You Seen {Name}?” for lost). See Search Card Hover Text. |
Hide Empty Field Behavior #
The hide_empty parameter controls how empty (null, blank, or unknown) field values are displayed in search results:
hide_empty="false"– Empty fields render with the Not Defined placeholder. This matches the default behavior of prior releases.hide_empty="true"– Empty fields are dropped from each card, tightening the layout.
For numeric fields where 0 is a data-entry placeholder rather than a real value (currently weight on PetPoint and AnimalsFirst), a zero value is also treated as empty. Currency fields such as fee and adoptionfee are exempt – a $0 adoption fee is a legitimate display.
There is also a per-method admin checkbox on the General > Display Options tab that sets the default for every page rendering that method type. The shortcode hide_empty parameter overrides the admin checkbox for the specific shortcode instance.
Template Parameter Behavior #
The template parameter works differently from other paid parameters. Instead of being silently removed on lower tiers, it displays a clear upgrade message explaining which license is needed.
Examples #
Basic adoption search:
[pmp-search type="adopt"]Search with custom fields:
[pmp-search type="adopt" details="Name,Breed,Sex,Age"]Filtered search (dogs only):
[pmp-search type="adopt" species="Dog"]Search with filters enabled:
[pmp-search type="adopt" filter="enable"]Search with pagination and row layout (Junior+):
[pmp-search type="adopt" pagination="enable" row="3" rows="4"]Search with overlays and icons (Junior+):
[pmp-search type="adopt" overlay="enable" overlays="3" icon="enable" icons="5"]Lost animal search (Junior+):
[pmp-search type="lost"]Search with exclusions (Junior+):
[pmp-search type="adopt" exclude="Hamster,Guinea Pig"]Search with empty fields hidden (Junior+):
[pmp-search type="adopt" hide_empty="true"]Search overriding admin setting to always show empty fields (Junior+):
[pmp-search type="adopt" hide_empty="false"]Next Steps #
- [pmp-details] Reference – Detail page shortcode reference
- Parameters by License Tier – See all parameters organized by tier
- Common Shortcode Recipes – Copy-paste examples
