carouFredSel - The ultimate WordPress Carousel plugin

Easy Carousel’s in WordPress

Carousel’s in WordPress just got a thousand times better. carouFredSel takes the awesome power of the carouFredSel jQuery plugin and integrates it into WordPress so you can create unlimited carousel’s in your WordPress site without touching any code. Simply upload your images, drag and drop re-order them, add some captions and you’re good to go.

Simple or Advanced Configuration

carouFredSel comes with three configurations modes, “Basic” mode where you can choose some of our built in layout styles and keep things uber simple, “Advanced” mode or “Super User” mode where you can literally edit the configuration like you would when using the jQuery plugin for ultimate control and flexibility.

500px, Flickr & Instagram Integration

Sometimes you don’t want to upload images manually, you would rather pull them from your favorite image service. carouFredSel integrates with 500px, Flickr & Instagram so you can automatically pull your latest mug shots from Instagram, get images from Flickr tagged “beach”, see your friends latest 500px shots, etc. You get the idea.

Usual Awesomeness Built In

Not only do you get the amazing features above, but you get all the other awesome features that we bake in to our WordPress plugins to make the experience as ninja as possible. These include automatic updates, built in lightbox, role management, custom CSS input and hooks and filters for extensibility.

Demos

See the carousel above. That’s actually a live demo of carouFredSel. Cool right?

If you want to see some more demo’s of carouFredSel, or want to check out how the WordPress plugin works then head on over to our carouFredSel Demo site. Note that the demo site is fully responsive so try resizing your browser too.

Usage

Welcome to the carouFredSel Documentation section. Here you will find help and tutorials on using the carouFredSel WordPress plugin. You can also ask questions and get support over at the Support Forums.

Requirements

Before we go ahead and install the plugin you need to make sure your WordPress install will be able to handle the plugin. You need to have at least the following running on your server:

WordPress v3.1
PHP v5.2

If you don’t have these or you don’t know what these are, it’s worth getting in touch with your hosting provider just to check.

Installation

Once you have purchased your copy of the carouFredSel WordPress Plugin and downloaded it to your computer you will need to follow these steps to install the plugin in WordPress:

Log in to your WordPress admin backend.
Go to the Plugins > Add New page.
Click on the Upload tab.
On this page click the Choose File button choose the carouFredSel WordPress Plugin zip file that you previously downloaded.
Click the Install Now button and the plugin will be installed.
You should now see a carouFredSel section in your main menu where you can create and manage your carousel’s.

Using the Plugin

Using the plugin is fairly straightforward. Simply create a carousel in the WordPress administration area. You can upload images directly or configure another image source to dynamically pull images from another location. Then you can configure the carousel settings itself.

The plugin comes with a selection of pre-built layout styles when using “Basic” mode. This means you don’t have to worry about styling or configuration as the carousel will be set up for you. “Advanced” mode allows you to edit most of the settings you would normally be able to edit in the jQuery plugin. This mode gives you the ability to control almost every aspect of the carousel. Finally the “Super User” mode allows you directly input the settings as you would do in the carouFredSel jQuery plugin. This gives you complete control over the carousel settings.

Once the carousel has been published you can simply copy the shortcode that has been generated and use this in the WordPress post/page editor to input the carousel into a post or page. More advanced users can use the caroufredsel() template tag to insert carousels directly into the theme code.

Advanced

Below are some more advanced tips on using the plugin:

Using the carouFredSel WordPress Plugin Template Tag

To make use of the carouFredSel template tag simply use it like this:

<?php caroufredsel(123); // Use an ID ?>
<?php caroufredsel('a-slug'); // Use an slug ?>

Packaging the carouFredSel WordPress Plugin With Your (Premium) Theme

With the Developer package you can include the carouFredSel WordPress plugin in your premium themes (a “premium theme” is simply a theme that you sell on a marketplace like ThemeForest). However packaging the plugin for distribution with your theme will require a bit of work. Here is the process we recommend.

Create your theme and use the PHP shortcode function to include carousel’s in your template code. Remember the slugs you use in your template galleries, as you will need them later.
We recommend you use the TGM_Plugin_Activation class to actually package the plugin with your theme. This class allows users to activate plugins that have been packaged with the theme. Follow this tutorial to see how to achieve this.
Finally, in your theme documentation, tell the users to create carousel’s with the same name as the slugs you have used in your template code. So for example, if you have used the carousel shortcode [caroufredsel slug="my-gallery"], the user must create a carousel with the title “My Gallery”. Then their created carousel will appear in the correct location.

Hooks & Filters

Hooks:

caroufredsel_before_caroufredsel
caroufredsel_after_caroufredsel

Filters:

caroufredsel_labels (params: $labels)
caroufredsel_messages (params: $caroufredsel_messages)
caroufredsel_settings_page_header (params: $header)
wp_cfs_allowed_roles (params: $custom_roles)
caroufredsel_settings_intro
caroufredsel_image_source_default (params: 'upload')
caroufredsel_useful_links (params: $links)

Changelog

2013.06.03 – version 1.2.1
* [Fixed] File upload shows all images bug

2013.05.27 – version 1.2
* [New] WordPress 3.6 compatibility
* [Changed] The way we include scripts and jQuery UI
* [Fixed] image_resize() depreciation
* [Fixed] Oauth bug
* [Fixed] timeoutDuration missing
* [Fixed] Autoplay bug in Advanced mode
* [Fixed] Pagination bug

2013.02.21 – version 1.1
* [New] Option to specify how many images to show
* [Fixed] Small bug fixes

2013.02.11 – version 1.0
* Initial release

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Support

People who purchase our commercial products can receive support via our support forums where you can search our knowledge base articles, browse public discussions, or create a new discussion if you’re having trouble. Private requests can be made via the support forums contact page. Please note that only support requests submitted through the support forum will be answered (i.e. emails sent directly to us will be ignored).

Open 9am - 5pm (GMT) Visit our Support Forums