Shortcodes

OwnerRez has a native WordPress plugin to help you integrate your WordPress website with your OwnerRez data. By combining this plugin with our Widgets you can build unique and powerful direct booking websites for your rental properties all from within WordPress, while integrating OwnerRez properties, rates and rules data.

After setting up and configuring the WordPress plugin, you will use "shortcodes" to generate native content on your WordPress pages. In WordPress, shortcodes are part of the normal WordPress ecosystem and well-known among WordPress developers. Think of a shortcode as a shortcut to add features to your website that would normally require lots of complicated computer code and technical ability.

A shortcode is written inside two square brackets like "[this]" with extra information inside the brackets to describe what you want. All OwnerRez shortcodes start with "ownerrez" and require a type parameter. Some type values may additionally require other parameters such as id or field to further control what is rendered to your page.

The following is an example shortcode:

[ownerrez type="property" id="orp12345" field="name"]

When the page is displayed to the end user, the shortcode will be converted on the fly to show the user what you want to show them. There are two types of things that are shown - fields and widgets.

Fields are exactly what they sound like - pieces of data about your property like the name, headline, description and so on.

Widgets are areas of interactive content on the page that the user will use to look at photos, get quotes, see calendars and so on. The "Book Now" box is an example of a widget.

• Fields
• Widgets

Fields

This is a current list of supported values for type for rendering specific details from your OwnerRez properties:

• property : Render property details for a single property.
  Parameters:
  • id (required) : The property ID
  • field (required, unless json is set to true) : The details you would like to render
    • Common values include: name, externalName, maxGuests, maxPets, minNights, maxNights, checkIn, checkOut
    • For a complete list of available fields, see the JSON Response Format on the API endpoint.
  • json (optional) : If true is used, field is not required, and the entire set of available property details will be rendered as a JSON object.
• listing : Render listing details for a single property.
  Parameters:
  • id (required) : The property ID
  • field (required, unless json is set to true) : The details you would like to render
    • Common values include: description, shortDescription, headline, latitude, longitude, bedroomCount, bathroomCount, sleepsMax, occupancyMax, nightlyRateMin, nightlyRateMax
    • For a complete list of available fields, see the JSON Response Format on the API endpoint.
  • json (optional) : If true is used, field is not required, and the entire set of available property listing details will be rendered as a JSON object.

Widgets

This is a current list of supported values for type for rendering predefined layouts for your OwnerRez properties. Widget shortcodes render lightly styled HTML. Additional styling is commonly required. Some widgets include FontAwesome icon markup for which we recommend the official FontAwesome plugin.

• widget_photo_carousel : Render a photo carousel for a single property.
  Parameters:
  • id (required) : The property ID
  
  The photo carousel supports photos including the Video Url setting on photos which allows linking Youtube or Vimeo videos -- this works the same way as adding video to your photos on OwnerRez Hosted Websites.
• widget_amenities_list : Render a bullet list of call-out amenities for a single property.
  Parameters:
  • id (required) : The property ID
• widget_amenities_table : Render a tabular list of all yes/no amenities for a single property.
  Parameters:
  • id (required) : The property ID
• widget_amenities_category : Render an unordered list for a single category of amenities for a single property.
  Parameters:
  • id (required) : The property ID
  • category (required) : The category to render
    Possible categories:
    • PropertyType, Accommodation, CheckInType, HouseRules, Bedrooms, Bathrooms, LocationTypeFeatures, PopularAmenityFeatures, KitchenFeatures, DiningFeatures, EntertainmentFeatures, PoolSpaFeatures, OutdoorFeatures, OtherServiceFeatures, ThemeFeatures, AttractionFeatures, SportFeatures, LeisureFeatures, LocalFeatures, SafetyFeatures, FamilyFeatures, ParkingFeatures, ListingExpectationFeatures, AccessibilityFeatures
• widget_listing_details : Render additional amenities information, and a tabular list of all categories available in the widget_amenities_category widget for a single property.
  Parameters:
  • id (required) : The property ID

Amenities

Here's some example CSS to break out the widget_amenities_table output into columns. You may need to tweak this to fit your site design, but this should get you started:

@import url('https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@5.15.4/css/fontawesome.min.css');

th.ownerrez-amenities-table-category-name {
    padding: 3px 5px;
}

ul.ownerrez-amenities-list {
    margin-bottom: 5px;
}

li.ownerrez-amenities-list-item {
    display: inline-block;
    width: 24%;
    min-width: 200px;
    margin-bottom: 5px;
    padding: 3px 5px;
    background-color: #efefef;
    margin-right: 5px;
}

Note that the amenity detail is rendered as a title attribute on the info icon. Browsers will show this as a tooltip if you hover over it -- but you have to hover for 5 seconds or so for most browsers to do that.

If you want to enhance the browser tooltips, you'd need to install a WordPress plugin or use javascript to find that title attribute and convert it to an instant hover display. For example: https://stevenbenner.github.io/jquery-powertip/

If you include that library you can add hover by adding this javascript to your page:

$("[title]").powerTip();