Property Slideshow
Typically to be used on a property page, as it displays all the images that have been dragged over into the property-specific slideshow selection pane. However, the shortcode could be used virtually anywhere as long as you pass the id attribute into it specifying a particular property.
[property_slideshow]
When the Slideshow is displayed, it is wrapped in a <div> with a random class (which is necessary, and allows multiple slideshows to be used on one page), a ‘slider’ class, and optionally a custom class which you can insert via a shortcode. For example, if you wanted to wrap the particular slideshow in a class called my_custom_class, you would use the following shortcode:
[property_slideshow class='my_custom_class']
And the following HTML would be output:
<div class="random_id slider my_custom_class">slideshow images</div>
This is a good way of assigning different styles to different slideshows.
Setting the Image Size. You can pass an image size of your choice to override the slideshow size set on the Slideshow settings page. Keep in mind, you cannot pass completely arbitrary sizes, it has to be a size that exists on the Display tab. Example:
[property_slideshow image_size='thumbnail']
A good practical usage of this is when you want to insert a slideshow into the content area. Since content area widths vary from one template to the next, it many cases you will want to create a custom image size that fits your content area. So, if your content area is 550px wide, you may want to create an Image size (on the Properties Settings Page) that is 525px by 300px. If you name that image size In Content Image Size, the slug will be in_content_image_size, that is the slug you would pass into the shortcode.
After you associate a few image with a property, by uploading them in the same manner you would upload images to a post or a page, you will be able to drag and drop the images ( on Edit Property page ) you would like to appear in the property slideshow, just as you would with the global slideshow.
Cheat Sheet for [property_slideshow] shortcode.
| Shortcode | Type | Default | Description |
|---|---|---|---|
| effect | string(sliceDown, sliceDownLeft, sliceUp, sliceUpLeft, sliceUpDown, sliceUpDownLeft, fold, fade, random, slideInRight, slideInLeft, boxRamdom, boxRain, boxRainReverse, boxRainGrow, boxRainGrowReverse) | fade | To get a full list of available effects, check out the Nivo Slider Usage page . |
| slices | number | 5 | Sets slices number. |
| animation_speed | number in milliseconds | 500 | Sets animation speed. |
| pause_time | number in milliseconds | 5000 | Sets pause time. |
| show_side_ navigation | true/false | true | Switches side navigation. |
| show_side_ navigation_on_ hover_only | true/false | false | Sets side navigation to display only on hover. |
| show_pagination_ buttons | true/false | true | Switches pagination buttons. |
| image_size | string | As it is set on Properties/ Settings/ Slideshow tab | Sets image size. You can use size names from Properties/Settings/Display tab. |
| caption_opacity | number, 0 - 1 | 1 | Sets caption opacity. |
More Examples:
So, to give you some practical examples, let’s say we want to display a property slideshow that fades from one image to the next, very quickly, but pauses on each image for a while:
[property_slideshow effect=fade animation_speed=100 pauseTime=5000]
Note: keep in mind, all the times are in milliseconds. So ‘1000’, means 1 second and ‘500’ means half a second.
If you are a programmer, or are feeling very brave, you can also use the ‘wpp_slideshow_nivoslider’ filter which is applied to all the attributes passed into the nivoSlider() JavScript function.
Force the slideshow to display images from a specific property and override the image size to thumbnail. In this example we pull images from property with the ID of 212.
[property_slideshow id=212 image_size=thumbnail]
Set transition effect to fade and speed up the animation:
[property_slideshow effect=fade animation_speed=100]
Insert the slideshow into a template using PHP:
<?php echo do_shortcode("[property_slideshow]"); ?>
Styling the Slideshow:
Slideshow effects, times and slices can all be configured on the Slideshow settings page. However, at times you may want to customize a particular slideshow, in which case you can pass a variety of different arguments into the shortcode. Our slideshow uses Nivo Slider JavaScript library, and it may be beneficial for you to check out the Nivo Slider Usage page.