Search Knowledge Base by Keyword

You are here:
Print

RentPress Shortcodes

Table of Contents

 

Please note:

This document is for RentPress version 7 or later. If you are running version 6 and below, please reference RentPress Shortcodes (Version 6).

Overview

RentPress includes shortcodes for to display property data around your website. Each shortcode is customizable by adding parameters.

You’ll find shortcodes to display floor plans, properties, and shortcodes handy for displaying property info in a website footer or contact page.


Primary Shortcodes

The four main primary shortcodes are designed to be used in a full-page or full-width environment. Especially for the single posts, you may find it quicker to use the included templates or create a post template using these shortcodes.

Single Floor Plan

[rentpress_single_floorplan]

  • Use: displays the RentPress floor plan single template based on the floor plan code or post id you pass into it
  • You can add more data into the floor plan like photos, specials, etc via the floor plan editor.
  • Attributes: (only one of the two is required)
    • code
      • Enter one floor plan code to show that floor plan.
      • Use the RentPress Settings to configure floor plan availability, visibility, lookahead, pricing display.
      • Example: [rentpress_single_floorplan code="4257230"]
    • ID
      • Enter one floor plan post ID ↗️ to show that floor plan.
      • Example: [rentpress_single_floorplan ID="p012345" ]

RentPress single floor plan


Single Property Listing

[rentpress_single_property]

  • Use: displays the RentPress property listing template based on the property code or post id you pass into it
  • You can add more data into the property like photos, specials, etc via the property editor.
  • Attributes: 7 possible with only “code” or “ID” required.
    • code
      • Enter one property code to show that property.
      • Example: [rentpress_single_property code="p012345"]
    • ID
      • Enter one property post ID ↗️ to show that property.
      • Example: [rentpress_single_property ID="5786"]
    • default_sort
      • When not present, defaults to sorting by availability.
    • hide_neighborhood
      • The neighborhood will show by default. If this is present the shortcode won’t show the neighborhood section on the property page template.
    • neighborhood_id
      • The post id of a neighborhood you want to display on the single property template.
    • MAPBOX
      • When not present, defaults to use Google Maps. No value required, just place MAPBOX in the shortcode to use Mapbox.
    • GOOGLEMAPS
      • When not present, defaults to use Google Maps. No value required, just place GOOGLEMAPS in the shortcode.

Example: [rentpress_single_property code=pr1000 id=93 default_sort=avail hide_neighborhood=true neighborhood_id=12 MAPBOX][/rentpress_single_property]

RentPress single property


Floor Plan Search Grid

[rentpress_floorplan_search]

  • Use: displays the RentPress floor plan search template based on the floor plan codes or post ids you pass into it.
  • If no codes or id are entered it will show all floor plans.
  • Attributes: 7 possible with none required.
    • codes
      • Enter the floor plan codes of the floor plans you want to display in the search, separated by commas.
    • ID
      • Enter the floor plan post IDs ↗️ of the floor plans you want to display in the search, separated by commas.
    • property_codes
      • Enter the property code of the floor plans you want to display in the search, separated by commas.
    • property_post_ids
      • Enter the parent property post id of the floor plans you want to display in the search, separated by commas.
    • HIDEFILTERS
      • No value required and defaults to show filters. Place HIDEFILTERS in your shortcode and no filter options will be shown.
    • SIDEBARFILTERS
      • No value required and defaults to show filters on top of the search. Place SIDEBARFILTERS in your shortcode and filters will be shown on the top of the floor plans.
    • USEMODALS
      • No value required and defaults to open the single floor plan page. Place USEMODALS in your shortcode and clicking on a floor plan will open its information in a modal window.

Example: [rentpress_floorplan_search codes=pr1000,pr1001,pr1002 post_ids=12,34,73 property_post_ids=57,29,75,56 property_codes=pr2000,pr2001,pr2002 HIDEFILTERS SIDEBARFILTERS USEMODALS][/rentpress_floorplan_search]

RentPress floor plan search grid shortcode


Property Search

