UIDX Include
The UIDX Include WordPress Plugin
General
This plugin allows UIDX WordPress websites to include IDX summary search results and detailed listing content directly within the page content. The included IDX content is readable and therefore indexable by the search engine web crawlers. This level of IDX data integration gives the pages that use these shortcodes very powerful SEO value, especially when our advanced property details templates are used. Each version of the UIDX Include plugin is custom designed for a particular MLS / IDX / RETS feed. Contact CMS Real Estate Sites for availability for your MLS feed. The styling of the included content is the same as if it were on a normal UIDX search results or property details page.
Pricing (Includes custom Installation): $150.00
The Shortcodes
This plugin provides four WordPress shortcodes used to accomplish the IDX data integration:
The uidx-listing Shortcode
This shortcode displays an abbreviated version of the standard property details page, embedded on the page the shortcode is on. It contains exactly the same property details, photos slideshow, virtual tour link and all required IDX compliance components that would normally be displayed by clicking any search summary result, but without of the “Call to Action” buttons, Google map, similar listings, agent contact information, and other supplemental content of the normal property details page.
Syntax for uidx-listing Shortcode:
[uidx-listing mlsnumber="1234567"]
The uidx-listings Shortcode
This shortcode includes a special search results set, built and customized with the UIDX template management back end. It includes a simplified “Refine Search” form at the top, so users can further modify their search parameters, plus up to 25 matching search results, which utilize the standard MLS preapproved search result summary layout and content, plus all the MLS required disclosures. See example page.
Note on the example page that most of the shortcode search parameters, like city, county, MLS area and subdivision, are not in the simplified search form. This means that the user can refine the search results by modifying the price range, bed and bath counts, square feet, and a few other supplemental parameters, but not the special selection criteria specified in the shortcode. To do that they would need to use the standard basic or advanced search form, for which a link is always provided in the generated output, or they must be on a page or post where the basic criteria in the shortcode on that page is different.
Syntax for uidx-listings Shortcode
[uidx-listings sort="value" format="value" proptype="value" city="value" zipcode="value" ziplist="value,value" county="value" mlsarea="value" subdivision="value" alias="value,value" hometype="value" style="value" finsqft="value" minprice="value" maxprice="value" shortsale="value" reo="value" hud="value" limit="value" noform="value" title="value" map="value" latmin="value" latmax="value" longmin"value" longmax"value" ]
General Notes:
- All selection criteria are optional, but at least three criteria must be specified.
- Selection criteria may be entered in any order.
- Selection criteria are separated from one another by one or more spaces. They do not need to be on separate lines as shown above.
- For any omitted criteria where a default value is not specified, “any” is assumed.
- For any “or” criteria fields, if both criteria are specified, the last one in the list below will be used, and the other will be ignored.
Selection Criteria Values for uidx-listings Shortcode
sort: mls (default), date, price, city (Pick one)
date uses last modified date, not listing date
mls, date and price are sorted descending numeric,
city is sorted ascending alpha
proptype: res, condo, land, income
city: City Name – Capitalize first letter of each word of the name
zipcode: A single zip code or:
ziplist: Multiple zip codes, separated by commas.
If both zipcode and ziplist are is specified, ziplist is used and zipcode is ignored.
county: County name – Capitalize first letter of each word of the name
mlsarea: MLS area full name – Varies by MLS – See your MLS for specific values.
subdivision: One specific subdivision name, or:
alias: Special selection criteria for one or more subdivision or partial subdivision names,
each separated by comma, which are used as “contains” values.
i.e.: “filing 123,Venneford,Veneford”
If both subdivision and alias are specified, then alias is used and subdivision is ignored.
hometype: (pick one)
If proptype=”res”: detached, attached, duplex, patio
If proptype=”condo”: condo, townhome, hirise, lowrise
N/A for land and income proptype
style: (pick one)
If proptype=”res”: ranch, raised-ranch, two-story, three-story, bi-level, tri-level, tri-level-bsmt
If proptype=”condo”: condo, townhome, garden-level, loft, penthouse, studio
N/A for land and income proptype
finsqft: Minimum finished square feet value, without commas
minprice: Minimum current list price, without commas
maxprice: Maximum current list price, without commas
shortsale: “Y” for short sales only, or “N” if short sales are to be excluded
reo: “Y” for lender owned only, “N” for lender owned to be excluded
hud: “Y” for any government owned, including HUD, VA, FNMA
limit: maximum number of listings to display
noform: “Y” to suppress the “Refine Search” form
title: Any appropriate text string to describe this search.
Title is displayed in the top h3 position above the revise search form and search results,
i.e.: “Highlands Ranch”, or “Park Hill”, or “Parker Townhomes”.
format: “summary” for default search results summary template, “micro” for sidebar / micro template
The following are not yet available in UIDX:
map: “Y” or “N” (default)
If map = “Y”, and a map search is available in your version of UIDX, then the following four parameters
are also required to specify the map window corners, and these parameters will also limit the search
results to those located within the specified map window.
latmin: Latitude minimum value
latmax: Latitude maximum value
longmin: Longitude minimum value
longmax: Longitude maximum value
The uidx-featured Shortcode
This shortcode will display all active listings for a particular officeid or agentid, or specific listings as included in the UIDX back end “Manage Sites”, “Listings” admin panel for this particular website, or a single listing or multiple listings by MLS number. If all agents share the same website, and have their own agent pages, then the agentid parameter of this shortcode could be used on their personal pages, and the officeid parameter could be used on the main office site.
Unlike the uidx-listings shortcode, since the listings displayed by the uidx-featured shortcode are intended to be only selected listings belonging to the site owner’s office and/or agents, the abbreviated “Revise Search” form is not included in the output. Otherwise, the same search summary results layout, content and css as all other search results is used, and the full MLS required disclosure is included following the last listing summary.
Syntax for uidx-featured Shortcode Variations
See following.
The uidx-widget Shortcode
Like the uidx-featured shortcode above, and using the exact same set of parameter options, the uidx-widget shortcode will display all active listings for a particular officeid or agentid, or specific listings as included in the UIDX back end “Manage Sites”, “Listings” admin panel for this particular website, or a single listing or multiple listings by MLS number. It also does not display the abbreviated “Revise Search” form.
The main difference is that the uidx-widget shortcode generates very small summaries of each listing, with only the bare minimum of information, plus a link to the applicable property details page, and it is intended for use in either sidebar or footer widget positions. In order for shortcodes to work at all in any widget position, the WordPress “Allow shortcodes in widgets” option must be enabled. This may require a 3rd party plugin to accomplish.
Since the layout and css for the output of this shortcode are not the same as for normal search results, special css is required, and may be set up in the UIDX admin backend. We can assist our clients with any special css that may be required, such as different css for the uidx-widget shortcode when used in footer widget positions vs. a sidebar.
Due to severe space limitations in widget positions, and because this shortcode is only intended for embedding the site owner’s own office and/or agent listings, not listings for another office or agent, the output of this shortcode also does not generate the full MLS required disclaimers when listings other than the site owner’s are to be displayed. Therefore, we advise that if the site owner intends to include listings other than their own with this shortcode, which is not recommended, then the MLS required disclaimers must be made a standard part of every website page if this shortcode is to be used at all, preferably by inserting the required disclosure into the footer.php code file in the applicable theme folder.
Syntax for uidx-featured and uidx-widget Shortcode Variations
Both of these shortcodes share the same syntax, except for the different shortcode names. In the syntax examples below, substitute uidx-widget for uidx-featured in the shortcode name for the widget version.
For the uidx-featured shortcode, you may also add: title=”Any appropriate text string”. This will display the text in the top h3 position above the search results, i.e.: “Our Office Listings”, or “Sally Smith’s Listings”.
Option 1: Display all listings in the UIDX backend Sites / Listings list
If your UIDX environment includes multiple websites, there will be a different “Listings” set for each site, which allows the main office site to display all office listings or a selection of them, while agent micro site listings list would be just the “featured” listings for that agent. the limit parameter is not applicable to this option. The entire list will be displayed.
[uidx-featured]
Option 2: Display all listings where listing agent ID = agentid (*)
This is primarily intended for use on an agent’s personal listings page. When an agent has many listings, the number of listings to be included can be set with the optional limit variable. If no limit variable is specified, summaries for up to 25 of the most recent active agent listings will be displayed. Setting the limit variable to no more than 3-4 is highly recommended when the uidx-widget shortcode is used in a sidebar widget position, and usually to 1 for any footer widget position.
The default for the limit parameter is 25.
[uidx-featured agentid="value" limit="value"]
Option 3: Display all listings where listing office ID = officeid (*)
Because agents can change offices, it is strongly advised that when using agentid, the officeid parameter also be included. When an office has many listings, the number of listings to be included can be set with the optional limit variable.
The default for the limit parameter is 25. Setting the limit variable to no more than 3-4 is highly recommended when the uidx-widget shortcode is used in a sidebar widget position, and to 1 for any footer widget position.
[uidx-featured officeid="value" limit="value"]
Option 4: Display a specific single listing by MLS number
For the uidx-widget shortcode, this variation is recommended for footer widget positions that only allow for a single listing. The limit parameter is not applicable, and if included, will be ignored, since this is a specific single listing request.
[uidx-featured mlsnumber="value"]
Option 5: Display a specific multiple listings by MLS numbers
The limit parameter is not applicable, and if included, will be ignored, since this is a request for all of the specified listings.
[uidx-featured mlslist="value1,value2,value3"]
Combinations of the above parameters may be used in the same shortcode, except that if mlslist is included, and mlsnumber is also included, mlsnumber will be ignored and only mlslist will be used.
(*)The officeid value and agentid value are database keys, and not the same as what your MLS uses. Call for details.