IDX Shortcodes

Preview

*Note: Saved Link method is only available for Equity Clients

IMPress for IDX Broker

UI is available when you edit a page/post and click Add IDX Shortcode.

Not up to date (as of 2/2018) list of some shortcodes:

Type Shortcode Settings
Omnibar Search [idx-omnibar styles=”1 or 0″ extra=”1 or 0″ min_price=”1 or 0″ ] styles, extra, min_price: these are boolean fields where 1 = true and 0 = false
System Links [idx-platinum-system-link id=”#AID#-#ID#” title=”Text For Link” ] id: aid number should be formatted like this (5839-39651) where 5839 is the AID number then the hyphen and then the link id number

title: Contained within the quotes should be the text you want the link to display as

Saved Links [idx-platinum-saved-link id=”#AID#-#ID#” title=”Text For Link” ] id: aid number should be formatted like this (5839-39651) where 5839 is the AID number then the hyphen and then the link id number

title: Contained within the quotes should be the text you want the link to display as

Widgets [idx-platinum-widget id=”#AID#-#ID#” ] id: aid number should be formatted like this (5839-39651) where 5839 is the AID number then the hyphen and then the widget id number
City Links [impress_city_links mls=”#MLSID#” city_list=”cityListName” use_columns=”1 or 0″ number_columns=”4″ styles=”1 or 0″ new_window=”1 or 0″ ] mls: this should be the IDX mls id (a002)

city_list: this should match the city list returned by the API (combinedActiveMLS)

use_columns, styles, and new_window: these are boolean fields where 1 = true and 0 = false

Showcase [impress_property_showcase property_type=”featured/soldpending/supplemental/historical/savedlinks” saved_link_id=”#ID#” show_image=”1 or 0″ use_rows=”1 or 0″ num_per_row=”4″ max=”4″ order=”high-low/low-high” styles=”1 or 0″ new_window=”1 or 0″ ] property_type: this can be featured,soldpending,supplemental,historical or savedlinks

saved_link_id: this is the idx id for the saved link (can be found by editing a saved link in the middleware)

show_image, use_rows, styles, new_window: these are boolean fields where 1 = true and 0 = false

num_per_row, max: number of max results to display per row

order: this can be high-low or low-high

Carousel [impress_property_carousel property_type=”featured/soldpending/supplemental/historical/savedlinks” saved_link_id=”#ID#” display=”3″ max=”15″ order=”high-low/low-high” autoplay=”1 or 0″ styles=”1 or 0″ new_window=”1 or 0″ ] property_type: this can be featured,soldpending,supplemental,historical or savedlinks

saved_link_id: this is the idx id for the saved link (can be found by editing a saved link in the middleware)

display, max: number of max results to display and how many should show at one time

autoplay, styles, and new_window: these are boolean fields where 1 = true and 0 = false

Lead Login [impress_lead_login styles=”1 or 0″ new_window=”1 or 0″ ] styles and new_window: these are boolean fields where 1 = true and 0 = false
Lead Signup [impress_lead_signup phone=”1 or 0″ styles=”1 or 0″ new_window=”1 or 0″ ] phone, styles and new_window: these are boolean fields where 1 = true and 0 = false
IDX Start/Stop Tags [idx-wrapper-tags] adds the start and stop tags for the dynamic wrapper system. No additional parameters.

Equity

Public Doc with more shortcodes – http://aethemes.com/shortcodes/shortcodes-content/ (more in the menu)

Type Shortcode Settings
Lead Login [lead_login] none
Lead Signup [lead_signup] Optional parameter
phone=”(bool)” – defaults to false if omitted
Property Carousel [property_carousel]

Optional parameters
max=”(int)” – max number of listings to show, defaults to 4
display=”(int)” – number of listings to display at a single time, more listings shown on scroll up to max number, defaults to 3
order=”(string)” – high-low (default) or low-high
autoplay=”(bool)” – defaults to true if omitted
property_type=”(string)” – featured (default), supplemental, soldpending, historical, or savedlink
saved_link_id=”(int)” – id number of the saved link if chosen as property_type

 

Property Showcase [property_showcase]

Optional parameters
max=”(int)” – max number of listings to show, defaults to 4
use_rows=”(bool)” – defaults to true if omitted
num_per_row=”(int)” – number of listings to show per row, defaults to 4
order=”(string)” – high-low (default) or low-high
show_image=”(bool)” – defaults to true if omitted
property_type=”(string)” – featured (default), supplemental, soldpending, historical, or savedlink
saved_link_id=”(int)” – id number of the saved link if chosen as property_type

 

City Links [city_links] Optional parameters
city_list=”(string)” – name of city list, defaults to combinedActiveMLS
mls=”(string)” – idxID (MLS ID), defaults to demo a000
use_columns=”(bool)” – defaults to true if omitted
number_columns=”(int)” – 2 to 4, defaults to 4

 

Impress Listings FAQ

Can I import listings from my MLS?

Yes. With an IDX Broker subscription and adding their IMPress for IDX Broker plugin to your site, IMPress Listings can import featured properties from the MLS.

I already use the AgentPress Listings plugin, can I use this plugin?

Yes. This plugin can be used instead of the AgentPress Listings plugin. It uses the same post type name and custom field names (along with several new fields), so the posts you’ve added using AgentPress, along with the associated meta data, will remain attached to the listing post. Just be sure to deactivate AgentPress before activating IMPress Listings.

My theme already has a single listing template. How do I use the one provided with the plugin?

Some themes may already have a single-listing.php (and archive.php for listing archives) to display listings with the same post type name of ‘listings’. Templates placed within your theme folder have precedence. To use the template(s) provided with the plugin, delete the single-listing.php and/or the archive-listing.php templates within your theme’s folder (recommended to make a backup).

How can I create a custom single listing template?

Name your template file single-listing-CUSTOM-NAME.php (replace CUSTOM NAME with your own descriptive name). You can use the single-listing.php within the plugins /includes/views/ folder for a guide on how to display the post type data. You’ll need to include the following block of text at the top of your custom template:

/*
Single Listing Template: Test Template
Description: Give it a description to help identify
*/

How can I remove the default property status terms or property type terms?

Its possible to remove the default property status terms by using a filter in your theme or custom plugins. Here is an example for the status terms:

/* Remove Default Status Terms from IMPress Listings */
add_filter( 'wp_listings_default_status_terms', 'custom_default_status_terms' );
function custom_default_status_terms() {
  $status_terms = array();
  return $status_terms;
}

 

Here is an example for the property terms:
/* Remove Default Property Terms from IMPress Listings */
add_filter( 'wp_listings_default_property_type_terms', 'custom_default_property_type_terms' );
function custom_default_property_type_terms() {
  $property_type_terms = array();
  return $property_type_terms;
}

 

IMPress Listings Shortcodes List

How to use the listings shortcode

Basic usage

Just enter the following shortcode on any post or page

[listings]

Advanced usage

The shortcode accepts the following parameters:

id

= listing post id (accepts one or more id’s), exclusive, cannot be combined with other parameters, except for columns

limit

= limit the number of posts to show, defaults to all

columns

= display output in columns, accepts values 2-6, default is 1 column

taxonomy

= taxonomy to display (must be used with the term parameter)

term

= term to display (must be used with the taxonomy parameter)

Example advanced usage:

[listings taxonomy="status" term="active" limit="10" columns="3"]
This will display all listings in the "Status" taxonomy, assigned to the "Active" term, limited to 10 listings, in 3 columns
Back to: IDX Broker Shortcodes

Data Services Provided By IDX, LLC
Content © 2024 IDX, LLC,
All Rights Reserved.