[rentpress_property_search]

  • Use: displays the RentPress property search template based on the property codes or post IDs you pass into it.
  • If no codes or ID are entered it will show all properties.
  • Attributes: 10 possible with none required.
    • codes
      • Enter the property codes of the properties you want to display in the search, separated by commas.
    • post_ids
      • Enter the property post IDs ↗️ of the properties you want to display in the search, separated by commas.
    • terms
      • Enter the terms that the properties must be a part of. Separate terms with “|”
    • city
      • Enter the names of cities a property must be a part of. Separate cities with “|”
    • neighborhood
      • Enter the names of neighborhoods a property must be a part of. Separate neighborhoods with “|”
    • limit
      • A maximum number of properties to show. This option will only affect the results if you have a city set.
    • HIDEFILTERS
      • No value required and defaults to show filters. Place HIDEFILTERS in your shortcode and no filter options will be shown.
    • SHOWMAP
      • No value required and defaults to show the map when present. Place SHOWMAP in your shortcode and a map will be shown.
    • pets
      • Adds the pet policies taxonomies terms to the search filters available keywords by entering pet policy terms separated by “|”
    • property_type
      • adds the Property_type taxonomies terms to the search filters available keywords by entering Property_type terms separated by “|”
    • featured_amenities
      • adds the Featured_amenities taxonomies terms to the search filters available keywords by entering Featured_amenities terms separated by “|”
    • showmatrix
      • Displays property pricing as a “matrix” of pricing by bedroom size.
    • bed
      • Shows properties that have the number of bedrooms entered.
    • max_price
      • Sets a maximum price number over which properties will not be shown.
    • only_available
      • Will display properties that only have availability currently.

Example: [rentpress_property_search codes=pr1000,pr1001,pr1002 post_ids=12,34,73 SHOWMAP][/rentpress_property_search]

Example: [rentpress_property_search showmap showmatrix onlyavailable max_price='1500' bed='2' pets='Cat|Dog|Bird' featured_amenities='Pool|Grill' property_type='Student' /]


Utility Shortcodes

The utility shortcodes are designed to help you built a website footer or contact page. You’ll can pull contact info for a property and an equal housing logo. When your property syncs, the information displayed within the shortcode will also update.

Property Hours

[rentpress_property_hours]

  • Use: displays the property’s hours based on the property code or property post ID you pass into it.
  • Attributes: 2 possible with only code or ID being required.
    • code
      • Enter one property code to show the hours for that property.
      • Example: [rentpress_property_hours code="p012345"]
    • ID
      • Enter one property post ID ↗️ to show the hours for that property.
      • Example: [rentpress_property_hours ID="5789"]


Property Address

[rentpress_property_address]

  • Use: displays the property’s address based on the property code or property post ID you pass into it.
  • Attributes: 2 possible with only code or ID being required.
    • code
      • Enter one property code to show the address for that property.
      • Example: [rentpress_property_address code="p012345"]
    • ID
      • Enter one property post ID ↗️ to show the address for that property.
      • Example: [rentpress_property_address ID="5789"]

RentPress property address shortcode


Property Phone

[rentpress_property_phone]

  • Use: displays the property’s phone based on the property code or property post ID you pass into it.
  • Attributes: 2 possible with only code or ID being required.
    • code
      • Enter one property code to show that property.
      • Example: [rentpress_property_phone code="p012345"]
    • ID
      • Enter one property post ID ↗️ to show the phone number for that property.
      • Example: [rentpress_property_phone ID="5789"]

RentPress property phone number shortcode


Property Social Links

[rentpress_property_social]

  • Use: displays the property’s social profile links as icons based on the property code or property post ID you pass into it.
  • Attributes: 2 possible with only code or ID being required.
    • code
      • Enter one property code to show that property.
      • Example: [rentpress_property_social code="p012345"]
    • ID
      • Enter one property post ID ↗️ to show the phone number for that property.
      • Example: [rentpress_property_social ID="5789"]
    • size
      • Defaults to “2em” and accepts any valid CSS unit ↗️ (px, em, %)
      • Example: [rentpress_property_social ID="5789" size="4em"]
    • color
      • Defaults to the chosen Accent Color in RentPress Settings and accepts any valid hex code ↗️.
      • Example: [rentpress_property_social ID="5789" color="3399ff"]


Equal Housing

[rentpress_equal_housing]

  • Use: displays the Equal Housing Icon
  • Example: [rentpress_equal_housing]
  • Attributes: 2 possible with none being required.
    • size
      • Defaults to “10em” and accepts any valid CSS unit ↗️ (px, em, %)
      • Example: [rentpress_equal_housing size="4em"]
    • color
      • Defaults to the chosen Accent Color in RentPress Settings and accepts any valid hex code ↗️.
      • Example: [rentpress_equal_housing color="3399ff"]


See Also

You can also choose to display your property data by using the included templates, or by writing custom templates of your own.