Getting Started with the Plugin

The SimplyRETS plugin makes it easy and intuitive to show your listings on your site in a way that you want. There’s virtually no restrictions to how you can customize the plugin and your site.

The plugin is based around shortcodes; there are shortcodes for listings, search forms, sliders, and more. Each of these shortcodes takes attributes that refine which listings are pulled. For example:

To show all listings from your MLS:

[sr_listings]

but to only show listings from a specific agent:

[sr_listings agent="AGENTID"]

..see all available filters here.

CONTENTS

SHORTCODES

Most of the plugin is built around using shortcodes. This allows the most flexibility for customizing your own layout and search pages.

[sr_listings]

This is the main shortcode for showing listings on any page of your site. Put this shortcode onto any page and, voila, you’ve got listings!

This shortcode takes many different filters, and you can combine almost any of them.

If you want to use the listings shortcode, but only show listings above $500,000 then you would simply add the minprice attribute:

[sr_listings minprice="500000"]

So how about the same minimum price, but only for one specific agent? Easy!

[sr_listings minprice="500000" agent="ID"]

(Note: the ID is provided by your MLS)

[sr_search_form]

Next up is the search form shortcode. This is what ties together the ability to search and view listings.

This shortcode also takes a few different attributes, but not quite as many as the listings shortcode because the user will change them.

For example, you can set up a search form that will only search form that will always search one specific office or brokerage:

[sr_search_form brokers="ID"]

(Note: the ID is provided by your MLS)

You can also set the search form to search pre-designated property types (like Residential and Condominium). To do so, use the type attribute within the sr_search_form short-code:

This will default to search Rentals only:
[sr_search_form type=”Rental”]

This will default to search Commercial and Land only:
[sr_search_form type=”Land; Commercial”]

There are several use-cases for the search form and you can put it anywhere on your site you want! The two most common ways to use the search form are:

  1. On the landing area of your homepage, to get the visitor to start a search immediately.
  2. To be used in combination with the listings shortcode, like so:
    [sr_search_form]
    [sr_listings]

This builds a nice page with an initial set of listings, which promotes the visitor to continue making a search.

[sr_listings_slider]

The listing slider is a great feature that allows you to build a ‘slider’ of listings. See screenshot #7 for a quick glance of how it works.

Note: Some attributes (listed below) can take multiple values. sr_listings_slider currently only supports one value per attribute. For example, [sr_listings_slider postalCodes=”123456″] is supported, but [sr_listings_slider postalCodes=”12345; 34567″] is not.

Attributes

  • random
    Show the listings in a random order whenever the page is loaded.
    [sr_listings_slider random=”true”]

The slider shortcode takes all the same attributes as the listings shortcode, which is all of them. So to make a slider with listings over $500,000:

[sr_listings_slider minprice="500000"]

And the same minimum price, but only for one specific agent? Easy!

[sr_listings_slider minprice="500000" agent="ID"]

(Note: the Agent ID is provided by your MLS)

The SimplyRETS plugin also provides a second kind of map based search that allows the user to search by drawing polygons over and area and setting their parameters.

The short-code can be used with:

[sr_map_search]

Attributes

  • search_form

Show search form in addition to the map.

[sr_map_search search_form="true"]
  • list_view

Show a list view of search results below the map

[sr_map_search list_view="true"]

There are five possible values for the show_map parameter:

  • false  (don’t show the map)
  • map_only (only show the map)
  • list_only (only show the list / same as false)
  • map_above (show the map above the list view / this is the default)
  • map_below (show the map below the list view)

(Note: Maps can only be enabled when latitude and longitude are available for the listings. Some MLS’s do not provide this, in which case you can check out the SimplyRETS Geocoding Addon.)

AVAILABLE FILTERS

There are ton of attributes available for refining the listings in any way you can imagine. Each of these attributes can be used in any of the shortcodes, and you can use (most of) them in combination with each other like the examples above:

  • mlsid
    Fetches a single listing by it’s mlsid.
    [sr_listings mlsid=”12345″]
  • status
    Refines listings by a certain status, like Active, Pending, or Closed. (Separate multiple with a semicolon ‘;’)
    [sr_listings status=”Closed”]
    [sr_listings status=”Active; Pending”]

