Welcome to TubePress¶
TubePress makes it easy to add video galleries to your website. It’s highly configurable and designed for website builders and users of any skill level.
Check out a live demo of TubePress here.
TubePress is available both as a downloadable package and via several cloud-hosted, zero-installation services. The software is mostly open source, and it’s designed and maintained by TubePress LLC, a software company based in Pittsburgh, Pennsylvania.
User Guides¶
Most TubePress users will want to use one of the guides below. Each guide covers installation, general usage, and troubleshooting.
TubePress for WordPress¶
This page has moved to http://support.tubepress.com/customer/en/portal/articles/1993392-introduction
TubePress for PHP¶
TubePress Pro is available to use as a mature PHP library, which makes it accessible to any website that runs PHP.
Manual Contents¶
Getting Started¶
This section of the manual is targeted towards new users of TubePress for PHP.
Requirements¶
This page has moved to http://support.tubepress.com/customer/portal/articles/2029568-server-requirements
Download¶
This page has moved to http://support.tubepress.com/customer/portal/articles/2029667-download
Installation¶
This page has moved to http://support.tubepress.com/customer/portal/articles/2029670-installation
Initial Setup¶
This page has moved to http://support.tubepress.com/customer/portal/articles/2029702-initial-setup
Basic Usage in PHP¶
On This Page
Add TubePress to any PHP Page¶
This section has moved to http://support.tubepress.com/customer/portal/articles/2032994-add-tubepress-to-any-php-page
Changing the Default Language¶
This section has moved to http://support.tubepress.com/customer/portal/articles/2033016-multilingual-support
Video Galleries from Multiple Sources¶
With TubePress Pro, you can create galleries that are composed of video from multiple video sources. TubePress can even combine videos from multiple video providers - for instance, you can easily have YouTube and Vimeo videos intermingled in the same gallery!
As an example, say that you want to create a single gallery containing videos from the following sources, all combined into a single gallery:
- the YouTube playlist
F5D324185EE73FEC
- uploads from YouTube user
bbc
- uploads from YouTube user
funnyordie
- YouTube search for the exact term “san diego craft beer”
- the Vimeo album
140484
This is easy to accomplish with TubePress Pro. The trick is to use +
in some of your options to combine
the sources. For the example above, the set of options that you pass to TubePress might look like this:
<?php
print TubePressPro::getHTML('mode="playlist + user + tag + vimeoAlbum" playlistValue="F5D324185EE73FEC" userValue="bbc + funnyordie" tagValue=\'"san diego craft beer"\' vimeoAlbumValue="140484"');
The videos from all 5 sources will be collected and seamlessly assembled into a single TubePress gallery. You can combine any number of gallery sources with any number of parameters to each source.
Please keep in mind the following “gotchas”
- The
resultsPerPage
option will apply to each source, so expect each gallery page to contain up toresultsPerPage
x<number of sources>
videos per page. In the example above, assumingresultsPerPage
was set to 10, there would be 40 videos per page (10 videos per page x 4 sources).- As the user pages through the gallery, some of the sources will drop off quietly. For instance, if one video source has 1,000 videos and another has 10 videos, the second page of the gallery won’t contain any of the latter source’s videos.
Single Video Embeds¶
This section has moved to http://support.tubepress.com/customer/portal/articles/2037375-single-video-embeds
Interactive Searching¶
This section has moved to http://support.tubepress.com/customer/portal/articles/2037435-interactive-searching
Themes¶
This page has moved to http://support.tubepress.com/customer/portal/articles/2046757-introduction
Add-Ons¶
TubePress is built on a modular architecture, and is designed so that additional modules can be “plugged in” to add or change functionality. We refer to these modules as TubePress “add-ons.”
Wish that TubePress had new or modified functionality? The first place to check is the TubePress Marketplace, where you can purchase and download powerful add-ons written by TubePress LLC.
In This Section
YouTube Black Bars Remover¶
This page has moved to http://support.tubepress.com/customer/en/portal/articles/2164855-add-on-youtube-black-bars-remover
Vimeo All Access¶
On This Page
This TubePress add-on provides TubePress with enhanced access to your Vimeo Plus or PRO account, thus allowing TubePress to work with private Vimeo videos. This is particularly useful if you’d like to hide your videos from display on vimeo.com and only show them on your website.
To make a video private, choose the last radio icon in the privacy settings for the video as shown below:

