Documentation – WP YouTube video import

Version: 1.3
License: CodeCanyon regular license
Price: $29
Compatible with: IE9, IE10, Firefox, Safari, Opera, Chrome

Contents

Forum support

Support for this plugin is free of charge and is limited to questions regarding the plugin’s features or problems. We do not provide support for code customizations or third-party themes or plugins. If you need help with anything other than minor customizations you should consider asking for help from a developer.

You can make suggestions for improvement but the decision to implement them remains solely at our discretion.

General information

A. WordPress information

To install and use this plugin you must have a working version of WordPress 3.5+ already installed.

B. First time installation

Important note: do not try to install the archive downloaded from CodeCanyon. Please read on.

After purchasing your copy of the plugin, first thing needed is to extract the archive you downloaded from CodeCanyon. Inside it you will find a folder called Licensing and 2 more files: readme.txt and a zip archive called ccb-youtube.zip. All plugin files that need to be installed on your WordPress installation are stored inside the archive.

Extract the archive called ccb-youtube.zip. It contains all the plugin files; install this by uploading it into WordPress or by FTP transfer.

B1. Upload plugin into WordPress

Having the plugin archive extracted from the archive downloaded from CodeCanyon, in your WordPress administration navigate to Plugins -> Add New page.

Plugins - Add New

From the top menu, choose Upload:

Upload plugin

Hit browse, search the location where you extracted ccb-youtube.zip and hit Install Now.

B2. Upload plugin using FTP

To upload using FTP, first you need to extract the plugin files that can be found inside archive ccb-youtube.zip. All files are contained inside a folder called ccb-youtube and this is the folder that needs to be uploaded into your WordPress plugins folder.

Using an FTP client (like FileZilla for example), connect to your FTP account. Find your WordPress plugins folder (usually is wp-content/plugins) and upload the content of archive ccb-youtube.zip inside it. Once uploading has finished, in your WordPress administration navigate to Plugins page and activate plugin YouTube Video to Post. A new entry on your menu will appear called Videos that signals your installation was successful.

C. Plugin updates

Updates for the plugin are released from time to time. To update your copy, you can keep an eye on the Changelog or enter your purchase information in plugin Settings page and get update notifications from WordPress just like you do with regular plugins.

To manually update the plugin, follow the instructions above under FTP installation.

C1. Automatic update

To benefit from automatic updates, first thing you need to do is enter your purchase code. In your CodeCanyon account, go to Downloads section and click Download button in plugin list. Select License certificate for downloading; your purchase code can be found inside the file as Item Purchase Code.

Envato license certificate

After retrieving the purchase code, in your WordPress administration go to Videos -> Settings and enter the code in field Purchase code (at the bottom of the page). Now, whenever a new release is being published, in your WordPress plugins page you will be notified that a new version has been released and will be asked to update if you consider necessary.

Plugin settings

Before starting to import videos you should set up the general settings for the plugin that can be found in plugin page Settings. These settings are:

A. Visibility settings

Visibility Settings

By default, the plugin will import YouTube videos from feeds into a custom post type created by the plugin. This means that videos won’t be imported as regular posts or other post types (with some exceptions based on what WordPress theme you’re using) but as post type video. Depending on how you want to use the plugin, the custom post type can be set not to display in your website’s front-end but only be used as playlists that can be published anywhere in your WordPress website using shortcodes.

The second visibility setting (Allow videos in archive pages) is used only if video posts are visible in front-end. If left unchecked, video embeds will only be visible on single post display pages. As oposed, if checked, videos will be visible everywhere (ie: archive pages displaying lists of posts).

B. Bulk import settings

Bulk import settings

Bulk video imports from YouTube feeds can be made in 2 ways: manually or automatically. Excepting the Automatic import frequency setting, all the other options under Bulk import apply to both ways of importing videos.

Import categories, if checked, will automatically create the categories retrieved from YouTube and assign each post created by importing videos from YouTube to them; categories won’t be duplicated on import; if a category already exists, all videos that belong into that respective category will be imported into it.

Import titles, if checked, will set as post title the title retrieved from the YouTube feed loaded. Ideally, this should be left checked.

Import descriptions allows you to import descriptions from YouTube for each video into either the post content, post excerpt, both or none, depending on how you plan to use the plugin.

