Select Page

Search Knowledge Base by Keyword

RentPress Shortcodes

You are here:
Table of Contents

Overview

RentPress includes shortcodes for [floorplan_grid], [featured_floor_plan], and [property_grid] each with their own 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]
    • 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.

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