1. Home
  2. Docs
  3. Add-Ons
  4. Property Shortlist

Property Shortlist

If you're using the standard single property actions template, once the Property Shortlist add on is activated, you'll automatically get the add/remove button appended to the list of available actions.

Clicking the 'Add To Shortlist' button for the first time will add the property in question to the users shortlist and update the text of the button to 'Remove From Shortlist'. It does this by making an AJAX request, therefore making the process smooth and reducing the need to do a full refresh of the window. Clicking the button again will remove the property from the shortlist and restore the button text.

Behind the scenes the AJAX request appends chosen properties to a cookie called 'propertyhive_shortlist'. This cookie is set to be active for 7 days and will expire after this time if the user does not return to the website and update their shortlist in anyway. That is unless a user is logged in, in which case it will save any properties to their account which will appear as a new tab when logged in and using the [propertyhive_my_account] shortcode.

 

Displaying Shortlisted Properties

The easiest way to display shortlisted properties is to link to your search results page but append '?shortlisted=1' to the end of the URL. For example:

https://yoursite.com/search-results?shortlisted=1

 

Shortcodes

There are two available shortcodes available with this add on:

[shortlist_button]
Place the 'Add To/Remove From Shortlist' action button anywhere you like with this shortcode.

[shortlisted_properties]
Adding this shortcode will output a list of properties that are currently shortlisted by the user.

Was this article helpful to you? No 1 Yes

How can we help?