Import status will create posts as either draft or published. If the feed being imported is your own and you trust the descriptions/titles as being accurate and correct, it’s safe to import videos as published. When retrieving from other channels, best idea would be to import videos as drafts and review them when importing is done.

Automatic import allows you to tweak the frequency and quantity of videos imported using the automated playlist import feature that this plugin has. Please note that no more than 50 videos can be imported at once, this being a YouTube limitation. Also, when doing imports, choose the frequency and quantity of videos imported each time so that it suits your server since for each import a query to YouTube API is made and the number of imported videos is created as posts.

C. Player settings

Player settings

To display videos into your WordPress front-end the plugin uses the default YouTube player and its API. As a note, where possible, the Flash player is used; on devices that don’t support Flash, the plugin will automatically load the HTML5 player.

YouTube allows some customizations on its player and they can be globally set here. All newly created video posts (manual import or automatic) will have these settings; for the custom post type video that this plugin creates, all player settings can be individually changed for each imported video allowing further customizations if needed.

Player size allows setting of size by using the chosen aspect ratio and width; height is calculated automatically by the plugin.

Video position in post (or Display video in custom post) will display the video (only for the custom post type) above or below the post content, depending on the preference.

Volume is pretty self explanatory and the setting can go between 0 (mute) and 100.

Autoplay, when checked, will start playing the video after page has loaded. This means that when a visitor sees a page of the custom post created by the plugin, the video can be displayed as paused or start playing automatically.

Show player controls allows you to either only display the video with no control bar (unchecked) or allow your visitor to use the controls.

Allow fullscreen will display the fullscreen button into the player if checked.

Autohide controls can be set in one of the 3 following ways: always show controls even if the video is playing, hide controls when player has loaded or when video is playing or hide controls only when video is playing. If any of the 2 options that allows controls hiding is chosen, the controls will appear when user will hover over the player.

Player theme allows choosing between 2 YouTube player themes: dark or light.

Player color can be set to either red or white.

No YouTube logo on controls bar works only if color isn’t set on white. When this option is checked, a small YouTube logo will appear on paused videos.

Annotations displayed over videos can be set to either display or not; if they don’t contain a solid message, we suggest you choose not to display them.

Show related videos, when checked, will display a list of related videos after the currently playing video ends.

Show video title by default allows you to either show or remove the video title from the player.

Disable keyboard player controls, when unchecked, will not allow using the keyboard to control the player.

Importing YouTube videos

A. Import a single video

To import a single video, from plugin menu click Add new.

Import single video

All you need to do is enter a valid YouTube video ID and hit Search video. If video is found, you will be taken to custom post edit page and, depending on your global settings for importing titles and descriptions, will have post title and post content already filled with the title and description retrieved from YouTube.
Categories, if option for importing categories from YouTube is checked, will also be assigned to the new post automatically.

B. Manual bulk import

To manually bulk import videos, from plugin menu go to Import videos and fill your import preferences.

Manual bulk import feed

Feed type allows you to choose between 3 types of feeds:

  1. Search query: performs a search on YouTube based on your search query and shows all the results returned,
  2. Playlist: loads a YouTube playlist based on the playlist ID provided by you,
  3. User: loads all uploads made by a certain user based on the username.

Number of results to retrieve; this setting allows you to retrieve the first X given number of results from a feed.

Video duration applies only for search queries and retrieves only videos that have more than the given length.

Search query is the search you want to retrieve videos by. Depending on the type of feed chosen, this setting must be playlist ID or user ID for playlists or user feeds.

Order by is the order that the retrieved videos must be displayed (ie. date of publishing, views, search relevance, rating etc.).

Once all search preferences are filled in, hit Load Feed button. A paginated, regular WordPress table will be displayed containing all the results returned by your query.

Manual bulk import feed results

To import the videos into WordPress as posts, all you need to do is check the checkbox next to the videos you want to import, choose Import from Bulk actions, optionally select the category where you want the videos to be saved and hit Apply. The videos will be created as custom post type video and depending on your settings for title and descriptions import, will automatically have the title and description from YouTube set on them as well as the post status set in Settings page.

C. Automatic import

