[pmp-details] Reference #
The [pmp-details] shortcode displays a full profile for a single animal. Place it on your detail page — visitors reach it by clicking an animal in your search results.
[pmp-details] 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-details]
Displays the animal's profile using the default detail template configured in your admin settings.
All Parameters #
Free Parameters (All Tiers) #
| Parameter | Values | Description |
|---|---|---|
template |
Template name (e.g., adopt-default) |
Detail 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. |
title |
Text string, or empty ("") |
Control the detail page title. Omit to auto-generate based on method type. Set to a text string to display that exact text as the title. Set to an empty string (title="") to suppress the title entirely. See Title Behavior below. |
poster |
enable, disable, overlay, both |
Control the print poster feature. enable: show button, disable: hide all, overlay: show PDF icon on main image instead of button, both: show button and overlay icon. Default: disabled. Requires a poster page configured in General settings. |
Junior Parameters (Junior License or Higher) #
These parameters are silently ignored on the Basic tier.
| Parameter | Values | Description |
|---|---|---|
social |
enable, disable |
Enable social sharing buttons on the detail page. |
thumbs |
Number (e.g., 6; max 25) |
Maximum number of thumbnails to display below the main image. Shared with any video thumbnails on the same animal — the count covers both. Use 0 to suppress thumbnails entirely. |
quick_fields |
Comma-separated field names | Fields to display in the quick-view summary area. |
title_fields |
Comma-separated field names | Fields to display in the title/header area. |
stats_row |
Comma-separated field names | Fields to display in a horizontal stats bar. |
stats_full |
Comma-separated field names | Fields to display in the full statistics section. |
icon |
enable, disable |
Enable or disable icon display. |
icons |
Number | Maximum number of icons to display. |
overlay |
enable, disable |
Enable or disable photo overlays. |
overlays |
Number | Maximum number of overlays. |
overlay_filter |
Filter criteria | Filter which icons appear as overlays. |
overlay_position |
Position value | Position of overlays on the photo. |
exclude_buttons |
Comma-separated button names | Hide specific action buttons. Values: meet_greet, email, call, adoption_app, foster_app, donate, return. Also configurable per method type in admin settings (General > Display Options). Shortcode overrides admin setting. |
icon_size |
small, large, xl, or number |
Override icon display size. 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 detail page title font size. |
hover_text_meet_greet |
Text with optional {FieldName} tokens |
Custom hover text for Meet & Greet button. Supports partner-specific field interpolation (e.g., {AnimalName} for PetPoint). |
hover_text_email |
Text with optional {FieldName} tokens |
Custom hover text for Email Inquiry button. |
hover_text_call |
Text with optional {FieldName} tokens |
Custom hover text for Phone Call button. |
hover_text_adoption_app |
Text with optional {FieldName} tokens |
Custom hover text for Adoption Application button. |
hover_text_foster_app |
Text with optional {FieldName} tokens |
Custom hover text for Foster Application button. |
hover_text_donate |
Text with optional {FieldName} tokens |
Custom hover text for Donate/Sponsor button. |
hover_text_return |
Text with optional {FieldName} tokens |
Custom hover text for Return to Search button. |
hide_empty |
true, false |
Hide fields with no value. When true, empty fields are dropped from the detail layout entirely. When false (or omitted), empty fields render with the Not Defined placeholder. Overrides the per-method admin setting for the specific shortcode instance. |
Title Behavior #
The title parameter controls the detail page heading (<h1 class="pmp-details-title">). It accepts three forms:
| Usage | Behavior |
|---|---|
| Omitted | Auto-generated based on method type (see below). |
title="Help Us Find Buddy" |
Displays the exact text you provide as the title. |
title="" |
Suppresses the title entirely — no heading is rendered. |
Auto-Generated Title Formats #
When the title parameter is omitted, the plugin builds a title based on the method type. Each format has a fallback chain for missing data:
| Method | Primary Format | Fallback (No Name) | Final Fallback |
|---|---|---|---|
| Adopt | Get to Know {Name} the {Species} | Meet This {Species} | Meet This Pet |
| Lost | {Name} Lost in {Location} | {Sex} {Species} Lost in {Location} | Animal Lost |
| Found | {Sex} {Species} Found in {Location} | {Species} Found in {Location} | Animal Found |
Location handling: The in {Location} suffix is only appended when the plugin can resolve a location value. If no location data is available, the suffix is dropped entirely — titles never display “in Not Defined”.
Lost title format: Lost titles use a name-first format across all integration partners. When the animal has a known name (e.g., “Blackie”), the title leads with it: Blackie Lost in Eugene. This is more actionable on a lost-pet flyer than a species-first format. When no name is available, the title falls back to sex and species: Male Dog Lost in Eugene.
Found title format: Found titles always lead with sex and species because found animals rarely have a known name. Using a name would imply a known owner, which defeats the purpose of a found-pet notice.
Button Labels for Nameless Animals #
When an animal has no real name — the name field is empty or contains only a numeric shelter ID — button labels and the description heading fall back to shorter forms:
| Button | With Name | Without Name |
|---|---|---|
| Print Poster | Print Blackie's Poster | Print Poster |
| Call Us | Call Us About Blackie | Call Us |
| Meet & Greet | Meet & Greet Blackie | Meet & Greet |
| Email Us | Email Us About Blackie | Email Us |
| Sponsor | Sponsor Blackie's Care | Sponsor Their Care |
| Description heading | About Blackie | About This Dog |
Hide Empty Field Behavior #
The hide_empty parameter controls how empty (null, blank, or unknown) field values are displayed on the detail page:
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 entirely, tightening the detail layout.
The setting applies to every detail zone on the page: the main details list, quick_fields, title_fields, stats_row, stats_full, and the description section. On related-animal grids (templates ending in -similar), the related grid inherits the detail page's setting.
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.
Poster templates exempt the header and footer zones (heading, photo, QR code, call-to-action) from the toggle so flyers always print a complete layout. Only the poster body field loop honors the setting.
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 #
Like the search shortcode, the template parameter displays a clear upgrade message rather than being silently removed if your license tier doesn't support the selected template.
Examples #
Basic detail page:
[pmp-details]
Detail page with specific fields:
[pmp-details details="Name,Breed,Sex,Age,Description,Photo"]
Detail page with thumbnails and poster:
[pmp-details thumbs="6" poster="enable"]
Detail page with social sharing (Junior+):
[pmp-details social="enable" thumbs="6"]
Detail page with quick fields and stats (Junior+):
[pmp-details quick_fields="Breed,Sex,Age" stats_row="Weight,Color" thumbs="6"]
Detail page with icons and overlays (Junior+):
[pmp-details icon="enable" icons="5" overlay="enable" overlays="3"]
Hide specific buttons (Junior+):
[pmp-details exclude_buttons="call,foster_app"]
Hide all conversion buttons (Junior+):
[pmp-details exclude_buttons="meet_greet,email,call"]
Full-featured detail page (Junior+):
[pmp-details thumbs="6" social="enable" quick_fields="Breed,Sex,Age" stats_row="Weight,Color,Size" icon="enable" overlay="enable" poster="enable"]
Custom icon size (Junior+):
[pmp-details icon="enable" icon_size="large"]
Custom title size (Junior+):
[pmp-details title_size="xl"]
Custom button hover text with field interpolation (Junior+):
[pmp-details hover_text_email="Ask about {AnimalName} today!" hover_text_adoption_app="Apply to adopt {AnimalName}"]
Detail page with empty fields hidden (Junior+):
[pmp-details hide_empty="true"]
Detail page overriding admin setting to always show empty fields (Junior+):
[pmp-details hide_empty="false"]
Custom title text:
[pmp-details title="Help Us Find Buddy"]
Suppress title entirely:
[pmp-details title=""]
Admin Setting Fallbacks #
Several parameters can also be configured in admin settings as defaults. The shortcode parameter always takes priority:
| Feature | Admin Location | Shortcode Override |
|---|---|---|
| Exclude Buttons | General > Display Options (per method type) | exclude_buttons |
| Icon Sizes | General > Display Options | icon_size |
| Font Sizes | Fonts tab | title_size |
| Button Hover Text | General > Display Options (per button per method type) | hover_text_{button} |
| Hide Empty Fields | General > Display Options (per method type) | hide_empty |
Next Steps #
- [pmp-detail] Reference — Display a single field value
- Detail Templates Gallery — Browse available detail templates
- Common Shortcode Recipes — Copy-paste examples