1. Home
  2. Docs
  3. Developer Guide
  4. Shortcodes
  5. [properties]

[properties]

Output a list of properties anywhere on the website using the shortcode:

[properties]

By default this will output 10 on market properties in price descending order and uses the content-property.php template.

Note: This shortcode is for displaying a select few properties.
Do not use this shortcode for the search results page as you will not get functionality such as pagination and ordering.
You should be specifying your search results page under 'Property Hive > Settings > General'.

You can modify this shortcode by adding one or more attributes to expand it (per your requirements):

Example: The following shortcode attributes are added together to achieve the Result below.

[properties property_type_id="5" bedrooms="2" availability_id="5"]

Result: Shortcode will display only properties classified as "Flats", with 2 bedrooms, with status "For Sale"

TYPE: Visual and functional

Attributes that affect how the [properties] shortcode shows properties and adds extra display options.

 

Attribute: carousel

Description: Displays properties as carousel slides; Previous and Next buttons added to scroll through.

Default: 4 (properties displayed at any given time)

Example: [properties carousel="1"] to enable and show.

 

Attribute: posts_per_page

Description: Determines the number of properties displayed at once, per page.

Default: 10

Example: [properties posts_per_page="12"]

 

Attribute: columns

Description: Determines the number of columns the properties appear in.

Default: 2

Example: [properties columns="3"]

 

Attribute: show_result_count

Description: Shows the number of search results found, currently on page and total.
i.e "Showing 1–12 of 99 properties"

Default: (empty)

Example: [properties show_result_count="1"] to enable and show.

 

Attribute: show_order

Description: Whether to show a dropdown allowing users to filter by price and date.

Default: (empty)

Example: [properties show_order="1"] to enable and show.

 

Attribute: pagination

Description: Adds the number of pages based on search results, so the user can go back and forth between them.

Default: (empty)

Example: [properties pagination="1"] to enable and show.


 

TYPE: Display Filters

Attributes that act as 'filters' and control which properties are displayed.

by Department

Attribute: department

Description: Include properties only from a specific active department.
Your Active Departments are found in Property Hive > Settings > General Options

Possible Values: (empty), residential-sales, residential-lettings, commercial

Default: (empty)

Example: [properties department="residential-sales"]


by Price

Attribute: minimum_price

Description: Display properties with their minimum sale price of "exact number" and higher than.

Default: (empty)

Example: [properties minimum_price="250000"]

 

Attribute: maximum_price

Description: Display properties with their maximum sale price of "exact number" and lower than.

Default: (empty)

Example: [properties maximum_price="750000"]


by number of Bedrooms

Attribute: bedrooms

Description: Display properties with an "exact number" of bedrooms.

Default: (empty)

Example: [properties bedrooms="2"]

 

Attribute: minimum_bedrooms

Description: Display properties based on their minimum "exact number" of bedrooms and higher than.

Default: (empty)

Example: [properties minimum_bedrooms="2"]


by Address

Attribute: address_keyword

Description: Includes properties with a specific keyword found in their address fields.

Default: (empty)

Example: [properties address_keyword="Lincoln"]

 

Attribute: radius

Description: Only applicable when Radial Search add-on is installed.

Default: (empty)

Example: [properties address_keyword="Lincoln" radius="10"]


by Custom Field IDs

IMPORTANT
To find the correct "IDs" used in attributes such as "availability_id", "property_type_id", "marketing_flag_id", etc:
Please, go to Property Hive > Settings > Custom Fields. Please use the IDs, not the actual words.

Attribute: availability_id

Description: Include properties based on their "Availability status" (For Sale, To Let, Under Offer, etc)

Default: (empty)

Example: [properties availability_id="5"]

 

Attribute: property_type_id

Description: Include properties based on their "Property Type" (Residential - Houses, Flats, etc) or (Commercial - Offices, Retail, etc)

Default: (empty)

Example: [properties property_type_id="5"]

 

Attribute: marketing_flag_id

Description: Include properties based on their "Marketing Flags" (Chain Free, New Build, Reduced, etc)

Default: (empty)

Example: [properties marketing_flag_id="5"]

 

Attribute: location_id

Description: Locations IDs are typically used to add a more narrow list of options during user searches - such as "Region", "Town", etc.

Default: (empty)

Example: [properties location_id="5"]

 

Attribute: office_id

Description: Include properties that belong to a specific office.
To find the office ID, go to Property Hive > Settings > Offices > Find the office which ID you need and click "Edit",
the ID will displayed at the end of the URL in your browser's search bar.

Default: (empty)

Example: [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> Find the users which ID you need and click "Edit",
the ID ("user_id=X") will displayed in the URL section in your browser's search bar.

Default: (empty)

Example: [properties negotiator_id="5"]

 

Attribute: ids

Description: A comma-delimited list of properties, should you wish to show specific properties using their "post IDs".

Default: (empty)

Example: [properties ids="312,543,654"]


Attribute: commercial_for_sale

Description:

Default: (empty)

Example: [properties commercial_for_sale="1"]

 

Attribute: commercial_to_rent

Description:

Default: (empty)

Example: [properties commercial_to_rent="1"]


by Meta Key and values

Attribute: meta_key

Description: _price_actual, _bedrooms, _on_market, _featured

Default: _price_actual

Example: [properties meta_key="_bedrooms"]


Attribute: orderby

Description:

Default: meta_value_num

Example: [properties orderby="meta_value_num"]


Attribute: order

Description:

Default: desc

Example: [properties order="asc"]


Was this article helpful to you? No Yes

How can we help?