Note: By default, Active and Pending are queried

  • minprice
    Refines listings to a minimum price.
    [sr_listings minprice=”500000″]
  • maxprice
    Refines listings to a maximum price.
    [sr_listings maxprice=”1000000″]
  • minbeds
    Set a minimum amount of bedrooms.
    [sr_listings minbeds=”3″]
  • maxbeds
    Set a maximum amount of bedrooms.
    [sr_listings maxbeds=”3″]
  • minbaths
    Set a minimum amount of baths.
    [sr_listings minbaths=”3″]
  • maxbaths
    Set a maximum amount of baths.
    [sr_listings maxbaths=”3″]
  • q
    A fuzzy keyword search that will include listings matching a given string.
    [sr_listings q=”great view”]
  • type
    Refines listings by a certain type, like Residential, Condo, Rental.
    [sr_listings type=”Rental”]
  • agent
    Refines listings to a specific agent by taking an agent’s MLS ID.
    [sr_listings agent=”JDOE12″]
  • brokers
    Refines listings to a specific brokerage by taking a brokerage’s MLS ID.
    [sr_listings brokers=”KWREALTY1″]
  • cities
    Refines listings to a given set of cities. (Separate multiple with a semi-colon).
    [sr_listings cities=”Houston; Austin; Dallas”]
  • neighborhoods
    Refines listings to a given set of neighborhoods/subdivisions. (Separate multiple with a semi-colon).
    [sr_listings neighborhoods=”Heights; Downtown; Uptown”]
  • postalcodes
    Refines listings to a given set of postal codes. (Separate multiple with a semi-colon).
    [sr_listings postalcodes=”12345; 34567″]
  • counties
    Refines listings to a given set of counties. (Separate multiple with a semi-colon).
    [sr_listings counties=”Harris; Travis”]
  • amenities
    Refines listings to a given set of amenities. (Separate multiple with a semi-colon).
    [sr_listings amenities=”Granite; Balcony”]
  • features
    Refines listings to a given set of features. (Separate multiple with a semi-colon).
    [sr_listings features=”Tennis Court; Waterfront”]
  • water
    Refines listings to only ones that have a value for the ‘water’ field. true is the only valid value:
    [sr_listings water=”true”]

Note: This is only available for feeds that have a value for ‘water’.

  • vendor
    Refines listings by a certain vendor or MLS Board. (This is required when your account has multiple MLS’s).
    [sr_listings vendor=”MFRMLS”]
  • limit
    The amount of listings to return. Default is 20, maximum is 50.
    [sr_listings limit=”50″]
  • offset
    Returns a set of listings and skips the first n, where n is the offset.
    [sr_listings offset=”20″]
  • sort
    Displays the listings in a specific order.
    [sr_listings sort=”listprice”]

(The available sort options are listprice-listpricelistdate-listdatebaths-bathsbeds, and -beds. Options starting the a minus (-) are high to low, no minus sign is low to high).

  • most recently updated

By default, the listings returned from the API are actually sorted on the “.modified” timestamp, so you are always getting the most recently modified listings first. The only time the listings will not be sorted that way is if you are using another sort parameter, or the “lastId” parameter.

  • advanced
    This attribute is to turn the basic search form into an advanced search form.
    [sr_search_form advanced=”true”]

 

SIMPLYRETS WIDGETS

The SimplyRETS plugin comes with several widgets you can use in you sidebar and footer. The currently available widgets include:

  • Search Form Widget
    The search form widget allows you to add an MLS search in the sidebar or footer of your site.
  • Featured Listing Widget
    This takes one listing MLS id, and will embed the property in a widget with a link to the details page of that property
  • Random Listing Widget
    This is similar to the Featured Listing Widget, but takes multiple MLS Id’s. On each page load, it will show one of the listings provided.
  • Agents Listing Widget
    The search form widget allows you to add an MLS search in the sidebar or footer of your site.

GLOBAL SETTINGS

This sections will discuss some of the basic configuration options available to admin’s through the plugin:

ACCOUNT CREDENTIALS

The account credentials section in the admin settings is where you’ll enter your API Credentials for your SimplyRETS app. If you don’t yet have a SimplyRETS app, the default demo credentials will be available.

SINGLE LISTING PAGE SETTINGS

These settings allow you to control various parts of the listing details pages, including the contact form and some of the fields that are shown.

CONTACT FORM LEAD CAPTURE

When this is enabled, a lead capture contact form will be shown at the bottom of listing details pages. In the Send lead capture form submissions to input, you can enter the email address where you’d like to receive lead emails.

Note: The WordPress admin email is used if no email is provided

SHOW/HIDE LISTING INFORMATION

Show and/or hide various parts of the listing details page:

  • Hide ‘Listing meta information’ fields from property details? This option hides listDatemodificationTimestamptaxYear, and taxAmmount from listing details pages.
  • Do not show Agent/Office phone number and email address If checked, the listing office and agent’s contact information will not be shown. Note that, in most cases, the name will still be shown.
  • Hide ‘Listing Remarks’ (description) field from property details? If checked, the listing description will not be displayed. Show additional room details? If available, extra information about the listing’s rooms will be shown when this is enabled.
  • Show MLS status text if available (hide standardized status)? If a statusText is available for the listing, show that instead of the standardized status. Read more about statusText here.

