IDX Smart Pages Shortcodes
When you purchase and receive your custom Smart Pages plugin zip file, install and activate it just as you would any other plugin. That is: upload it to your wp-content/plugins folder with cPanel and unarchive it. The idx-smart-pages folder will be created and the plugin code installed. Go to WP Dashboard / plugins, and activate it. It uses different shortcodes from all of our other plugins, so as long as no other plugin uses the shortcode names shown below, it should activate with no issues.
Your customized Smart Pages plugin is licensed for the specific real estate site(s) identified in your product license, and is highly customized for each specific MLS / IDX/RETS feed. It may not be shared with or used by any other agent, broker or website(s) without written approval of CMS Real Estate Sites LLC as specified in the license. Generally, only one Smart Pages licenses will be sold for any one market area, defined as one MLS or Board. However, in some larger market areas, additional licenses may be granted when the primary market areas of each agent / broker do not overlap substantially.
In order to function properly, any Smart Pages plugin shortcode that includes IDX data also requires that we make a number of custom modifications to a few of the UIDX page templates. Most UIDX websites implemented 2011 and later may have most of those modifications in place. We will also install a CMSRES Custom plugin that allows us and the site owner to configure common site and MLS parameters used by all of our other plugins, including Smart Pages, Create Communities and UIDX Include.
Syntax and Functional Summary
The shortcodes implemented and used by this plugin include:
[idx-city-profile city="cityname" state="cd" longstate="state name" zipcodes="csv list" ziplist="csv list" create="N"]
[idx-county-profile county="countyname" state="state cd" longstate="state name"]
The state and longstate parameters are required if your MLS encompasses and supports multi-state listings. If not included in the shortcode, then the default state code and state name as defined for your site are used.
zipcodes: Required. Comma separated list of one or more zip codes that are included in this city. This zipcodes list is inherited and used by the Create Communities plugin, if present, and is also uinherited and used by all property typ sub-pages of this “About” page. Care must be exercised to insure that each zipcode in the list is a valid residential zipcode, and not a PO box or special zipcode.
ziplist: Optional. Comma separated list of one or more zip codes that are alternatives to and replacements for zipcodes. This parameter is used when an area is not an incorporated city/town/community, but can be associated with one or more specific zip codes. When provided, the ziplist parameter values are used instead of the city name in all generated UIDX search links, and is also used to generate the zip code specific search links. If this parameter is used, then the zipcodes parameter is ignored, so only one or the other may be specified.
create=”N”: This optional parameter and its value may be included if the site includes the “Create Communities” plugin, and that plugin’s normal sub-page creation functions are to be suppressed for this city or county.
This shortcode displays a standardized set of H1 and H2 tags for a specific city or county. For each predefined H2 section on the page, it includes city or county specific text for that section. Each section is created and maintained by the site owner using WP custom fields for that page. A set of tabs is generated at the top of each page that provide links to the various sections.
The intent of this page is to provide a site-wide standardized city and count page structure, which can then be filled in with content that may be provided by various sources and content writers. The set of predefined sections that are to be provided by the shortcode can be customized for each site and implementation.
This page is also intended to be the “parent” page for multiple city and county property type specific “child” pages for each city or county. The “child” pages are created separately, using multiple sets of the idx-city-top and idx-city-search shortcodes on each “child” pages as described below.
If you also have our “Create Communities” plugin, a user specified set of property type pages will automatically be generated for you the first time you visit your new city or county “About” page while logged in to WP as and Admin user. When this happens, the results of the Create Communities plugin actions are displayed at the bottom of the page, and a tab is created at the top of the page to the results report. Because this only happens when a logged in admin user accesses the page, non-admin site users will not see any of this. This default functionality may be suppressed, even for admin users, with the create=”N” option.
idx-city-top and idx-county-top
Substitute county for city in the following where applicable. This shortcode and its companion city-search or county-search shortcode are used on sub-pages under the main “About” page for the same county or city. The zipcodes, ziplist, state and longstate parameters used on the “About” page are inherited by these pages.
[idx-city-top city="cityname" proptype="proptype" hometype="hometype" zipcodes="csv zipcode list" ziplist="csv zipcode list"]
city: City name. Required. This is the only required parameter. In some MLS feeds that do not include a city name, this parameter may be implemented as “community” instead of “city”.
proptype: Optional. Primary property type. Typical values (one only): res, condo, patio, townhome, land, income, all. If omitted, “all” is assumed.
hometype: Optional. Special property type. Typical values (one only): ranch, horse, gated, senior, luxury, waterfront, pool home, pool community, new, lender, hud, short_sale, etc.
The search parameters generated for proptype and hometype will vary by MLS. Configuration of the search parameters is global per site and MLS, and is covered separately.
This shortcode displays the top section of a city or county property type specific page. It includes standard H1 and H2 tags, a set of tabs that link to various parts of the page content, plus “boilerplate” custom content which is designed for each site and implementation according to site owner preferences.
Following the idx-city-top shortcode, and before its partner idx-city-search shortcode, the site owner may add any other custom content for that particular city and property type page.
If the page that includes this shortcode does not already have a “title” custom field, then it will display a “SEO helper” block at the top of the page, with suggested title, description and keywords meta content. The page author would then copy and paste these suggestions into whatever SEO plugin (Platinum SEO Pack highly recommended) fields they may be applicable to for that page, modify the content if desired, and update the page. Once something is saved into the “title” custom field, the next time the page is displayed, the suggested meta content block will not be displayed.
This shortcode saves all of the provided parameters into WP custom fields for later use by the idx-city-search shortcode on the same page. Once the custom fields have been saved, the parameters may be omitted from all shortcodes on that page.
If desired, Instead of including the parameters in the shortcode, the site owner may choose to use the “Custom Field Template” plugin to enter the parameters. We recommend and would install this plugin at the time we install and configure the “IDX Smart Pages” plugin for each site owner.
Substitute county for city where applicable.
This shortcode inherits the parameters from the custom fields saved by the idx-city-top shortcode on the same page. If idx-city-top is not used, then the same parameters as described in the idx-city-top shortcode are applicable for this one, with city=”city name” being the only required parameter.
This shortcode displays a standard set of links to related UIDX “quick searches”, each of them pointing to and utilizing the UIDX standard search url and parameters syntax, plus standard H2 and H3 tags in appropriate locations, and IDX search results applicable to the shortcode parameters used.
This shortcode may be used together with the idx-city-top shortcode on the same page, in which case it inherits the parameters provided in the idx-city-top shortcode, or independently. If used independently, then the same parameters described for the idx-city-top shortcode must be provided within the idx-city-search shortcode.
[idx-subdivision city="city name" subdivision="subdivision name" zipcode="123456" proptype="proptype" alias="see below" address="subdivision entrance street address" price="12345678" lat="12345678" long="12345678"]
city: City name. Required.
subdivision: Subdivision Name. Required.
zipcode: Optional. A single zip code in which this subdivision resides.
proptype: Optional. Primary property type (may vary by MLS). Typical values (one only): res, condo, patio, townhome, land, income, all. If omitted, “res” is assumed.
alias: Optional. At least one subdivision name to be used as the UIDX subdivision search parameter, in case the subdivision name alone is not adequate to select all of the applicable properties.
Format: A comma separated list, where each subdivision name may be surrounded by asterisks to denote a “contains” search, and any spaces are replaced with underlines.
In some MLS feeds, and for some subdivision types, notably some large master planned communities, the subdivision field in the IDX feed may not be the common subdivision name as known to the public, but a special “filing” name and number. Or, the MLS may allow abbreviations and other variations of the subdivision name to be manually entered by the listing agent. In these cases, this field is used for the UIDX subdivision search instead of the subdivision name, so the common subdivision name and all of its possible aliases would be entered here.
The following parameters apply and are used only if the “Simple Real Estate Pack” plugin is also installed, and the subdivision page is to include the SRP plugin’s tabbed block of additional subdivision information. If this is the case, then all of the following parameters are required. If any of them are omitted, then the SRP plugin function will not be used.
address: Address or street intersection of the subdivision’s entrance.
price: Median or average sale price for this subdivision. Used as the default sale price for estimated loan calculations.
lat: Latitude for the subdivision entrance address (from Google maps or other source)
long: Longitude for the subdivision entrance address (from Google maps or other source)
This shortcode displays selected IDX search results based on the shortcode parameters, just below a “Revise Search” abbreviated search form for that subdivision.
If the appropriate additional shortcode parameters are included, and the Simple Real Estate Pack plugin is installed and activated, it also displays the SRP profile for that subdivision, similar to the one displayed for an individual property, but using the subdivision entrance address and its geo coordinates instead of a specific property address.
When properly used, each idx-subdivison smart page would be a “child” page under its corresponding city and property type page. For example all residential detached home subdivisions would be “child” pages of the applicable city / property type page, as would additional idx-subdivision pages for specific condo buildings, townhome communities and patio/cluster home communities.
mlsnumber: Required. MLS Number. This is the only parameter, and is used to access and display the applicable UIDX details page for this property.
This shortcode displays one specific property details smart page by MLS number, using your standard UIDX property details template. Any user written content can be included on the same page, above and/or below the idx-property shortcode.
The shortcode will issue two UIDX requests. The first simple request returns only a few key property details, including the property address, city, zip code, and latitude and longitude, which are pre-formatted as a secondary WordPress shortcode that will perform the “heavy lifting” of actually bring in the rest of the property details and invoking the Simple Real Estate Pack plugin to generate the additional property information.
If the Simple Real Estate Pack plugin is installed and activated, and all of the required information, including latitude and longitude, are available in that listing, then it also displays the SRP profile for that particular property.
This function is great for your own featured listings. Since it always uses your MLS compliant property details template and includes all MLS required disclosures, you can also use it for any listing, not just your own.