WooSlider Shortcode Parameters Reference

Sometimes, it's necessary to add an extra parameter to an existing [wooslider] shortcode, or maybe you just prefer adding the parameters manually, instead of using the built-in shortcode creator.

Below is a list of all available parameters that can be used with the [wooslider] shortcode. The default settings for each of the "settings" parameters can be adjusted on the WooSlider "Settings" screen.

Defaults for the slideshow type-specific parameters are listed below each parameter, if a default setting is applicable.

General Settings

  • slider_type - The slideshow type desired (bundled options include "attachments", "posts" and "slides")
  • animation - The type of animation transition to apply ("slide" or "fade")
  • direction - The direction in which to slide the slides (works only with the "slide" animation) ("horizontal" or "vertical")
  • slideshow_speed - The delay between each slide animation (0.5 - 10.0 - in seconds ( 1.5, 2.0, 2.5, etc))
  • animation_duration - The duration of each slide transition animation (0.1 - 0.9 and 1.0 - 10.0, with 0.5 increments)

Control Settings

  • autoslide - Whether or not to automatically animate the slideshow (Boolean- "true" or "false") 
  • smoothheight - Whether or not to adjust the slideshow height to the height of the current slide (Boolean- "true" or "false") 
  • direction_nav - Whether or not to display the "previous/next" navigation (Boolean- "true" or "false") 
  • control_nav - Whether or not to display the pagination (Boolean- "true" or "false")
  • keyboard_nav - Whether or not to enable navigation using a keyboard (Boolean- "true" or "false") 
  • mousewheel_nav - Whether or not to enable navigation using the mousewheel (Boolean- "true" or "false")
  • randomize - Whether or not to randomize the display of the slides in the slideshow (Boolean- "true" or "false")
  • animation_loop - Whether or not to loop the animation when reaching the end (Boolean- "true" or "false")
  • pause_on_action - Whether or not to pause when the visitor uses the navigation controls on the slideshow (Boolean- "true" or "false")
  • pause_on_hover - Whether or not to pause when the visitor hovers over the slideshow (Boolean- "true" or "false")

Button Settings

  • prev_text - Custom text to display as the "Previous Slide" button text
  • next_text - Custom text to display as the "Next Slide" button text
  • play_text - Custom text to display as the "Play Slideshow" button text
  • pause_text - Custom text to display as the "Pause Slideshow" button text
Note: By default, WooSlider's CSS styles hide the text on these buttons. Additional CSS styles would be required to display this text (alternatively, it displays when hovering over the buttons).

"Attached Images"-specific parameters

  • id - An optional post ID for which to retrieve attached images (must be an integer).
    Default: $post->ID (the ID of the current post being viewed)

  • size - The size of the image to be displayed (takes a WordPress size handle - "thumbnail", "medium", "large", "full" or a custom-registered image size)
    Default: "large"

  • limit - The number of posts to display (an integer value such as 1, 5, or 10, for example)
    Default: "5"

  • thumbnails - Whether or not to use thumbnails for pagination, instead of the default pagination navigation (Boolean- "true" or "false")
    Default: "false"

"Posts"-specific parameters

  • category - The slug (or a comma-separated list of slugs) of one or more of your post categories

  • tag - The slug (or a comma-separated list of slugs) of one or more of your post tags

  • size - The size of the image to be displayed (takes a WordPress size handle - "thumbnail", "medium", "large", "full" or a custom-registered image size)
    Default: "large"

  • layout - Where to display the post title and excerpt, in relation to the image ("text-left", "text-right", "text-top", "text-bottom")
    Default: "text-left"

  • overlay - Whether or not to overlay the text over the image ("none", "natural" or "full")
    Default: "none"

  • limit - The number of posts to display (an integer value such as 1, 5, or 10, for example)
    Default: "5"

  • thumbnails - Whether or not to use thumbnails for pagination, instead of the default pagination navigation (Boolean- "true" or "false")
    Default: "false"

  • link_title - Whether or not to transform the title of each post into a link to the post itself (Boolean- "true" or "false")
    Default: "false"

"Slides"-specific parameters

  • slide_page - The slug (or a comma-separated list of slugs) of one or more of your slide groups

  • limit - The number of posts to display (an integer value such as 1, 5, or 10, for example)
    Default: "5"

  • thumbnails - Whether or not to use thumbnails for pagination, instead of the default pagination navigation (Boolean- "true" or "false")
    Default: "false"

How to use these parameters


Adding parameters to the [wooslider] shortcode looks like this:

[wooslider autoslide="false"]

Adding a second parameter (smoothheight, for example) would look as follows:

[wooslider autoslide="false" smoothheight="true"]

It's only necessary to add a parameter to the shortcode if you wish to override that specific parameter for that slideshow.
Didn't find an answer to your question? Search Again or Contact Us

Comments

  • Avatar
    Jordan Schelew

    I wanted to use FlexSlider's built in options to show multiple items up at a time, however while FlexSlider allows this simply by specifying itemWidth: [width], FlexSlider does not allow it. So I threw in the following in classes/class-wooslider-frontend.php:139

     

    // Individual Image Item Width

    if ( isset( $args['item_width'] ) && is_numeric( $args['item_width']]

    ) ) {

    error_log("Here!", 0);

    $args_output .= ', itemWidth: ' . $args['item_width'];

    }

     

  • Avatar
    Jordan Schelew

    Didn't mean to leave debugging line in there, but I can't seem to edit my comment. If someone could remove "error_log("Here!", 0);" that would be great.

  • Avatar
    Don Current

    Would be nice to add the "size" option to the widget as well. I went ahead and enabled shortcode in my widgets, but it seems like the option should be available in the widget too. It solved my problem of the height shifting slightly between slides that were cropped within Wordpress.

  • Avatar
    mioudesign

    Hi, I'm inserting the slider in my php template to show attached images. I would like to be able to show the image caption, (the same way it does when we use the Attached Images Slideshow (Wooslider) widget. The thing is, in the "Attached Images"-specific parameters section of your document, the caption is not there as a parameter.

    Is it possible to activate it? array( '????' => 'true') ? Thank you!