- Purchase and download this add-on from the TubePress Marketplace.
- Unzip the file you downloaded (
vimeo-all-access_x_y_z.zip
) into theadd-ons
subdirectory of your TubePress Content Directory.
- Clear the TubePress system cache so TubePress discovers the add-on.
Ensure you have completed the one-time Vimeo API setup.
You will need to supply an additional set of Vimeo API credentials to TubePress: an “Access Token” with a corresponding “Access Token Secret”. This is a one-time step for this add-on.
Visit https://developer.vimeo.com/apps. You should see a list of any Vimeo apps that you have created. Click on the app that you are using for TubePress.
Click the “OAuth” tab.
At the bottom of the page, you will see a box containing your Access Token and Access Token Secret:
![]()
Flexible Thumbnail Rows¶
This page has moved to http://support.tubepress.com/customer/portal/articles/2169439-add-on-flexible-thumbnail-rows
QuickPlay¶
This page has moved to http://support.tubepress.com/customer/portal/articles/2164908-add-on-quickplay
Advanced Topics¶
The TubePress System Cache¶
This section has moved to http://support.tubepress.com/customer/portal/articles/2048959-the-system-cache
The settings.php
File¶
This section has moved to http://support.tubepress.com/customer/portal/articles/2048966-the-settings-php-file
The database.json
File¶
This section has moved to http://support.tubepress.com/customer/portal/articles/2050892-database-json
Reference¶
Options¶
On This Page
mode
¶Docs for this option have moved to http://support.tubepress.com/customer/en/portal/articles/2037524-gallery-source-options
output
¶Docs for this option have moved to http://support.tubepress.com/customer/en/portal/articles/2034687-advanced-options
video
¶Docs for this option have moved to http://support.tubepress.com/customer/en/portal/articles/2164823-single-video-embed-options
This section has moved to http://support.tubepress.com/customer/portal/articles/2034850-thumbnail-options
This section has moved to http://support.tubepress.com/customer/portal/articles/2034787-video-player-options
This section has moved to http://support.tubepress.com/customer/portal/articles/2036301-video-feed-options
This section has moved to http://support.tubepress.com/customer/portal/articles/2036377-meta-display-options
This section has moved to http://support.tubepress.com/customer/portal/articles/2038746-interactive-search-options
This section has moved to http://support.tubepress.com/customer/portal/articles/2034656-cache-options
This section has moved to http://support.tubepress.com/customer/portal/articles/2034687-advanced-options
Footnotes
[1] | YouTube documentation. Vimeo documentation for search, user uploads, user likes, user appears in, credited to, and groups. |
[2] | YouTube documentation. |
[3] | Vimeo documentation for search, user uploads, user likes, user appears in, credited to, and groups. |
[4] | Vimeo documentation. |
[5] | YouTube documentation. Vimeo documentation. |
This page has moved to http://support.tubepress.com/customer/portal/topics/814298-reference/articles
On This Page
Gallery Sources
vimeoAlbum
¶Gallery source | vimeoAlbum |
Description | Videos from a Vimeo album. The album is identified by the value supplied to the vimeoAlbumValue option. |
Shortcode example | [tubepress mode="vimeoAlbum" vimeoAlbumValue="852694"] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('mode="vimeoAlbum" vimeoAlbumValue="852694"'); |
Vimeo documentation | Click here |
vimeoAppearsIn
¶Gallery source | vimeoAppearsIn |
Description | Vimeo videos in which a given user appears. The Vimeo user is identified you supply to the vimeoAppearsInValue attribute. |
Notes | Limited to 50 videos. |
Shortcode example | [tubepress mode="vimeoAppearsIn" vimeoAppearsInValue="dabrainkilla"] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('mode="vimeoAppearsIn" vimeoAppearsInValue="dabrainkilla"'); |
Vimeo documentation | Click here |
vimeoChannel
¶Gallery source | vimeoChannel |
Description | Videos from a Vimeo channel. The channel is identified by the value supplied to the vimeoChannelValue option. |
Shortcode example | [tubepress mode="vimeoChannel" vimeoChannelValue="besthd"] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('mode="vimeoChannel" vimeoChannelValue="besthd"'); |
Vimeo documentation | Click here |
vimeoCreditedTo
¶Gallery source | vimeoCreditedTo |
Description | Vimeo videos for which a particular user has either uploaded or appeared in. The Vimeo user is identified by the value supplied to the vimeoCreditedToValue option. |
Shortcode example | [tubepress mode="vimeoCreditedTo" vimeoCreditedToValue="thunderingherd"] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('mode="vimeoCreditedTo" vimeoCreditedToValue="thunderingherd"'); |
Vimeo documentation | Click here |
vimeoGroup
¶Gallery source | vimeoGroup |
Description | Videos from a Vimeo group. The group is identified by the value supplied to the vimeoGroupValue option. |
Shortcode example | [tubepress mode="vimeoGroup" vimeoGroupValue="underachievers"] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('mode="vimeoGroup" vimeoGroupValue="underachievers"'); |
Vimeo documentation | Click here |
vimeoLikes
¶Gallery source | vimeoLikes |
Description | Vimeo videos that a particular user has “liked.” The Vimeo user is identified by the value supplied to the vimeoLikesValue option. |
Shortcode example | [tubepress mode="vimeoLikes" vimeoLikesValue="besthd"] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('mode="vimeoLikes" vimeoLikesValue="besthd"'); |
Vimeo documentation | Click here |
vimeoSearch
¶Gallery source | vimeoSearch |
Description | Vimeo videos that match a supplied search term. The search term is identified by the value supplied to the vimeoSearchValue option . |
Shortcode example | [tubepress mode="vimeoSearch" vimeoSearchValue="rainbow alligator"] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('mode="vimeoSearch" vimeoSearchValue="rainbow alligator"'); |
Vimeo documentation | Click here |
vimeoUploadedBy
¶Gallery source | vimeoUploadedBy |
Description | Vimeo videos uploaded by a particular user. The Vimeo user is identified by the value supplied to the vimeoUploadedByValue option. |
Shortcode example | [tubepress mode="vimeoUploadedBy" vimeoUploadedByValue="ehough"] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('mode="vimeoUploadedBy" vimeoUploadedByValue="ehough"'); |
Vimeo documentation | Click here |
Embedded Video Player
playerColor
¶Option name | playerColor |
Description | The highlight color of the Vimeo video player. |
Provided with | All TubePress distributions |
Default value | 000000 |
Valid values | Any six hexadecimal characters representing an HTML color. |
Shortcode example | [tubepress playerColor="A32638"] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('playerColor="A32638"'); |
YouTube documentation | Click here |
Video Feed Options
vimeoKey
¶Option name | vimeoKey |
Description | The API key that TubePress will use when communicating with Vimeo. |
Provided with | All TubePress distributions |
Default value | empty |
Valid values | Any valid Vimeo API key |
Shortcode example | [tubepress vimeoKey="..."] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('vimeoKey="..."'); |
Vimeo documentation | Click here |
vimeoSecret
¶Option name | vimeoSecret |
Description | The API secret that TubePress will use when communicating with Vimeo. |
Provided with | All TubePress distributions |
Default value | empty |
Valid values | Any valid Vimeo API secret |
Shortcode example | [tubepress vimeoSecret="..."] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('vimeoSecret="..."'); |
Vimeo documentation | Click here |
likes
¶Option name | likes |
Description | Toggle display of the number of times the video has been “liked”. |
Provided with | All TubePress distributions |
Default value | false |
Valid values | true or false |
Shortcode example | [tubepress likes="true"] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('likes="true"'); |
This page documents the options available with the ../../../manual/add-ons/vimeo-all-access/index
add-on
for TubePress.
vimeoApiAccessToken
¶Option name | vimeoApiAccessToken |
Description | The API secret that TubePress will use when communicating with Vimeo. |
Provided with |
|
Default value | empty |
Valid values | Any valid Vimeo API access token |
Shortcode example | [tubepress vimeoApiAccessToken="..."] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('vimeoApiAccessToken="..."'); |
Vimeo documentation | Click here |
vimeoApiAccessTokenSecret
¶Option name | vimeoApiAccessTokenSecret |
Description | The API secret that TubePress will use when communicating with Vimeo. |
Provided with |
|
Default value | empty |
Valid values | Any valid Vimeo API access token secret |
Shortcode example | [tubepress vimeoApiAccessTokenSecret="..."] |
Standalone PHP example | TubePressPro::getHtmlForShortcode('vimeoApiAccessTokenSecret="..."'); |
Vimeo documentation | Click here |
This page has moved to http://support.tubepress.com/customer/portal/articles/2034850-thumbnail-options
This page has moved to http://support.tubepress.com/customer/portal/articles/2034850-thumbnail-options
This page has moved to http://support.tubepress.com/customer/portal/articles/2034850-thumbnail-options
Index¶
TubePress for Wix¶
This page has moved to http://support.tubepress.com/customer/portal/topics/795081-wix/articles
Around the Web¶
A few other places around the Internet where you’ll find us.
- tubepress.com - our public website
- Support Forums - where our staff provides customer support
- GitHub - source code and bug tracking
- Changelog - new features, bug fixes, and changes