Search Knowledge Base by Keyword

You are here:
Print

RentPress Shortcodes

Table of Contents

Overview

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


Floorplan Grid

[floorplan_grid]

  • Use: the [floorplan_grid] shortcode can be used to show a property’s floor plans in a sortable grid on any page on your website
  • Attributes:
    • property_code
      • This parameter is required to show data. If you do not enter a property code, you will not see floor plans.
      • Enter one property code to show floor plans for that property.
      • This shortcode works best when used on a page the shows content full-width.
      • Use the RentPress options to configure floor plan availability, visibility, lookahead, pricing display.
      • Default = false
      • Example: [floorplan_grid property_code="p0132261"]
    • link
      • This parameter is optional, and can be used to set the link target for floor plans
      • Options include “popup” and “post”
        • “popup” will open a modal with the floor plan’s information on the same page as the grid
        • “post” will direct visitors to the floor plan’s post page
      • Default = popup
      • Example: [floorplan_grid property_code="p0132261" link="post"]
    • gravity_form_id
      • If you have the Gravity Forms plugin installed, you can use this parameter to show a form in a modal on the same page.
      • Without this parameter, the Request More Info button will link to “/contact/” on your website.
      • When using this parameter, you must enter one form ID for the form you would like to show.
      • Default = false
      • Example: [floorplan_grid property_code="p0132261" gravity_form_id=1]

Featured Floor Plan

[featured_floor_plan]

  • Use: the [featured_floor_plan] shortcode can be used to showcase a single floor plan on any page on your site.
  • Attributes:
    • floor_plan_code
      • This parameter is required to show data. If you do not enter a floor plan code, you will not see a floor plan.
      • Enter one floor plan code to show pricing and availability for that floor plan.
      • Default = false
      • Example: [featured_floor_plan floor_plan_code=887992]
    • link_to_availability
      • This parameter can be used to change the destination for the main CTA button included with the floor plan.
      • When this parameter is not used (false), the CTA will link to the floor plan’s post page (/floorplans/the-floorplan-name/).
      • This parameter will only accept true or false.
        • Setting this parameter to true, will change the destination for the floor plan’s CTA to pull from the floor plan’s Availability URL on the floor plan’s post.
      • Default = false
      • Example:[featured_floor_plan floor_plan_code=887992 link_to_availability=true]

 


Property Grid

[property_grid]

  • Use: The [property_grid] shortcode is a powerful and flexible tool to display the properties on your site with granular control.
  • When used without any attributes, this shortcode will display properties with search and filter controls. Parameters can be used to show a refine your list of properties. All parameters are optional, support one attribute, and can be combined with other parameters. Only properties that are Published will be shown.
  • Since RentPress can dynamically update your data, these shortcodes, once set, will update over time.
  • Parameters:
    • min_beds
      • Enter a number here to set the minimum size floor plans a property has.
      • Example: [property_grid min_beds="2"]
        • Will show all properties that have floor plans with 2 or more bedrooms.
    • max_beds
      • Enter a number here to set the maximum size floor plans a property has.
      • Example: [property_grid max_beds="3"]
        • Will show all properties that have floor plans with 3 or fewer bedrooms.
    • min_rent
      • Enter a number here to set a minimum rent a unit must have.
      • Example: [property_grid min_rent="500"]
        • Will show all properties that have floor plans that are 500/month or more
    • max_rent
      • Enter a number here to set the maximum rent a unit can have.
      • Example: [property_grid max_rent="2000"]
        • Will show all properties that have floor plans that are 2000/month or less
    • city
      • Enter a the name of city to show properties in that city. The title of the city term must be entered in full inside quotation marks. This can be found in the Cities taxonomy of properties.
      • Example: [property_grid city="st. louis"]
        • Will show all properties in St. Louis
    • pets
      • Enter a name of a pet policy from the Properties > Pets taxonomy.
      • Will also accept “true” to show properties with any pet policy assigned.
      • Example: [property_grid pets="dog friendly"]
        • Will show all properties that are assigned to the “Dog Friendly” pets policy.
    • has_special
      • Enter a “true” here to display only properties that are currently running a special.
      • Example: [property_grid has_special="true"]
        • Will show all properties that have a current special.
    • hide_filters
      • Enter a “true” here to hide the search and filter UI from your property grid.
      • Example: [property_grid hide_filters="true"]
        • Will show all properties and will not show the search filters.
    • load_limit
      • Enter a number here to set a maximum number of properties on load. If more properties match your parameters, a “Show More” button will be shown.
      • Example: [property_grid load_limit="3"]
        • Will display up to 3 properties before the Show More button shows.
  • Parameters can be combined to create hyper-targeted lists of properties to put on any page of your site.
    • Example: [property_grid city="seattle" min_beds="3"]
      • Will show all properties 3-bed or larger floor plans in Seattle.
    • Example: [property_grid pets="true" has_special="true"]
      • Will show all pet-friendly properties that have a current special.
    • Example: [property_grid max_rent="1000" city="columbus"]
      • Will show all properties in Columbus under 1000/month.