IMAGE GALLERY SETTINGS

There are two types of image galleries available for listing details pages: fancy and classic. Here, you can choose which one you’d like to use.

PERMALINKS

SimplyRETS has support for ‘pretty’ and ‘ugly’ permalinks. It will choose the best one based on your current configuration and there are a couple of options to fine-tune it.

  • If your WordPress site uses ‘default’ (ugly) permalinks, the plugin is forced to use those as well.
  • If your WordPress site is using ‘pretty’ permalinks, you can choose between ‘pretty’ and ‘extra pretty’ SimplyRETS links in the “Permalnks” section of the admin panel. Here are some basic examples:

Pretty: http://yoursite.com/listings/{id}/{streetAddress}
Extra Pretty: http://yoursite.com/listings/{city}/{state}/{postalCode}/{streetAddress}/{id}

MLS COMPLIANCE SETTINGS

In some cases, you may need to show additional disclaimers and information for broker reciprocity. The SimplyRETS WordPress plugin has some options you can use to make this easier.

SHOW BROKERAGE NAME

In the SimplyRETS Settings page of your WordPress dashboard you will find a setting called “Show brokerage name”. With this enabled, the name of the listing brokerage will be shown next to all thumbnail and summary sections, as well as on listing details pages.

SHOW IDX IMAGE/LOGO

This option allows you to add a URL for an image that will be shown with all listing summaries. For example, a broker reciprocity image can be added, and anywhere a listing summary is shown that image will be shown as well.

CUSTOM DISCLAIMER

If you need to add a custom disclaimer to your website, the SimplyRETS plugin offers a way for you to do so. On the Settings -> SimplyRETS Settings page there is an option called “Custom disclaimer”. In this box, you can paste the text or HTML for your own disclaimer. A few notes:

  • Use the {lastUpdate} variable to splice in a timestamp for the
    last time the listings were updated.
  • You can use HTML or plain text.
  • Disclaimers will be shown at the bottom of the output for every short-code.

DEMO DATA

You can use the Trial Listings as much as you need before you set up your own. They only contain a subset of the options that are available from most MLS’s, but there is plenty to work with! Here’s how to get hem set up:

  • Navigate to the SimplyRETS Settings page in your WordPress dashboard Settings -> SimplyRETS
  • Insert the testing API Keys (Username: simplyrets Password: simplyrets)

The trial listings are activated automatically – so if you’re installing the plugin for the first time, you don’t need to do the above steps.

SIMPLYRETS PAGES

Note: SimplyRETS pages are no longer the recommended way of creating listing pages. Instead, we recommend creating a regular WordPress Page and using the short-codes directly.

SimplyRETS pages allow for an easy way to get up and running with new pages. Here’s a few tips:

  • To create a new page, navigate to SimplyRETS -> Add New Page in your WordPress dashboard. (by default these pages will show all of your listings – 25 per page). Name it, publish it, and you’re done!
  • You can add filters to this page by editing the post and using the Filter Results on this Page options.
  • You can add filters for price, agent, min/max bed, min/max bath and more.
  • SimplyRETS Pages give you the ability to choose from your theme’s available templates.

Note: it is usually recommended to use the shortcodes directly since they give you much more control and options, however if you’re a theme developer then customizing the SimplyRETS pages may be the best option.

CUSTOMIZING THE STYLES AND CSS

We’re are totally OK with you tweaking the CSS and changing it to fit your needs. As a matter of fact, we want you to!

If you need to add any custom styling you can add custom CSS using our Style Guide. The Style Guide will show you which classes and id’s to use to when adding your own css. You can find it here: SimplyRETS Style Guide

SUPPORT, CONTRIBUTING, AND MORE INFORMATION

We want to hear from you! Whether you’re an agent or developer, need help getting set up, or want to contribute some code – come one come all.

FEATURE REQUEST?

If you have a suggestion for a new feature to add to the plugin, let us know! We’re always looking to expand our plugin to give you what you need to make the best possible site. Email support@simplyrets.com if you have an idea, we’d love to hear it!

FOR DEVELOPERS

If you’re interested in building your own Plugin or Application, SimplyRETS offers several different API’s specifically geared towards developers. We provide a JSON API’s to access the same data you see in this plugin, as well as other services like Database population and analytics, and geocoding. The API’s are simple, and the documentation is robust. Try it out and let us know what you think. Visit the SimplyRETS website for more details and a full list of services: SimplyRETS Features.

There is more documentation for both the SimplyRETS API, and the SimplyRETS WordPress plugin. You can dig into all of that on the SimplyRETS Docs website: SimplyRETS Documentation.

Close Menu