Rotators API
Display mode: slides
Parameters
find
The rotator ID, slug, or assigned page identifier to return the slides for.
Example:
"find:homepage-highlights",
The assigned page identifier should be in the form of p-123456, with 123456 representing the actual ID of the page. Rather than hard-coding this identifier in a page template, however, the nav query string should be used to dynamically call the correct rotator for the current page.
Example:
"find:" . $_GET['nav'],
howmany
Limits the number of slides returned. By default, 250 are returned at a time.
Example:
"howmany:25",
order
The order in which to return the slides. position is used by default.
| Option | Description |
|---|---|
| created | Order by the slide's created date. |
| modified | Order by the slide's last modified date. |
| position | Order by the slide's position. Default. |
Example:
"order:position",
page
In conjunction with howmany, specifies which page of results to return. By default, page 1 is returned.
Example:
"page:2",
Show
before_show, after_show, before_slide_show, after_slide_show, before_slide_show_#, after_slide_show_#
before_slide_show and after_slide_show support a dynamic number of additional show tags to accomplish more complex markup. before_slide_show_2, before_slide_show_3, after_slide_show_2, after_slide_show_3, etc.
| Tag | Description |
|---|---|
| __id__ | Internal ID of the rotator for unique identification. |
| __ifimage__ | Returns a space (" ") if one of the slides is an image, and nothing if not. This should be included on its own line followed by the markup to output. |
| __ifvideo__ | Returns a space (" ") if one of the slides is a video (of any kind), and nothing if not. This should be included on its own line followed by the markup to output. |
| __ifvideoembed__ | Returns a space (" ") if one of the slides is an embedded video, and nothing if not. This should be included on its own line followed by the markup to output. |
| __ifvideohosted__ | Returns a space (" ") if one of the slides is a CMS hosted video, and nothing if not. This should be included on its own line followed by the markup to output. |
| __ifvideovimeo__ | Returns a space (" ") if one of the slides is a Vimeo video, and nothing if not. This should be included on its own line followed by the markup to output. |
| __ifvideoyoutube__ | Returns a space (" ") if one of the slides is a YouTube video, and nothing if not. This should be included on its own line followed by the markup to output. |
| __slug__ | Slugged version of title. |
| __title__ | Title of rotator. |
| __transitions__ | Transition speed in seconds. |
| __transitionms__ | Transition speed in milliseconds. |
| Any Custom Fields setup for Rotators will output their API tags | |
slide_show, image_slide_show, video_slide_show, slide_show_#, image_slide_show_#, video_slide_show_#
slide_show, image_slide_show, and video_slide_show support a dynamic number of additional show tags to accomplish more complex markup. slide_show_2, slide_show_3, image_slide_show_2, image_slide_show_3, etc.
| Tag | Description |
|---|---|
| __caption__ | Caption of slide. |
| __contentimageurl__ | URL of content's image. All image caching/thumbnail parameters are available. |
| __contentsummary__ | Summary text of content. No markup. |
| __contenttitle__ | Title of content. |
| __contenturl__ | URL of content. |
| __contentvideoembed__ | Content's video embed <iframe> HTML. Parameters height Height of <iframe>. width Width of <iframe>. |
| __contentvideoembedurl__ | URL of content's video embed. Useful for constructing custom embed markup. |
| __contentvideourl__ | URL of content's CMS hosted video. |
| __id__ | Internal ID of the slide for unique identification. |
| __ifimage__ | Returns a space (" ") if the slide is an image, and nothing if not. This should be included on its own line followed by the markup to output. |
| __ifvideo__ | Returns a space (" ") if the slide is a video (of any kind), and nothing if not. This should be included on its own line followed by the markup to output. |
| __ifvideoembed__ | Returns a space (" ") if the slide is an embedded video, and nothing if not. This should be included on its own line followed by the markup to output. |
| __ifvideohosted__ | Returns a space (" ") if the slide is a CMS hosted video, and nothing if not. This should be included on its own line followed by the markup to output. |
| __ifvideovimeo__ | Returns a space (" ") if the slide is a Vimeo video, and nothing if not. This should be included on its own line followed by the markup to output. |
| __ifvideoyoutube__ | Returns a space (" ") if the slide is a YouTube video, and nothing if not. This should be included on its own line followed by the markup to output. |
| __imageurl__ | URL of image. All image caching/thumbnail parameters are available. |
| __position__ | Position of slide. |
| __title__ | Title of slide. |
| __url__ | URL of slide. |
| __ifurlnewwindow__ | Returns a space (" ") if the URL is set to open in a new window, and nothing if not. This should be included on its own line followed by the markup to output. For example, show:__ifurlnewwindow__target="_blank" will only be output for URLs set to open in a new window. |
| __videoembed__ | Video embed <iframe> HTML. Parameters height Height of <iframe>. width Width of <iframe>. |
| __videoembedurl__ | URL of video embed. Useful for constructing custom embed markup. |
| __videopreviewimageurl__ | URL of preview image to use for the video. All image caching/thumbnail parameters are available. |
| __videourl__ | URL of CMS hosted video. |
| Any Custom Fields setup for Rotator Slides will output their API tags | |
no_show
Displayed when no slides are returned at all.