Shortcodes
Is a comprehensive collection of various visual and functional elements, which you can use in the post editor, text widgets or even in template files.
Results Page Layout
Converts the rendered results of Optima Express shortcode into the selected results page theme layout
Shortcode Usage
[aios_custom_ihomefinder_shortcode_results]
{{OPTIMA_EXPRESS_SHORTCODE_GOES_HERE}}
[/aios_custom_ihomefinder_shortcode_results]
Supported Optima Express Shortcodes
optima_express_featured
optima_express_toppicks
optima_express_search_results
Shortcode Attributes
Atrributes | Description | Accepted Values | Default Value |
---|---|---|---|
controls | control button filters for list, grid, table view. | show / hide | show |
forms | refine search form filter | show / hide | show |
paginations | pagination links below results template | show / hide | show |
disclaimers | IHF disclaimer below results template | show / hide | show |
view | default view layout of rendered results template | list / grid / table | empty (all view will be rendered) |
In using this shortcode, you just need to wrap your Optima Express Shortcode with aios_custom_ihomefinder_shortcode_results shortcode so that the selected theme under results page theme tab will render the standard layout into a custom layout.
Widgetized Layout
Creates array of data by the given iHomefinder results page url that can be used inside shortcode itself.
Shortcode Usage #html
[aios_custom_ihomefinder_shortcode_widgetized
id="my-wigetized-layout"
url="{{blogurl}}/listing-report/Auburn/1192032/"
response_format='<div className="my-container-className">{{response}}</div>'
error_format='<div className="my-container-className">{{error}}</div>']
Index: {{index}}
Listing Number: {{listingNumber}}
Property Type: {{propertyType}}
Permalink: {{permalink}}
Full Address: {{fullAddress}}
Street: {{street}}
City: {{city}}
Zipcode: {{zipcode}}
Price: {{price}}
Beds: {{beds}}
Baths: {{baths}}
Sqft: {{sqft}}
Image: {{image}}
[/aios_custom_ihomefinder_shortcode_widgetized]
Shortcode Attributes
Atrributes | Description | Accepted Values | Default Value | Sample Usage |
---|---|---|---|---|
id | unique id for shortcode usage | only accepts small caps and hypen | empty but required | my-wigetized-layout |
url | url for any iHomeFinder results page | iHomefinder results page url | empty but required | {{blogurl}} /listing-report/Auburn/1192032/ |
posts_per_page | number of rendered listings | numeric | 6 | 6 |
no_found_text | returned text if no listings found on the given url | short description | Listings not found, please come back later… | My custom error response… |
use_proxy | uses agentimage proxy server on listing image | true / false | false | false |
proxy_width | proxy width on listing image | numeric | 800 | 800 |
proxy_height | proxy height on listing image | numeric | 800 | 800 |
response_format | format for successful response | string | {{response}} | <div className="my-container-className">`{{response}}`</div> {{response}} code is required since it will be replace as the actual success response |
error_format | format for error response | string | {{error}} | <div className="my-container-className">{{error}}</div> {{error}} will be replace as the actual error response but still optional and can be replaced with your desired response |
use_coming_soon | uses coming soon response if registration key on Optima Express is invalid or doesn’t exist | true / false | false | false |
coming_soon_format | format for coming soon response | string | {{coming_soon}} | <div className="my-container-className">`{{coming_soon}}`</div> {{coming_soon}} will be replace as the actual coming soon response but still optional and can be replaced with your desired response |
Inline Attributes
Atrributes | Description |
---|---|
{{index}} | returns index number of the loop |
{{listing_number}} | returns listing number |
{{property_type}} | returns listing type |
{{permalink}} | returns listing url/permalink |
{{fullAddress}} | returns listings full address |
{{street}} | returns listings street |
{{city}} | returns listings city |
{{zipcode}} | returns listings zipcode |
{{price}} | returns listings price |
{{beds}} | returns listings beds |
{{baths}} | returns listings baths |
{{sqft}} | returns listings sqft |
{{image}} | returns listings image |
In using this shortcode, url
and id
attributes are both required. Created transients when using this shortcode can be view/manage via yoursite.com/wp-admin/admin.php?page=aios-custom-ihomefinder&panel=settings&panel_child=settings-transients