Office Hours

[property_hours]

  • Use: the [property_hours] shortcode will display office hours from a property. Results will vary depending on how the hours are synced from your property’s import source.
  • Attributes:
    • property_code
      • This parameter is required to show data. If you do not enter a property code, you will not see any results.
      • Enter one valid property code to show its office hours.
        • Example: [property_hours property_code="123456"]
  • Screenshots:


Phone Number

[property_phone]

  • Use: the [property_phone] shortcode can be used to display the phone number for a given property.
  • By default, the property phone number synced or entered in the Property – General Information fields will be used. If a number is entered in the Tracking Phone Number field however, that number will display instead.
  • Attributes:
    • property_code
      • This parameter is required to show data. If you do not enter a property code, you will not see any results.
      • Enter one valid property code to show its phone number.
        • Example: [property_number property_code="123456"]
    • number_is_link
      • This parameter is not required. The phone number will display as a link by default.
        • Default = true
      • Set to “false” if you do not want the phone number linked.
      • This parameter will only accept true or false.
      • Example: [property_number property_code="123456" number_is_link="false"]
    • show_phone_icon
      • This parameter is not required. The phone icon will be shown by default.
        • Default = true
      • Set to “false” if you do not want to see phone icon.
      • This parameter will only accept true or false.
      • Example: [property_address property_code="123456" show_phone_icon="false"]
  • Screenshot:


Address & Name

[property_address]

  • Use: the [property_address] shortcode can be used to display a property’s name, address and a Directions link. It can be customized with parameters.
  • The property phone address synced or entered in the Property – General Information fields will be used.
  • Attributes:
    • property_code
      • This parameter is required to show data. If you do not enter a property code, you will not see any results.
      • Enter one valid property code to show its address.
        • Example: [property_address property_code="123456"]
    • show_property_name
      • This parameter is not required. The property’s name will be shown by default.
        • Default = true
      • Set to “false” if you do not want to see the property name.
      • This parameter will only accept true or false.
      • Example: [property_address property_code="123456" show_property_name="false"]
    • show_map_link
      • This parameter is not required. The Directions link will be shown by default.
        • Default = true
      • Set to “false” if you do not want to see the Directions link.
      • This parameter will only accept true or false.
      • Example: [property_address property_code="123456" show_map_link="false"]
    • show_map_icon
      • This parameter is not required. The map icon will be shown by default.
        • Default = true
      • Set to “false” if you do not want to see map icon.
      • This parameter will only accept true or false.
      • Example: [property_address property_code="123456" show_map_icon="false"]
  • Screenshot:


Social Networks

[property_socials]

  • Use: the [property_socials] shortcode can be used to display links to a property’s pages on social networks.
  • Links must be entered in the Property – Social Media fields on the property editor.
  • Links will always open in a new tab or window.
  • Attributes:
    • property_code
      • This parameter is required to show data. If you do not enter a property code, you will not see results.
      • Enter one valid property code to show links for that property’s social network links.
      • Example: [property_socials property_code="123456"]
  • Screenshot:

    • show_names
      • This parameter can be used to show the names of each social network next to its icon.
      • This parameter will only accept true or false.
      • Default = false
      • Example: [property_socials property_code="123456" show_names="true"]

Nearby Properties

[property_nearby]

  • Use: the [property_nearby] shortcode to display properties in the same city as a given property. You can also choose to set a minimum number of properties required.
  • Only published properties will be displayed.
  • The given property will not be displayed.
  • Properties will be displayed with a random sort.
  • All property information will be displayed including price, pet policy, and even active specials.
  • Attributes:
    • property_code
      • This parameter is required to show data. If you do not enter a property code, you will not see any results.
      • Enter one valid property code to show other nearby properties.
      • Example: [property_nearby property_code"123456"]
    • min_count
      • This parameter can be used to set a minimum number of properties to display.
      • This parameter is not required.
        • Default = 1
      • You can enter any number here, but make sure it makes sense for the cities on your website.
      • Example:[property_nearby property_code="123456" min_count="3"]
  • Screenshots:

Nearby Properties Shortcode


Equal Housing Logo

[equal_housing]

  • Use: the [equal_housing] shortcode can be used to display an Equal Housing logo. It defaults to a white image. By adding parameters, you can choose to display a black image and even optionally display text.
  • This shortcode works great in website footers. If your theme supports it, try adding it into a Text Widget.
  • Attributes:
    • color
      • This parameter is not required. If you desire a white image, you do not need to include the parameter
      • Default = white
      • This parameter will only accept the values “white” or “black” or the Equal Housing image will not be found.
      • Example: [equal_housing color="black"]
    • label
      • This parameter is not required. If you want to show the Equal Housing logo with no label, you do not need to include the parameter.
      • By adding a “true” value, the shortcode will display an Equal Housing logo with a label.
      • Default = false
      • Example: [equal_housing color="black" label=true]
  • Screenshots:

Equal Housing Shortcode Example Display

Equal Housing Shortcode in a Widget

 


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