Automatic import allows you to retrieve videos from YouTube users or playlists and will publish them according to your settings. The plugin can manage multiple entries; if you use automatic import with multiple playlists, each time the plugin must query YouTube for changes it will do so for only one playlist at a time. Simply put, if you choose to import every 15 minutes and have 3 active playlists, after 15 minutes the first playlist will be queried, after 30 minutes the second one, after 45 minutes the third, after 1 hour again the first playlist and so on.

To start importing videos from YouTube automatically from plugin menu choose Automatic import and click Add New next to the title.

Automatic playlist

Playlist name is the name of the playlist used for your internal reference (the title).

Feed type option allows you to choose the type of playlist you want to import (user or playlist).

Playlist ID must be set to the correct YouTube username (in case you’re importing a user playlist) or the playlist ID.

Add to import queue can be activated or deactivated at any time. By checking this option you will add the playlist to the queue and on next import, if its turn came, it will import the number of videos set in settings.

Import in category allows you to specify the category you want the videos to be imported in. This is optionally, if no category is chosen, on import, the plugin will check the setting for importing YouTube’s categories and will act according to your setting.

All playlists you created will be displayed under Automatic import.

Automatic playlist list table

Once a playlist was queried, a few statistics will display next to it, including the last time the playlist was queried, how many videos were imported and the total number of videos from that playlist.

Shortcodes

There are 2 types of shortcodes available in this plugin: single video embed shortcode and playlist embed shortcode. The shortcodes can be inserted into posts using a friendly interface that can be triggered from either the visual editor menu or from a side panel on post/page editing.

Shortcode buttons

After clicking either buttons, a modal window containing all videos imported as video post type will be displayed.

Shortcode modal

A. Single video shortcode

To insert the shortcode for a single video, having the modal window opened, hover over the entry that you want to insert into your post. You will notice a link below the title Get video shortcode. Click it and you will be taken to a customization form where you can set a few settings for the player displaying the video.

Single video shortcode settings

Set your preferences and hit Insert shortcode. The complete shortcode for a single video looks like this:

[cbc_video id="4723" volume="10" width="320" aspect_ratio="16x9" autoplay="0" controls="1"]

A1. Single video shortcode parameters

id is the video custom post ID of the imported video.
volume is the playback volume for the video (value between 0 and 100).
width is the player width.
aspect_ratio is used for calculating the video height. Can have value of 16×9 or 4×3.
autoplay when set to 1 will start the video automatically when page has finished loading.
controls when set to 1 will display the player controls.

B. Playlist shortcode

To insert a playlist shortcode, from the same modal window check the videos you want to insert into the playlist. Once checked, the videos will appear into a list on the left. Once the selection is done, hit Add shortcode to post above the shortcode videos list.

Playlist shortcode

The complete playlist shortcode looks like this:

[cbc_playlist videos="4723,4724,4725,4726,4727,4728"]

B1. Playlist shortcode parameters

videos contains the list of videos to be used into the playlist. Must be made of video post ID’s separated by comma (,).

Widgets

A. Recent videos

To insert this widget into a sidebar, in your Widgets page look for Recent videos under Available Widgets. Drag it into a sidebar area and fill in the details.

Playlist widget

Available options are:

Title : the widget title.
Number of videos to show : how many videos will be displayed into the list.
Display thumbnails : if regular list is displayed (option Show as video playlist is unchecked) you can choose to display the thumbnail retrieved from YouTube next to the post title.
Show as video playlist : display the list as a video playlist; in case this option is chosen, a few more options will be made available (aspect ratio, width and volume).

Custom menus

If you’re using custom menus and would like to display video categories into your menus, navigate to Appearance -> Menus. On the right side you should see 2 more panels: Videos and Video categories. If you don’t see those panels, open Screen Options tab from the top of the page and make sure Videos and Video categories are checked.

Menu panels

Check the video categories from Video categories panel that you want into your menu and hit Add to Menu.

Compatibility with WordPress themes

The plugin works with any WordPress theme and will create video post types from YouTube feeds on any WordPress installation regardless of the theme used.

For extended compatibility with themes that can also handle videos, at the moment there is support for only 2 themes: deTube and Avada.

When any of these 2 themes is installed and activated, whenever you are trying to import a video (single import, manual bulk or automatic) the plugin will display an extra option asking if you would like to import videos as theme special posts (both deTube and Avada work with regular posts). If you choose to import as theme posts, the plugin will create actual posts compatible with the theme and will set all video related meta fields with the appropriate information (video URL, embed code, etc).