WordPress.org

Ready to get started?Download WordPress

Plugin Directory

Conveyor

Gives you a 'slides' custom post type, or use your own post type with an optional 'featured slide' checkbox to render a carousel.

What functions can I use?

Two functions are provided by this plugin, these are:

  • conveyor_query_arguements()
  • conveyor_render_bootstrap()

Both of these functions accept arguments.

What does the conveyor_query_arguements() function do?

This function provides arguments for you to filter the slides (or your own post types) creating a custom Loop. You can use it like so:

get_posts( conveyor_query_arguements( $args ) );

It accepts the following arguments as an array (or you can leave the $args empty to use the defaults):

$defaults = array(
    'featured'                  => false,                           // [ true | false ] - Set to true to return posts that have the featured post custom meta data set to true
    'featured_post_meta_key'    => '_conveyor_featured',            // The custom meta field that identifies the featured post, will also accept an array
    'order'                     => 'ASC',                           // [ ASC | DESC ]
    'orderby'                   => 'date',                          // [ date | menu_order ]
    'posts_per_page'            => 5,                               // Set number of posts to return, -1 will return all
    'post_type'                 => 'conveyor_slides',               // [ post | page | custom post type | array() ]         
    'taxonomy_filter'           => false,                           // [ true | false ] - Set to true to filter by taxonomy
    'taxonomy_key'              => 'conveyor_group',                // The key of the taxonomy we wish to filter by
    'taxonomy_terms'            => 'conveyor-group-1'               // The terms (uses slug), will accept a string or array
);

get_posts( conveyor_query_arguements( $defaults ) );

What does the conveyor_render_bootstrap() function do?

This function will render a Bootstrap 3 carousel. You can use it like so:

conveyor_render_bootstrap( $args );

It accepts all the same arguments as the conveyor_query_arguements() function, as well as the following arguments as an array (or you can leave the $args empty to use the defaults):

$defaults = array(
    'featured'                  => false,                               // [ true | false ] - Set to true to return posts that have the featured post custom meta data set to true
    'featured_post_meta_key'    => '_conveyor_featured',                // The custom meta field that identifies the featured post, will also accept an array
    'id'                        => 'conveyor_carousel',                 // If you want to have multiple carousels, you will want to change the id each time
    'image_size'                => 'golden-ratio-1024',                 // [ thumbnail | medium | large | full | custom ] - the image size you wish to output
    'images_as_links'           => true,                                // [ true | false ] - Set to true to wrap images with links (if _conveyor_link set on post)
    'order'                     => 'ASC',                               // [ ASC | DESC ]
    'orderby'                   => 'date',                              // [ date | menu_order ]
    'posts_per_page'            => 5,                                   // Set number of posts to return, -1 will return all
    'post_type'                 => 'conveyor_slides',                   // [ post | page | custom post type | array() ]
    'render_captions'           => true,                                // [ true | false ] - Set to true to render captions when excerpt is not empty
    'render_controls'           => true,                                // [ true | false ] - Show the slide left right controls
    'render_indicators'         => true                                 // [ true | false ] - Show the slide indicators
);
conveyor_render_bootstrap( $defaults );

The bootstrap carousel isnt working, what do I need to do?

The plugin will only render the HTML and JavaScript configuration for the carousel, you will need to add Bootstrap CSS and JS to your theme.

How can I use the meta information stored by the 'Link chooser' meta box?

The meta keys are:

  • '_conveyor_link'
  • '_conveyor_open_new_window'

How can I use the meta information stored by the 'Featured' meta box?

The meta key is:

  • '_conveyor_featured'

What custom image sizes are created by this plugin?

The image sizes are:

  • 'golden-ratio-2560' - 2560 x 1582
  • 'golden-ratio-2048' - 2048 x 1266
  • 'golden-ratio-1920' - 1920 x 1186
  • 'golden-ratio-1680' - 1680 x 633
  • 'golden-ratio-1440' - 1440 x 890
  • 'golden-ratio-1280' - 1280 x 791
  • 'golden-ratio-1024' - 1024 x 633
  • 'golden-ratio-800' - 800 x 494
  • 'golden-ratio-640' - 640 x 396

The custom image sizes dont seem to work, help!

The image sizes will only take effect on images you have uploaded after this plugin has been installed, however there are other plugins out there (such as WPThumb) that will fix this for you.

If it still isnt working, check that you have the 'GD' module installed in your PHP environment. If you havent, you can install it like so:

apt-get install php5-gd

Can I contribute?

Sure thing, the GitHub repository is right here: (https://github.com/mwtsn/conveyor)

Requires: 3.3 or higher
Compatible up to: 4.0.1
Last Updated: 2014-10-24
Active Installs: 20+

Ratings

5 out of 5 stars

Support

Got something to say? Need help?

Compatibility

+
=
Not enough data

0 people say it works.
0 people say it's broken.

100,1,1