Shortcodes - [featured_properties]
About the shortcode
Output a list of featured properties anywhere on the website using the shortcode:
[featured_properties]
By default this will output 12 featured on market properties in a random order.
Use the attributes below to further filter the properties output, for example:
[featured_properties department="residential-sales" availability_id="5"]
How to mark a property as 'Featured'
If you're entering properties manually into Property Hive you can specify this under the 'Marketing' tab or a property record:
If you're importing properties from a third party CRM using our Property Import add on then you should be able to set a property as 'Featured' in the CRM and we'll import and set it automatically. Setting it manually in this case inside Property Hive could result in it being overwritten the next time an import runs.
Attributes (display)
Attribute: carousel
Description: Displays properties as carousel slides with 'Next' and 'Prev' buttons to slide through it. Use the 'columns' attribute to specify how many properties show per slide.
Default: (empty)
Example: [featured_properties carousel="1"]
Attribute: per_page
Description: Determines the number of properties displayed
Default: 12
Example: [featured_properties per_page="12"]
Attribute: columns
Description: Determines the number of columns the properties appear in.
Default: 4
Example: [featured_properties columns="3"]
Attribute: no_results_output
Description: Message to show if no properties are found.
Default: (empty)
Example: [featured_properties no_results_output="No properties to display"]
Attribute: show_result_count
Description: Shows the number of search results found, currently on page and total, e.g. "Showing 1–12 of 99 properties"
Default: (empty)
Example: [featured_properties show_result_count="1"]
Attribute: show_order
Description: Whether to show a dropdown allowing users to sort by price and date.
Default: (empty)
Example: [featured_properties show_order="1"]
Attribute: pagination
Description: Adds pagination so the user can go back and forth between pages.
Default: (empty)
Example: [featured_properties pagination="1"]
Attributes (filtering properties)
Attribute: department
Description: Include properties only from a specific department. Departments can be managed under 'Property Hive > Settings > General'.
Possible Values: (empty), residential-sales, residential-lettings, commercial
Default: (empty)
Example: [featured_properties department="residential-sales"]
Attribute: address_keyword
Description: Includes properties with a specific keyword found in one their address fields.
Default: (empty)
Example: [featured_properties address_keyword="Lincoln"]
Attribute: availability_id
Description: Include properties based on their availability (For Sale, To Let, Under Offer etc).
The ID(s) can be found under 'Property Hive > Settings > Custom Fields'.
Supports multiple comma-delimited IDs.
Default: (empty)
Example: [featured_properties availability_id="5,8"]
Attribute: office_id
Description: Include properties that belong to a specific office.
To find the office ID, go to 'Property Hive > Settings > Offices' and click 'Edit' next to the office in question. The ID will displayed at the end of the URL in your browser URL bar.
Supports multiple comma-delimited IDs.
Default: (empty)
Example: [featured_properties office_id="5"]
Attribute: negotiator_id
Description: Include properties that belong to a specific negotiator.
To find the negotiator ID, go to 'Users > Settings > All Users' and click 'Edit' next to the negotiator/user in question. The ID will displayed in the URL section in your browser URL bar.
Supports multiple comma-delimited IDs.
Default: (empty)
Example: [featured_properties negotiator_id="5"]
Attributes (ordering)
Attribute: meta_key
Description: If wanting to order by a post meta value, enter the key name here.
Possible Values: _price_actual, _bedrooms, _on_market, _featured
Default: _price_actual
Example: [featured_properties meta_key="_bedrooms"]
Attribute: orderby
Description: The 'orderby' argument passed through to WP_Query when querying the properties.
Default: rand
Example: [featured_properties orderby="meta_value_num"]
Attribute: order
Description: The direction of order for properties based on the 'orderby' attribute
Default: desc
Example: [featured_properties order="asc"]